ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

Primitive Surface のプロパティ

基本的な表面の外観と動作の制御

基本的な表面のプロパティは、基本的な surface オブジェクトの外観と動作を制御するプロパティです。プロパティの値を変更することによって、基本的な表面の対応する特性を変更できます。ドット表記を使用して、特定のオブジェクトとプロパティを参照します。

h = surface;
c = h.CData;
h.CDataMapping = 'direct';

すべて折りたたむ

FaceColor面の色'flat' (既定値) | 'interp' | 'none' | 'texturemap' | RGB の 3 要素または色文字列

面の色。次の値のいずれかとして指定します。

  • 'flat' — 一様な面の色を使用します。CData の値を使用します。最初の頂点のカラー データで面全体の色が決まります。この値は FaceAlpha プロパティが 'interp' に設定されている場合は使用できません。

  • 'interp' — 面の色を内挿します。各頂点の CData の値の双一次内挿で色が決まります。この値は FaceAlpha プロパティが 'flat' に設定されている場合は使用できません。

  • 'none' — 面を描画しません。

  • 'texturemap'CData のカラー データを表面に適合するように変換します。

  • RGB の 3 要素または色文字列 — すべての面に同じ色を使用します。

RGB の 3 要素は、色の赤、緑、青成分の強度を指定する 3 要素の行ベクトルです。強度値は [0,1] の範囲でなければなりません。たとえば [0.4 0.6 0.7] のようになります。次の表に、等価な色文字列をもつ RGB の 3 要素の値を示します。

完全名省略名RGB の 3 要素
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black'k'[0 0 0]

FaceAlpha面の透明度1 (既定値) | 範囲 [0,1] のスカラー | 'flat' | 'interp'

面の透明度。次の値のいずれかとして指定します。

  • [0,1] の範囲のスカラー — すべての面に同じ透明度の値を使用します。値 1 は完全に不透明で、値 0 は完全に透明です。

  • 'flat' — 面ごとに一様な透明度を使用します。透明度の値は AlphaData の値を使用して指定します。最初の頂点のアルファ データで面全体の透明度が決まります。AlphaData プロパティを ZData と同じサイズの行列として先に指定しておかなければなりません。この値は FaceColor プロパティが 'interp' に設定されている場合は使用できません。

  • 'interp' — 面ごとに透明度を内挿します。各頂点の AlphaData の値の双一次内挿で透明度の値が決まります。AlphaData プロパティを ZData と同じサイズの行列として先に指定しておかなければなりません。この値は FaceColor プロパティが 'flat' に設定されている場合は使用できません。

FaceLighting面に対する light オブジェクトの効果'flat' (既定値) | 'gouraud' | 'none'

面に対する light オブジェクトの効果。次の値のいずれかとして指定します。

  • 'flat' — 面にライトを一様に適用します。この値は小平面で構成されたオブジェクトを表示する場合に使用します。

  • 'gouraud' — 面のライトを変化させます。各頂点のライトを計算し、面上でライトを線形内挿します。この値は曲面を表示する場合に使用します。

  • 'none' — light オブジェクトのライトを面に適用しません。

    メモ:   値 'phong' は削除されました。代わりに 'gouraud' を使用してください。

BackFaceLighting法線がカメラと反対方向の場合の面のライティング方法'reverslit' (既定値) | 'unlit' | 'lit'

頂点の法線がカメラと反対方向の場合の面のライティング方法。次の値の 1 つとして指定します。

  • 'reverslit' — 頂点法線がカメラに向かっているかのように面をライティングします。

  • 'unlit' — 面をライティングしません。

  • 'lit' — 頂点法線に従って面をライティングします。

このプロパティを使用すると、オブジェクトの内部と外部を見分けられます。例については、「背面ライティング」を参照してください。

エッジ

すべて折りたたむ

EdgeColorエッジのラインの色[0 0 0] (既定値) | 'none' | 'flat' | 'interp' | RGB の 3 要素または色文字列

表面エッジのラインの色。次の値のいずれかとして指定します。

  • 'none' — エッジを描画しません。

  • 'flat' — 一様な色のエッジを描画します。各エッジの色は面の最初の頂点の CData の値を使用して指定します。この値は EdgeAlpha プロパティが 'interp' に設定されている場合は使用できません。

  • 'interp' — エッジの色を内挿します。エッジの色は面の頂点の CData の値の線形内挿を使用して指定します。この値は EdgeAlpha プロパティが 'flat' に設定されている場合は使用できません。

  • RGB の 3 要素または色文字列 — すべてのエッジに同じ色を使用します。

RGB の 3 要素は、色の赤、緑、青成分の強度を指定する 3 要素の行ベクトルです。強度値は [0,1] の範囲でなければなりません。たとえば [0.4 0.6 0.7] のようになります。次の表に、等価な色文字列をもつ RGB の 3 要素の値を示します。

完全名省略名RGB の 3 要素
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black'k'[0 0 0]

