Light のプロパティ

ライトの外観と動作

Light プロパティは Light オブジェクトの外観と動作を制御します。プロパティの値を変更することで、ライトの特定の要素を変更できます。プロパティのクエリと設定にはドット表記を使用します。

h = light;
c = h.Color;
h.Style = 'local';

色とスタイル

すべて展開する

`Color` — ライトの色
`[1 1 1]` (既定値) | RGB 3 成分 | 16 進数カラーコード | `'r'` | `'g'` | `'b'` | ...

ライトの色。RGB 3 成分、16 進数カラーコード、色の名前、または省略名として指定されます。既定の RGB 3 成分 [1 1 1] は白に対応します。

RGB 3 成分および 16 進数カラーコードは、カスタム色を指定するのに役立ちます。

RGB 3 成分は、色の赤、緑、青成分の強度を指定する 3 成分の行ベクトルです。強度値は [0,1] の範囲でなければなりません。たとえば [0.4 0.6 0.7] のようになります。
16 進数カラーコードは、ハッシュ記号 (#) で始まり、3 桁または 6 桁の 0 から F までの範囲の 16 進数が続く文字ベクトルまたは string スカラーです。この値は大文字と小文字を区別しません。したがって、カラーコード '#FF8800'、'#ff8800'、'#F80'、および '#f80' は等価です。

あるいは、名前を使用して一部の一般的な色を指定できます。次の表に、名前の付いた色オプション、等価の RGB 3 成分、および 16 進数カラーコードを示します。

色名	省略名	RGB 3 成分	16 進数カラーコード
`"red"`	`"r"`	`[1 0 0]`	`"#FF0000"`
`"green"`	`"g"`	`[0 1 0]`	`"#00FF00"`
`"blue"`	`"b"`	`[0 0 1]`	`"#0000FF"`
`"cyan"`	`"c"`	`[0 1 1]`	`"#00FFFF"`
`"magenta"`	`"m"`	`[1 0 1]`	`"#FF00FF"`
`"yellow"`	`"y"`	`[1 1 0]`	`"#FFFF00"`
`"black"`	`"k"`	`[0 0 0]`	`"#000000"`
`"white"`	`"w"`	`[1 1 1]`	`"#FFFFFF"`

MATLAB^® の多くのタイプのプロットで使用されている既定の色の RGB 3 成分および 16 進数カラーコードを次に示します。

RGB 3 成分	16 進数カラーコード	外観
`[0 0.4470 0.7410]`	`"#0072BD"`
`[0.8500 0.3250 0.0980]`	`"#D95319"`
`[0.9290 0.6940 0.1250]`	`"#EDB120"`
`[0.4940 0.1840 0.5560]`	`"#7E2F8E"`
`[0.4660 0.6740 0.1880]`	`"#77AC30"`
`[0.3010 0.7450 0.9330]`	`"#4DBEEE"`
`[0.6350 0.0780 0.1840]`	`"#A2142F"`

例: 'green'

`Style` — 光源の種類
`'infinite'` (既定値) | `'local'`

光源の種類。次の値の 1 つとして指定します。

'infinite' — ライトを無限遠に配置します。Position プロパティを使用して、ライトがどの方向から平行光線を発するかを指定します。
'local' — Position プロパティによって指定される位置にライトを配置します。ライトは点光源で、設定位置から全方向を照らします。

`Position` — 光源の位置
`[1 0 1]` (既定値) | `[x y z]` の書式の 3 要素ベクトル

光源の位置。[x y z] の書式の3 要素ベクトルとして指定します。座標軸の原点から (x, y, z) 座標までのデータ単位のベクトル要素を定義します。ライトの実際の位置は、Style プロパティの値によって異なります。

例: [-40 -4 140]

位置

すべて展開する

`Position` — 光源の位置
`[1 0 1]` (既定値) | `[x y z]` の書式の 3 要素ベクトル

例: [-40 -4 140]

`Visible` — 光源からの光の可視性
`'on'` (既定値) | on/off logical 値

光源からの光の可視性。'on' または 'off' として、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

コールバック

すべて展開する

`CreateFcn` — 作成関数
`''` (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

オブジェクト作成関数。次の値のいずれかとして指定します。

関数ハンドル。
最初の要素が関数ハンドルである cell 配列。cell 配列内のその後の要素はコールバック関数に渡される引数です。
有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベースワークスペースで評価します。

コールバックを関数ハンドル、cell 配列、または文字ベクトルとして指定する方法の詳細については、グラフィックスオブジェクトのコールバックの作成を参照してください。

このプロパティは、MATLAB がオブジェクトを作成するときに実行されるコールバック関数を指定します。MATLAB は CreateFcn コールバックを実行する前に、すべてのプロパティ値を初期化します。CreateFcn プロパティを指定しない場合、MATLAB は既定の作成関数を実行します。

既存のコンポーネントに CreateFcn プロパティを設定しても効果はありません。

このプロパティを関数ハンドルまたは cell 配列として指定した場合、コールバック関数の最初の引数を使用して、作成中のオブジェクトにアクセスできます。それ以外の場合は、関数 gcbo を使用してオブジェクトにアクセスします。

`DeleteFcn` — 削除関数
`''` (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

オブジェクト削除関数。次の値のいずれかとして指定します。

関数ハンドル。
最初の要素が関数ハンドルである cell 配列。cell 配列内のその後の要素はコールバック関数に渡される引数です。
有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベースワークスペースで評価します。

このプロパティは、MATLAB がオブジェクトを削除するときに実行されるコールバック関数を指定します。MATLAB は、オブジェクトのプロパティを破棄する前に DeleteFcn コールバックを実行します。DeleteFcn プロパティを指定しない場合、MATLAB は既定の削除関数を実行します。

このプロパティを関数ハンドルまたは cell 配列として指定した場合、コールバック関数の最初の引数を使用して、削除されるオブジェクトにアクセスできます。それ以外の場合は、関数 gcbo を使用してオブジェクトにアクセスします。

コールバック実行制御

すべて展開する

`BeingDeleted` — 削除状態
on/off logical 値

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

削除状態。matlab.lang.OnOffSwitchState 型の on/off logical 値として返されます。

MATLAB は、DeleteFcn コールバックが実行を開始すると、BeingDeleted プロパティを 'on' に設定します。コンポーネントオブジェクトが存在しなくなるまで BeingDeleted プロパティは 'on' に設定されたままです。

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

親/子

すべて展開する

`Parent` — 親
`Axes` オブジェクト | `Group` オブジェクト | `Transform` オブジェクト

親。Axes、Group または Transform オブジェクトとして指定します。

`Children` — 子
空の `GraphicsPlaceholder` 配列

このオブジェクトには子がありません。このプロパティは設定できません。

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

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

"on" — オブジェクトハンドルは常に表示されます。
"off" — オブジェクトハンドルは常に非表示です。このオプションは、他の関数による意図しない変更を防止するために役立ちます。HandleVisibility を "off" に設定すると、その関数の実行中にハンドルが一時的に非表示になります。
"callback" — オブジェクトハンドルはコールバック内から、あるいはコールバックにより呼び出される関数から参照できます。しかし、コマンドラインから呼び出される関数からは参照できません。このオプションを使用すると、コマンドラインからのオブジェクトへのアクセスがブロックされますが、コールバック関数からのアクセスは許可されます。

オブジェクトが親の Children プロパティ内にリストされない場合、オブジェクト階層の検索またはハンドルプロパティのクエリによってオブジェクトハンドルを取得する関数は、そのオブジェクトハンドルを返しません。こうした関数の例としては、関数 get、findobj、gca、gcf、gco、newplot、cla、clf、および close などが挙げられます。

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

識別子

すべて展開する

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

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

グラフィックスオブジェクトのタイプ。'light' として返されます。プロット階層内にある特定のタイプのすべてのオブジェクトを検出するためにこのプロパティを使用できます。たとえば findobj を使用してタイプを検索します。

`Tag` — オブジェクト識別子
`''` (既定値) | 文字ベクトル | string スカラー

オブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。オブジェクトの識別子として機能する一意の Tag 値を指定できます。コードの他の部分からオブジェクトにアクセスする必要がある場合、関数 findobj を使用して Tag 値に基づいてオブジェクトを検索できます。

`UserData` — ユーザーデータ
`[]` (既定値) | 配列

ユーザーデータ。任意の MATLAB 配列として指定します。たとえば、スカラー、ベクトル、行列、cell 配列、文字配列、table、または構造体を指定できます。このプロパティを使用して、任意のデータをオブジェクトに保存します。

App Designer を使用している場合は、UserData プロパティを使用する代わりに、アプリでパブリックプロパティまたはプライベートプロパティを作成してデータを共有します。詳細については、App Designer アプリ内でのデータの共有を参照してください。