pyvista.Light#

class Light(position=None, focal_point=None, color=None, light_type='scene light', intensity=None, positional=None, cone_angle=None, show_actor=False, exponent=None, shadow_attenuation=None, attenuation_values=None)[ソース]#

Light クラス．

パラメータ:

positionsequence[float], optional

ライトの位置．位置の解釈は，ライトのタイプとライトに変換行列があるかどうかによって異なります． position プロパティも参照してください．

focal_pointsequence[float], optional

ライトの焦点．焦点の解釈は，ライトのタイプとライトに変換行列があるかどうかによって異なります． focal_point プロパティも参照してください．

colorColorLike, optional

ライトのカラー．作成時には，環境光の色，ディフューズカラー，スペキュラカラーはすべてこのカラーに設定されます．

light_typestr | int, default: 'scene light'

ライトのタイプ．文字列の場合は 'headlight' ， 'camera light' ， 'scene light' のいずれか．intの場合はそれぞれ1，2，3のいずれか．クラス定数 Light.HEADLIGHT ， Light.CAMERA_LIGHT ， Light.SCENE_LIGHT もそれぞれ使用できます．

ヘッドライトがカメラにアタッチされ，カメラの軸に沿って焦点を見ます．

カメラライトもカメラと一緒に移動しますが，カメラライトに対して一般的な位置を占めることができます．

シーンライトはカメラに追従しないため，シーンに対して静止しています．これがデフォルトです．

intensityfloat, optional

ライトの輝度(0と1の間)．

positionalbool, optional

ライトが定位置かどうかを設定します．

デフォルトはディレクショナルライト，例えば無限に離れたポイントソースです．コーンアングルが90度以上の位置ライトは，球体のポイントソースのように機能します．コーンアングルが90度未満の位置ライトはスポットライトと呼ばれます．

cone_anglefloat, optional

位置ライトの度単位の円錐角度．

show_actorbool, default: False

ビームのジオメトリを描くスポットライトのアクターを表示します．

exponentfloat, optional

スポットライトに使用されるコサインの指数． exponent プロパティも参照してください．

shadow_attenuationfloat, optional

影の減衰の値．

デフォルトでは，影の中にあるライトは完全に遮られます．この値を1.0未満に設定することで，影の中にあるライトを制御できます．ライトの attenuation_values を変更すると，影の減衰が1であってもオブジェクトを通過することができます．

attenuation_valuessequence, optional

2次減衰定数．

値は3つの長さのシーケンスで，この順序で定数，1次定数，2次定数を指定します．これらのパラメータは，ポジションライトにのみ影響します．

例

(10, 10, 10) でライトを作成し，拡散反射光カラーを赤に設定します．

>>> import pyvista as pv
>>> light = pv.Light(position=(10, 10, 10))
>>> light.diffuse_color = 1.0, 0.0, 0.0

(0, 0, 3) に位置ライトを作成し，円錐角度を30，指数を20，可視アクターを指定します．

>>> light = pv.Light(
...     position=(0, 0, 3),
...     show_actor=True,
...     positional=True,
...     cone_angle=30,
...     exponent=20,
... )

メソッド

`Light.add_renderer`(renderer)	このライトにレンダラーをアタッチします．
`Light.copy`([deep])	ライトの浅いコピーまたは深いコピーを返します．
`Light.from_vtk`(vtk_light)	`vtk.vtkLight` からライトを作成し，コピーを作成します．
`Light.hide_actor`()	ビームのジオメトリを表すポジションライトのアクターを非表示にします．
`Light.set_camera_light`()	原点を照らすヘッドライトを作成します．
`Light.set_direction_angle`(elev, azim)	ディレクショナルライトの位置と焦点を設定します．
`Light.set_headlight`()	ライトをヘッドライトに設定します．
`Light.set_scene_light`()	ライトをシーンライトに設定します．
`Light.show_actor`()	ビームのジオメトリを描くスポットライトのアクターを表示します．
`Light.switch_off`()	ライトを消します．
`Light.switch_on`()	ライトをつけます．

アトリビュート

`Light.ambient_color`	照明の環境光の色を返すか設定します．
`Light.attenuation_values`	2次減衰定数を返すか設定します．
`Light.cone_angle`	ポジショナルライトのコーンアングルを返すか設定します．
`Light.diffuse_color`	ライトの拡散カラーを返すか設定します．
`Light.exponent`	スポットライトに使用されるコサインの指数を返すか設定します．
`Light.focal_point`	ライトの焦点を返します．
`Light.intensity`	ライトの輝度(0と1の間)を返すか設定します．
`Light.is_camera_light`	ライトがカメラライトかどうかを返します．
`Light.is_headlight`	ライトがヘッドライトかどうかを返します．
`Light.is_scene_light`	ライトがシーンライトかどうかを返します．
`Light.light_type`	ライトタイプを返すか設定します．
`Light.on`	ライトが点灯しているかどうかを返すか設定します．
`Light.position`	ライトの位置を返します．
`Light.positional`	ライトが定位置かどうかを返すか設定します．
`Light.renderers`	このライトに関連付けられたレンダラを返します．
`Light.shadow_attenuation`	影の減衰の値を取得または設定します．
`Light.specular_color`	ライトの鏡面反射カラーを取得する，または設定します．
`Light.transform_matrix`	(もしあれば)ライトの変換行列を返すか設定します．
`Light.world_focal_point`	ライトのワールド空間焦点を返します．
`Light.world_position`	ライトのワールド空間の位置を返します．