EdgeAlpha表面エッジの透明度1 (既定値) | [0,1] の範囲のスカラー値 | 'flat' | 'interp'

表面エッジの透明度。次の値のいずれかとして指定します。

  • [0,1] の範囲のスカラー — すべてのエッジに同じ透明度の値を使用します。値 1 は完全に不透明で、値 0 は完全に透明です。

  • 'flat' — エッジごとに一様な透明度を使用します。各エッジの透明度は AlphaData の値を使用して指定します。面の最初の頂点の値でエッジの透明度が決まります。AlphaDataZData と同じサイズの行列として指定しておかなければなりません。この値は EdgeColor プロパティが 'interp' に設定されている場合は使用できません。

  • 'interp' — エッジごとに透明度を内挿します。各頂点の AlphaData の値の双一次内挿を使用します。AlphaDataZData と同じサイズの行列として指定しておかなければなりません。この値は EdgeColor プロパティが 'flat' に設定されている場合は使用できません。

EdgeLightingエッジに対する light オブジェクトの効果'none' (既定値) | 'flat' | 'gouraud'

エッジに対する light オブジェクトの効果。次の値のいずれかとして指定します。

  • 'flat' — 各エッジにライトを一様に適用します。

  • 'none' — light オブジェクトのライトをエッジに適用しません。

  • 'gouraud' — 各頂点のライトを計算し、エッジ上でライトを線形内挿します。

    メモ:   値 'phong' は削除されました。代わりに 'gouraud' を使用してください。

LineStyleライン スタイル'-' (既定値) | '--' | ':' | '-.' | 'none'

ライン スタイル。次の表のライン スタイル文字列の 1 つとして指定します。

文字列ライン スタイル結果として得られる線
'-'実線

'--'破線

':'点線

'-.'一点鎖線

'none'ラインなしラインなし

LineWidthライン幅0.5 (既定値) | 正の値

ライン幅。ポイント単位の正の値として指定します。ラインがマーカーをもつ場合、ライン幅はマーカー エッジにも影響します。

例: 0.75

AlignVertexCenters垂直および水平のラインのシャープ化'off' (既定値) | 'on'

垂直および水平のラインのシャープ化。'off' または 'on' で指定します。

関連付けられている Figure の GraphicsSmoothing プロパティが 'on' に設定されていて Renderer プロパティが 'opengl' に設定されている場合、Figure のプロットには平滑化技法が適用されます。場合によってはこの平滑化技法が原因で、垂直および水平のラインが均一でない太さや色で表示されることがあります。この不均一な外観を取り除くために AlignVertexCenters プロパティを使用します。

  • 'off' — 垂直または水平のラインをシャープ化しません。均一でない太さや色でラインが表示される場合があります。

  • 'on' — 垂直および水平のラインをシャープ化して不均一な外観を取り除きます。

    メモ:   この機能をサポートするグラフィックス カードがなければなりません。この機能がサポートされているかどうかを確認するには、「opengl info」と入力します。サポートされている場合は、返されたフィールドに SupportsAlignVertexCenters: 1 の行が含まれています。

MeshStyle表示するエッジ'both' (既定値) | 'row' | 'column'

表示するエッジ。'both''row''column' のいずれかとして指定します。

マーカー

すべて折りたたむ

Markerマーカー記号'none' (既定値) | マーカー文字列

マーカー記号。次の表のマーカー文字列の 1 つとして指定します。既定では primitive surface オブジェクトはマーカーを表示しません。マーカー記号を指定すると、各データ ポイントまたは頂点にマーカーが追加されます。

文字列マーカー記号
'o'
'+'プラス記号
'*'アスタリスク
'.'
'x'十字
'square' または 's'正方形
'diamond' または 'd'菱形
'^'上向き三角形
'v'下向き三角形
'>'右向き三角形
'<'左向き三角形
'pentagram' または 'p'星形五角形
'hexagram' または 'h'星形六角形
'none'マーカーなし

例: '+'

例: 'diamond'

MarkerSizeマーカー サイズ6 (既定値) | 正の値

マーカー サイズ。ポイント単位の正の値として指定します。

例: 10

MarkerEdgeColorマーカーの輪郭の色 'auto' (既定値) | 'none' | 'flat' | RGB の 3 要素または色文字列

マーカーの輪郭の色。次の値の 1 つとして指定します。

  • 'auto'EdgeColor プロパティと同じ色を使用します。

  • 'none' — 色を使いません。塗りつぶされていないマーカーは透明になります。

  • 'flat' — 頂点の CData の値を使用して色を設定します。

  • RGB の 3 要素または色文字列 — 指定した色を使用します。

RGB の 3 要素は、色の赤、緑、青成分の強度を指定する 3 要素の行ベクトルです。強度値は [0,1] の範囲でなければなりません。たとえば [0.4 0.6 0.7] のようになります。次の表に、等価な色文字列をもつ RGB の 3 要素の値を示します。

完全名省略名RGB の 3 要素
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black'k'[0 0 0]

例: [0.5 0.5 0.5]

例: 'blue'

MarkerFaceColorマーカーの塗りつぶし色'none' (既定値) | 'auto' | 'flat' | RGB の 3 要素または色文字列

マーカーの塗りつぶし色。次の値の 1 つとして指定します。

  • 'none' — 色を使用せず、背景が透けて見えるようにします。

  • 'auto' — 座標軸の Color プロパティと同じ色を使用します。

  • 'flat' — 頂点の CData の値を使用して色を設定します。

  • RGB の 3 要素または色文字列 — 指定した色を使用します。

RGB の 3 要素は、色の赤、緑、青成分の強度を指定する 3 要素の行ベクトルです。強度値は [0,1] の範囲でなければなりません。たとえば [0.4 0.6 0.7] のようになります。次の表に、等価な色文字列をもつ RGB の 3 要素の値を示します。

完全名省略名RGB の 3 要素
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black'k'[0 0 0]

このプロパティは円、正方形、菱形、星形五角形、星形六角形、4 種類の三角形のマーカー タイプにのみ影響します。

例: [0.3 0.2 0.1]

例: 'green'

例:

面と頂点の法線

すべて折りたたむ

FaceNormals表面の各面の法線ベクトル[] (既定値) | (m-1) x (n-1) x 3 の配列

表面の各面の法線ベクトル。(m-1) x (n-1) x 3 の配列として指定します。ここで [m,n] = size(ZData) です。法線ベクトルは面ごとに 1 つずつ指定します。

このプロパティの値を設定すると、対応するモード プロパティが manual に設定されます。法線ベクトルを指定しない場合、ライティングの計算用にこの値が自動的に生成されます。

データ型: single | double

FaceNormalsModeFaceNormals の選択モード 'auto' (既定値) | 'manual'

FaceNormals の選択モード。次の値の 1 つとして指定します。

  • 'auto' — 座標データに基づいて法線ベクトルを計算します。

  • 'manual' — 手動で指定した値を使用します。値を指定するには、FaceNormals プロパティを設定します。

VertexNormals表面の各頂点の法線ベクトル[] (既定値) | m x n x 3 の配列

表面の各頂点の法線ベクトル。m x n x 3 の配列として指定します。ここで [m,n] = size(ZData) です。法線ベクトルは頂点ごとに 1 つずつ指定します。

このプロパティの値を設定すると、対応するモード プロパティが manual に設定されます。法線ベクトルを指定しない場合、ライティングの計算用にこの値が自動的に生成されます。

データ型: single | double

VertexNormalsModeVertexNormals の選択モード'auto' (既定値) | 'manual'

VertexNormals の選択モード。次の値の 1 つとして指定します。

  • 'auto' — 座標データに基づいて法線ベクトルを計算します。

  • 'manual' — 手動で指定した値を使用します。値を指定するには、VertexNormals プロパティを設定します。

色と透明度のマッピング

すべて折りたたむ

AlphaData透明度のデータ1 (既定値) | スカラー | m 行 n 列の配列

それぞれの面または頂点の透明度のデータ。次のいずれかの形式で指定します。

  • スカラー — 同じ透明度の値を使用します。

  • m 行 n 列の行列 — それぞれの面または頂点に異なる透明度の値を使用します。m 行 n 列の数値配列を指定します。ここで [m,n] = size(ZData) です。

透明度データの値の alphamap へのマッピング方法は AlphaDataMapping プロパティで決まります。Figure の Alphamap プロパティには alphamap が含まれています。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

AlphaDataMapping透明度をもつデータ マッピング方法'scaled' (既定値) | 'direct' | 'none'

透明度データのマッピング方法。'scaled''none' または 'direct' で指定します。このプロパティを使用して AlphaData に格納された透明度の値を Figure の alphamap にマッピングする方法を制御します。

それぞれの方法には次の効果があります。

  • 'scaled' — 値をアルファ値の範囲内で変換し、データ値をアルファ値に線形にマッピングします。アルファ値の制限は座標軸の ALim プロパティに格納されています。

  • 'none' — 値を 01 の範囲に固定します。1 以上の値は完全に不透明に、0 以下の値は完全に透明になります。

  • 'direct' — Figure の alphamap への直接のインデックスとして値を解釈します。スケーリングされていないと、値は通常 1 ~ length(alphamap) の範囲の整数値です。MATLAB® は 1 未満の値を alphamap の最初の値に、length(alphamap) より大きい値を alphamap の最後の値にマッピングします。小数部分の値は、最近傍値の小さい方の整数に丸められます。AlphaDatauint8 整数の配列の場合、インデックスの開始点は 0 になります (つまり、MATLAB は 0 の値を alphamap の最初のアルファ値にマップします)。

CData頂点の色2 次元配列または 3 次元配列

頂点の色。次のいずれかの形式で指定します。

  • 2 次元配列 — カラーマップの色を使用します。CDataZData と同じサイズの配列に設定して各頂点の色を指定します。これらの値と現在のカラーマップとの対応は CDataMapping プロパティで決まります。FaceColor プロパティが 'texturemap' に設定されている場合は、CDataZData と同じサイズにする必要はありません。ただし、型は double または uint8 でなければなりません。CData の値は ZData で定義された表面に適合するようにマッピングされます。

  • 3 次元配列 — トゥルーカラーを使用します。CData を m x n x 3 の配列に設定して各頂点の色を RGB の 3 要素で指定します。ここで [m,n] = size(ZData) です。RGB の 3 要素は、色の赤、緑、青成分の強度を指定する 3 要素のベクトルです。配列の最初のページは赤、2 番目のページは緑、3 番目のページは青の成分になります。表面にはカラーマップの色ではなくトゥルーカラーが使用されるので、CDataMapping プロパティは無効になります。

    • CDatadouble 型または single 型の場合、RGB の 3 要素の値 [0 0 0] は黒に対応し、[1 1 1] は白に対応します。

    • CData が整数型の場合、すべてのデータの範囲を使用して表面の色が決定されます。たとえば CDatauint8 型の場合、[0 0 0] は黒に対応し、[255 255 255] は白に対応します。CDataint8 型の場合、[-255 -255 -255] は黒に対応し、[255 255 255] は白に対応します。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

CDataMapping直接カラー マッピングまたはスケーリングしたカラー マッピング'scaled' (既定値) | 'direct'

直接カラー マッピングまたはスケーリングしたカラー マッピング。次の値のいずれかとして指定します。

  • scaled — 軸の CLim プロパティで指定したカラーマップの部分全体にカラー データを変換し、データ値を色に線形にマッピングします。このマッピングの詳細は、caxis を参照してください。

  • direct — カラー データを直接カラーマップのインデックスとして使用します。カラー データは、1 ~ length(colormap) の範囲の整数値でなければなりません。MATLAB は、1 より小さい値をカラーマップ内の最初の色に、length(colormap) より大きな値をカラーマップの最後の色にマップします。小数部分の値は、最近傍値の小さい方の整数に丸められます。

CDataModeCData の選択モード'auto' (既定値) | 'manual'

CData の選択モード。次の値のいずれかとして指定します。

  • 'auto'ZData の値を使用して色を設定します。

  • 'manual' — 手動で指定した値を使用します。値を指定するには、CData プロパティを設定します。

ライティング

すべて折りたたむ

AmbientStrength周囲光の強度0.3 (既定値) | 範囲 [0,1] のスカラー

周囲光の強度。[0,1] の範囲のスカラー値として指定します。周囲光は場面全体を照らす方向性のない光です。周囲光が視覚可能であるためには、座標軸に対して少なくとも 1 つの視覚可能な light オブジェクトがなければなりません。

周囲光の色は座標軸の AmbientLightColor プロパティで設定します。座標軸のすべてのオブジェクトに同じ色が使用されます。

例: 0.5

データ型: double

DiffuseStrength拡散光の強度0.6 (既定値) | 範囲 [0,1] のスカラー

拡散光の強度。[0,1] の範囲のスカラー値として指定します。拡散光は座標軸の light オブジェクトからの非鏡面反射です。

例: 0.3

データ型: double

SpecularColorReflectance鏡面反射の色1 (既定値) | 範囲 [0,1] のスカラー

鏡面反射の色。[0,1] の範囲のスカラー値として指定します。値が 1 の場合、光源の色だけを使用して色が設定されます。値が 0 の場合、反射するオブジェクトの色と光源の色の両方を使用して色が設定されます。光源の色はライトの Color プロパティに格納されています。中間の値では、その割合は線形に変化します。

例: 0.5

データ型: double

SpecularExponent鏡面スポットのサイズ10 (既定値) | 1 以上のスカラー

鏡面スポットのサイズ。1 以上のスカラー値として指定します。ほとんどが、[5 20] の範囲の指数です。

例: 7

データ型: double

SpecularStrength鏡面反射の強度0.9 (既定値) | 範囲 [0,1] のスカラー

鏡面反射の強度。[0,1] の範囲のスカラー値として指定します。鏡面反射は座標軸の light オブジェクトが照らす表面上の部分です。

例: 0.3

データ型: double

データ

すべて折りたたむ

XDatax 座標のデータ[3 行 3 列の倍精度値] (既定値) | ベクトルまたは行列

x 座標のデータ。ZData と同じサイズの行列または length(n) のベクトルとして指定します。ここで [m,n] = size(ZData) です。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

YDatay 座標のデータ[3 行 3 列の倍精度値] (既定値) | ベクトルまたは行列

y 座標のデータ。ZData と同じサイズの行列または length(m) のベクトルとして指定します。ここで [m,n] = size(ZData) です。

例:

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

ZDataz 座標のデータ[3 行 3 列の倍精度値] (既定値) | 2 次元配列

z 座標のデータ。数値の 2 次元配列として指定します。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

XDataModeXData の選択モード'auto' | 'manual'

XData の選択モード。次の値の 1 つとして指定します。

  • 'auto'ZData の列インデックスを使用します。

  • 'manual' — 手動で指定した値を使用します。値を指定するには、プロット関数に入力引数を渡すか XData プロパティを直接設定します。

YDataModeYData の選択モード'auto' | 'manual'

YData の選択モード。次の値の 1 つとして指定します。

  • 'auto'ZData の行インデックスを使用します。

  • 'manual' — 手動で指定した値を使用します。値を指定するには、プロット関数に入力引数を渡すか YData プロパティを直接設定します。

可視性

すべて折りたたむ

Visibleprimitive surface の可視性'on' (既定値) | 'off'

primitive surface の可視性。次の値の 1 つとして指定します。

  • 'on' — primitive surface を表示します。

  • 'off' — primitive surface を削除せずに非表示にします。非表示の primitive surface オブジェクトのプロパティに引き続きアクセスできます。

Clipping座標軸の範囲への primitive surface のクリッピング'on' (既定値) | 'off'

座標軸の範囲への primitive surface のクリッピング。次の値の 1 つとして指定します。

  • 'on' — primitive surface の座標軸の範囲の外側部分を表示しません。

  • 'off' — primitive surface の一部が座標軸の範囲の外側に表示される場合でもすべて表示します。プロットの作成、hold on の設定、座標軸のスケーリングの固定、そして元のプロットよりも大きな primitive surface の作成を行った場合、primitive surface の一部が座標軸の範囲の外側に表示されることがあります。

EraseMode(削除済み) オブジェクトの描画と消去の手法'normal' (既定値) | 'none' | 'xor' | 'background'

    メモ:   EraseMode は削除されました。EraseMode プロパティにアクセスするコードを削除しても最小限の影響しかありません。EraseMode を使用してライン アニメーションを作成していた場合は、代わりに関数 animatedline を使用してください。

オブジェクトの描画と消去の手法。次の値の 1 つとして指定します。

  • 'normal' — すべてのオブジェクトを正しく描画するために必要な 3 次元解析を実行して、問題のある表示領域を再描画します。このモードは、最も正確な Figure を表示することができますが、非常に時間がかかります。他のモードは、かなり時間の短縮にはなりますが、完全な Figure を再描画することはできず、精度は低下します。

  • 'none' — オブジェクトは移動したり、削除されても消去されません。EraseMode,'none' であるオブジェクトを消去した後でも、そのオブジェクトは画面に表示されたままです。ただし、MATLAB はオブジェクトの以前の位置の情報を保存しないため、そのオブジェクトは印刷できません。

  • 'xor' — オブジェクトは、その下の画面の各ピクセルのインデックスとの排他的論理和 (XOR) により、表示と消去が行われます。このモードでは、その下のオブジェクトの色に影響を与えません。しかし、オブジェクトの色はその下の表示の色に依存します。

  • 'background' — 座標軸の背景色 (または座標軸の Color プロパティが 'none' の場合は Figure の背景色) で再描画することによってオブジェクトを消去します。これは、消去したオブジェクトに隠れていたオブジェクトに影響を与えますが、消去されたオブジェクトは適切に色付けされます。

MATLAB は、常にすべてのオブジェクトの EraseMode プロパティが 'normal' に設定されているかのように Figure を印刷します。これは、EraseMode'none''xor''background' のいずれかを設定して作成されたグラフィックス オブジェクトは、画面での表示と印刷用紙での表示が異なって見えることを意味しています。画面上では、MATLAB は色のレイヤーを数学的に結合したり 3 次元の並べ替えを無視したりすることで速いレンダリング速度を実現しています。しかし、MATLAB はこれらの手法を印刷出力には適用しません。ノーマル モード以外のオブジェクトを含んでいる Figure のイメージを作成するには、getframe コマンドまたは他のスクリーン キャプチャ アプリケーションを使用します。

親/子

すべて折りたたむ

Parentprimitive surface の親axes オブジェクト | グループ オブジェクト | 変換オブジェクト

primitive surface の親。axes オブジェクト、グループ オブジェクトまたは変換オブジェクトとして指定します。

HandleVisibilityオブジェクト ハンドルの可視性'on' (既定値) | 'off' | 'callback'

親の Children プロパティ内でのオブジェクト ハンドルの可視性。次の値の 1 つとして指定します。

  • 'on' — primitive surface オブジェクトをリストします。

  • 'off' — primitive surface オブジェクトをリストしません。このオプションは、GUI に影響を与える可能性がある (ユーザーの入力した文字列を評価するような) 関数をコールバックが実行する際にオブジェクト ハンドルを隠すために使用します。

  • 'callback' — コールバックまたはコールバックによって呼び出される関数に関して、親の Children プロパティ内に primitive surface オブジェクトをリストしますが、コマンド ラインから呼び出される関数内ではリストしません。このオプションは、コマンド ライン ユーザーから GUI を保護する一方で、コールバックがオブジェクトにアクセスできるようにするために使用します。

primitive surface オブジェクトが親の Children プロパティ内にリストされない場合、オブジェクト階層の検索またはハンドル プロパティのクエリによってオブジェクト ハンドルを取得する関数は、そのオブジェクト ハンドルを返しません。このような関数には、getfindobjgcagcfgconewplotclaclfclose があります。

非表示のオブジェクト ハンドルは有効なままです。ルートの ShowHiddenHandles プロパティを 'on' に設定すると、HandleVisibility プロパティの設定にかかわらず、すべてのオブジェクト ハンドルがリストされます。

Childrenprimitive surface の子空の GraphicsPlaceholder 配列

primitive surface には子はありません。このプロパティは設定できません。

識別子

すべて折りたたむ

Tagユーザー指定のタグ'' (既定値) | 任意の文字列

primitive surface に関連付けるタグ。文字列として指定します。タグはグラフィックス オブジェクトを識別する手段を提供します。プロット階層内にある特定のタグをもつすべてのオブジェクトを検出するためにこのプロパティを使用できます。たとえば findobj を使用してタグを検索します。

例: 'January Data'

Typeグラフィックス オブジェクトのタイプ'surface'

このプロパティは読み取り専用です。

グラフィックス オブジェクトのタイプ。文字列 'surface' として返されます。

UserDataprimitive surface に関連付けるデータ[] (既定値) | スカラー、ベクトルまたは行列 | セル配列 | 文字配列 | テーブル | 構造体

primitive surface オブジェクトに関連付けるデータ。スカラー、ベクトル、行列、セル配列、文字配列、テーブルまたは構造体として指定します。MATLAB はこのデータを使用しません。

複数のデータセットを関連付ける場合またはデータにフィールド名を付加する場合は、関数 getappdata および setappdata を使用します。

例: 1:100

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | struct | table | cell

DisplayName凡例によって使用されるテキスト'' (既定値) | 文字列

凡例によって使用されるテキスト。文字列として指定します。このテキストは primitive surface のアイコンの隣に表示されます。

  • primitive surface オブジェクトのテキストを関数 legend への入力引数として指定した場合、凡例では指定されたテキストが使用され、DisplayName は更新されます。

  • primitive surface オブジェクトのテキストを関数 legend への入力引数として指定しない場合、凡例では DisplayName プロパティのテキストが使用されます。DisplayName プロパティにテキストが含まれていない場合は、凡例で文字列が生成されます。この文字列は 'dataN' の形式になります。ここで、N は、凡例エントリのリスト内の位置に従って primitive surface オブジェクトに割り当てられる数字です。

既存の凡例の中でこの文字列を対話的に編集した場合、MATLAB は編集された文字列に DisplayName を更新します。

例: 'Text Description'

Annotation凡例アイコンの表示スタイルAnnotation オブジェクト

このプロパティは読み取り専用です。

凡例アイコンの表示スタイル。Annotation オブジェクトとして返されます。このオブジェクトを使用して凡例に primitive surface を含めたり除外したりします。

  1. Annotation プロパティをクエリして Annotation オブジェクトを取得します。

  2. Annotation オブジェクトの LegendInformation プロパティをクエリして LegendEntry オブジェクトを取得します。

  3. LegendEntry オブジェクトの IconDisplayStyle プロパティを次のいずれかの値に指定します。

    • 'on' — 凡例内に 1 つのエントリとして primitive surface オブジェクトを含めます (既定値)。

    • 'off' — 凡例内に primitive surface オブジェクトを含めません。

    • 'children' — primitive surface オブジェクトの子のみを個別のエントリとして凡例に含めます。

凡例が既に存在するときに IconDisplayStyle 設定を変更した場合、表示を更新するためには legend を呼び出さなければなりません。

対話制御

すべて折りたたむ

ButtonDownFcnマウスクリック コールバック'' (既定値) | 関数ハンドル | セル配列 | 文字列

マウスクリック コールバック。次の値の 1 つとして指定します。

  • 関数ハンドル

  • 関数ハンドルと追加の引数を含むセル配列

  • ベース ワークスペース内で評価される有効な MATLAB コマンドまたは関数の文字列 (推奨されません)

primitive surface をクリックしたときにコードを実行するためにこのプロパティを使用します。関数ハンドルを使用してこのプロパティを指定した場合、MATLAB はコールバックを実行するときに次の 2 つの引数をコールバック関数に渡します。

  • primitive surface オブジェクト — コールバック関数内で primitive surface オブジェクトのプロパティにアクセスできます。

  • イベント データ — このプロパティに関してはこの引数は空です。この引数が使用されないことを示すために、関数定義の中でこの引数をチルダ文字 (~) に置換します。

関数ハンドルを使用してコールバック関数を定義する方法についての詳細は、「コールバック定義」を参照してください。

    メモ:   PickableParts プロパティが 'none' に設定されている場合または HitTest プロパティが 'off' に設定されている場合には、このコールバックは実行されません。

例: @myCallback

例: {@myCallback,arg3}

UIContextMenuコンテキスト メニューuicontextmenu オブジェクト

uicontextmenu オブジェクトとして指定されるコンテキスト メニュー。primitive surface を右クリックしたときにコンテキスト メニューを表示するためにこのプロパティを使用します。関数 uicontextmenu を使用して、コンテキスト メニューを作成します。

    メモ:   PickableParts プロパティが 'none' に設定されている場合または HitTest プロパティが 'off' に設定されている場合には、このコンテキスト メニューは表示されません。

Selected選択状態'off' (既定値) | 'on'

選択状態。次の値の 1 つとして指定します。

  • 'on' — 選択されています。プロット編集モードで primitive surface をクリックした場合、MATLAB は Selected プロパティを 'on' に設定します。SelectionHighlight プロパティも 'on' に設定されている場合、MATLAB は primitive surface の周囲の選択ハンドルを表示します。

  • 'off' — 選択されていません。

SelectionHighlight選択時に選択ハンドルを表示'on' (既定値) | 'off'

選択時に選択ハンドルを表示。次の値の 1 つとして指定します。

  • 'on'Selected プロパティが 'on' に設定されているときに選択ハンドルを表示します。

  • 'off'Selected プロパティが 'on' に設定されている場合でも選択ハンドルを表示しません。

コールバック実行制御

すべて折りたたむ

PickablePartsマウス クリック キャプチャ機能'visible' (既定値) | 'all' | 'none'

マウス クリック キャプチャ機能。次の値の 1 つとして指定します。

  • 'visible' — 表示されている場合にマウス クリックをキャプチャできます。Visible プロパティが 'on' に設定されていなければならず、primitive surface の色が定義されている部分をクリックしなければなりません。関連付けられている色のプロパティが 'none' に設定されている部分をクリックすることはできません。プロットにマーカーが含まれている場合は、エッジまたは塗りつぶしのいずれかに色が定義されている場合にマーカー全体がクリック可能になります。primitive surface や先祖がクリックに応答するかどうかについては、HitTest プロパティが決定します。

  • 'all' — 表示状態に関係なくマウス クリックをキャプチャできます。Visible プロパティを 'on' または 'off' に設定でき、色が設定されていない primitive surface の一部をクリックできます。primitive surface や先祖がクリックに応答するかどうかについては、HitTest プロパティが決定します。

  • 'none' — マウス クリックをキャプチャしません。primitive surface をクリックすると、Figure ウィンドウの現在のビュー内でその下にあるオブジェクトまでクリックが渡されます。HitTest プロパティは無効になります。

HitTestキャプチャしたマウス クリックへの応答'on' (既定値) | 'off'

キャプチャしたマウス クリックへの応答。次の値の 1 つとして指定します。

  • 'on' — primitive surface の ButtonDownFcn コールバックをトリガーします。UIContextMenu プロパティが定義されている場合は、コンテキスト メニューを呼び出します。

  • 'off''on' に設定された HitTest プロパティおよび先祖のマウス クリックをキャプチャできる PickableParts プロパティ値をもつ、最も近い primitive surface の先祖のコールバックをトリガーします。

    メモ:   PickableParts プロパティは primitive surface オブジェクトがマウス クリックをキャプチャ可能かどうかを決定します。キャプチャできない場合、HitTest プロパティは無効です。

BusyActionコールバック キューイング'queue' (既定値) | 'cancel'

コールバック キューイング。'queue' または 'cancel' として指定します。BusyAction プロパティは MATLAB による割り込みコールバックの実行の処理方法を決定します。

    メモ:   次の 2 つのコールバックの状態について考慮する必要があります。

    • "実行中" コールバックは、現在実行しているコールバックです。

    • "割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。

    MATLAB がコールバックを呼び出すたびに、そのコールバックは実行中のコールバックに割り込もうとします。実行中のコールバックを所有するオブジェクトの Interruptible プロパティが、割り込み可能かどうかを決定します。割り込みが許可されない場合は、割り込みコールバックを所有するオブジェクトの BusyAction プロパティが、そのコールバックを破棄するかキューに入れるかを決定します。

primitive surface の ButtonDownFcn コールバックが割り込み不能な実行中のコールバックに割り込もうとしている場合、BusyAction プロパティはそのコールバックを破棄するかキューに入れるかを決定します。BusyAction プロパティは次の値の 1 つとして指定します。

  • 'queue' — 割り込みコールバックをキューに入れ、実行中のコールバックが終了した後に処理されるようにします。これは既定の動作です。

  • 'cancel' — 割り込みコールバックを破棄します。

Interruptibleコールバックの割り込み'on' (既定値) | 'off'

コールバックの割り込み。'on' または 'off' として指定します。Interruptible プロパティは実行中のコールバックが割り込み可能かどうかを決定します。

    メモ:   次の 2 つのコールバックの状態について考慮する必要があります。

    • "実行中" コールバックは、現在実行しているコールバックです。

    • "割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。

    MATLAB がコールバックを呼び出すたびに、そのコールバックは実行中のコールバックに割り込もうとします。実行中のコールバックを所有するオブジェクトの Interruptible プロパティが、割り込み可能かどうかを決定します。割り込みが許可されない場合は、割り込みコールバックを所有するオブジェクトの BusyAction プロパティが、そのコールバックを破棄するかキューに入れるかを決定します。

primitive surface の ButtonDownFcn コールバックが実行中のコールバックである場合、Interruptible プロパティは別のコールバックが割り込むことができるかどうかを決定します。

  • 'on' — 割り込み可能です。drawnowfiguregetframewaitforpause コマンドなどの、MATLAB が次にキューを処理するポイントで割り込みが発生します。

    • 実行中のコールバックにこれらいずれかのコマンドが含まれている場合、MATLAB はその場所でコールバックの実行を停止し、割り込みコールバックを実行します。割り込みコールバックが完了したときに MATLAB は実行中だったコールバックの実行を再開します。詳細は、「コールバック実行の中断」を参照してください。

    • 実行中のコールバックにこれらのコマンドが含まれていない場合、MATLAB はそのコールバックの実行を中断せずに終了させます。

  • 'off' — 割り込みできません。MATLAB は割り込みさせずに実行中のコールバックを終了させます。

作成と削除の制御

すべて折りたたむ

CreateFcn作成コールバック'' (既定値) | 関数ハンドル | セル配列 | 文字列

作成コールバック。次の値の 1 つとして指定します。

  • 関数ハンドル

  • 関数ハンドルと追加の引数を含むセル配列

  • ベース ワークスペース内で評価される有効な MATLAB コマンドまたは関数の文字列 (推奨されません)

primitive surface の作成時にコードを実行するためにこのプロパティを使用します。既存の primitive surface に CreateFcn プロパティを設定しても効果はありません。このプロパティの既定値を定義するか、primitive surface の作成中に Name,Value ペアを使用してこのプロパティを定義しなければなりません。MATLAB は primitive surface を作成し、そのプロパティをすべて設定した後でコールバックを実行します。

関数ハンドルを使用してこのコールバックを指定した場合、MATLAB はコールバックを実行するときに次の 2 つの引数をコールバック関数に渡します。

  • primitive surface オブジェクト — コールバック関数内で primitive surface オブジェクトのプロパティにアクセスできます。ルートの CallbackObject プロパティを介して primitive surface オブジェクトにアクセスすることもできます。これは関数 gcbo を使用してクエリできます。

  • イベント データ — このプロパティに関してはこの引数は空です。この引数が使用されないことを示すために、関数定義の中でこの引数をチルダ文字 (~) に置換します。

関数ハンドルを使用してコールバック関数を定義する方法についての詳細は、「コールバック定義」を参照してください。

例: @myCallback

例: {@myCallback,arg3}

DeleteFcn削除コールバック'' (既定値) | 関数ハンドル | セル配列 | 文字列

削除コールバック。次の値の 1 つとして指定します。

  • 関数ハンドル

  • 関数ハンドルと追加の引数を含むセル配列

  • ベース ワークスペース内で評価される有効な MATLAB コマンドまたは関数の文字列 (推奨されません)

primitive surface の削除時にコードを実行するためにこのプロパティを使用します。MATLAB は primitive surface を破棄する前にコールバックを実行するため、コールバックはそのプロパティ値にアクセスできます。

関数ハンドルを使用してこのコールバックを指定した場合、MATLAB はコールバックを実行するときに次の 2 つの引数をコールバック関数に渡します。

  • primitive surface オブジェクト — コールバック関数内で primitive surface オブジェクトのプロパティにアクセスできます。ルートの CallbackObject プロパティを介して primitive surface オブジェクトにアクセスすることもできます。これは関数 gcbo を使用してクエリできます。

  • イベント データ — このプロパティに関してはこの引数は空です。この引数が使用されないことを示すために、関数定義の中でこの引数をチルダ文字 (~) に置換します。

関数ハンドルを使用してコールバック関数を定義する方法についての詳細は、「コールバック定義」を参照してください。

例: @myCallback

例: {@myCallback,arg3}

BeingDeletedprimitive surface の削除状態'off' (既定値) | 'on'

このプロパティは読み取り専用です。

primitive surface の削除状態。'on' または 'off' として返されます。MATLAB は primitive surface の削除関数が実行を開始したときに BeingDeleted プロパティを 'on' に設定します (DeleteFcn プロパティを参照してください)。primitive surface が存在しなくなるまで BeingDeleted プロパティは 'on' に設定されたままです。

クエリや変更の前に primitive surface が削除されようとしていないか確認するために BeingDeleted プロパティの値をチェックします。

この情報は役に立ちましたか?