pyvista.Property

class Property(theme=None, interpolation=None, color=None, style='surface', metallic=None, roughness=None, point_size=None, opacity=None, ambient=None, diffuse=None, specular=None, specular_power=None, show_edges=None, edge_color=None, render_points_as_spheres=None, render_lines_as_tubes=None, lighting=None, line_width=None, culling=None, edge_opacity=None)

vtkProperty をラップして pythonically に公開します．

アクターのプロパティを設定するためのクラスです．

パラメータ:

themepyvista.plotting.themes.Theme, optional

Plot固有のテーマ．

interpolationstr, default: pyvista.plotting.themes._LightingConfig.interpolation

シェーディングの方法を設定します．以下のいずれかを指定します．

• 'Physically based rendering' - 物理ベースレンダリング．

• 'pbr' - 物理ベースレンダリングのエイリアスです．

• 'Phong' - Phongシェーディング．

• 'Gouraud' - Gouraud シェーディング．

• 'Flat' - Flatシェーディング．

このパラメータは大文字と小文字を区別しません．

colorColorLike, default: pyvista.plotting.themes.Theme.color

メッシュ全体を単一のソリッドカラーにします．文字列，RGBリスト，または16進カラー文字列．例: color='white' ， color='w' ， color=[1.0, 1.0, 1.0] ， color='#FFFFFF' ．スカラーが指定されている場合，色は上書きされます．

stylestr, default: 'surface'

メッシュの表示スタイル． style='surface' ，style='wireframe' ， style='points' のいずれかです．　'wireframe' は外部ジオメトリのワイヤフレームのみを表示することに注意してください．

metallicfloat, default: pyvista.plotting.themes._LightingConfig.metallic

通常，この値は実際のマテリアルでは0または1ですが，中間の値は有効です．このパラメータはPBR補間でのみ使用されます．

roughnessfloat, default: pyvista.plotting.themes._LightingConfig.roughness

この値は，0(光沢)と1(粗さ)の間である必要があります．光沢のあるマテリアルには，反射と高い鏡面反射部分があります．このパラメータは，PBR補間でのみ使用されます．

point_sizefloat, default: pyvista.plotting.themes.Theme.point_size

このプロパティで表現される点の大きさ．

opacityfloat, default: pyvista.plotting.themes.Theme.opacity

メッシュの不透明度．メッシュの不透明度をグローバルに適用し，どこでも一様に適用される単一の浮動小数点値です． - 0と1の間でなければなりません．

ambientfloat, default: pyvista.plotting.themes._LightingConfig.ambient

照明が有効な場合，これは，ビューアから放射された光源に向けられていないときにアクターに到達する0から1の範囲の光の量です．

diffusefloat, default: pyvista.plotting.themes._LightingConfig.diffuse

拡散照明係数．

specularfloat, default: pyvista.plotting.themes._LightingConfig.specular

鏡面反射光の係数．

specular_powerfloat, default: pyvista.plotting.themes._LightingConfig.specular_power

スペキュラーパワーを指定します．0.0から128.0の間でなければなりません．

show_edgesbool, default: pyvista.plotting.themes.Theme.show_edges

エッジを表示します．ワイヤフレーム表示には適用されません．

edge_colorColorLike, default: pyvista.plotting.themes.Theme.edge_color

show_edges=True の場合にエッジに適用される単色です．文字列，RGBリスト，または16進カラー文字列．

render_points_as_spheresbool, default: pyvista.plotting.themes.Theme.render_points_as_spheres

点をドットではなく球としてレンダリングします．

render_lines_as_tubesbool, default: pyvista.plotting.themes.Theme.render_lines_as_tubes

線分をフラットな線分ではなく太いチューブとして表示します． line_width で幅を制御します．

lightingbool, default: pyvista.plotting.themes.Theme.lighting

ビュー方向の照明を有効または無効にします．

line_widthfloat, default: pyvista.plotting.themes.Theme.line_width

線の太さ．ワイヤフレーム表示とサーフェス表示にのみ有効です．

cullingstr | bool, optional

選択された面はレンダリングされません．これは，高密度のサーフェイスメッシュ，特にエッジが表示されている場合に便利ですが，フラットメッシュが部分的に表示されることがあります．デフォルトは 'none' です．以下のいずれか1つです:

• "back" - バックフェースカリングを有効にします．

• "front" - フロントフェイスカリングを有効にします．

• 'none' - バックフェイスおよびフロントフェイスのカリングを無効にします．

edge_opacityfloat, default: pyvista.plotting.themes.Theme.edge_opacity

メッシュのエッジの不透明度．メッシュのエッジの不透明度をグローバルに適用し，どこでも一様に適用される単一の浮動小数点値です． - 0と1の間でなければなりません．

注釈

edge_opacity は SetEdgeOpacity を基礎メソッドとして使用し，VTKバージョン9.3以降を必要とします．もし SetEdgeOpacity が利用できない場合， edge_opacity` は 1 に設定されます．

例

pyvista.Actor を作成し，プロパティを割り当てます．

>>> import pyvista as pv
>>> actor = pv.Actor()
>>> actor.prop = pv.Property(
...     color='r',
...     show_edges=True,
...     interpolation='Physically based rendering',
...     metallic=0.5,
...     roughness=0.1,
... )

そのプロパティをメッシュに適用した場合の見え方をビジュアル化します．

>>> actor.prop.plot()

Set custom properties not directly available in pyvista.Plotter.add_mesh(). Here, we set diffuse, ambient, and specular power and colors.

>>> pl = pv.Plotter()
>>> actor = pl.add_mesh(pv.Sphere())
>>> prop = actor.prop
>>> prop.diffuse = 0.6
>>> prop.diffuse_color = 'w'
>>> prop.ambient = 0.3
>>> prop.ambient_color = 'r'
>>> prop.specular = 0.5
>>> prop.specular_color = 'b'
>>> pl.show()

メソッド

Property.copy()	このプロパティのディープコピーを作成します．
Property.plot(**kwargs)	このプロパティをスタンフォードバニーにプロットします．

アトリビュート

Property.ambient	アンビエントを返すか設定します．
Property.ambient_color	このプロパティの環境光の色を返すか設定します．
Property.anisotropy	異方性係数を返すか設定します．
Property.color	このプロパティの色を返すか設定します．
Property.culling	フェースカリングを返すか設定します．
Property.diffuse	拡散照明係数を返すか設定します．
Property.diffuse_color	このプロパティの散乱光に対する色を返すか設定します．
Property.edge_color	このプロパティのエッジの色を返すか設定します．
Property.edge_opacity	このプロパティのエッジの不透明度を返すか設定します．
Property.interpolation	シェーディングの方法を返すか設定します．
Property.lighting	ビュー方向の照明を返すか設定します．
Property.line_width	線幅を返すか設定します．
Property.metallic	メタリックを返すか設定します．
Property.opacity	このプロパティの不透明度を返すか設定します．
Property.point_size	ポイントサイズを返すか設定します．
Property.render_lines_as_tubes	レンダリングラインをチューブとして返すか設定します．
Property.render_points_as_spheres	レンダリングポイントを球体として返すか設定します．
Property.roughness	粗さを返すか設定します．
Property.show_edges	エッジの表示を取得または設定します．
Property.specular	鏡面を返すか設定します．
Property.specular_color	このプロパティの鏡面光に対する色を返すか設定します．
Property.specular_power	スペキュラパワーを返すか設定します．
Property.style	メッシュの可視化スタイルを返すか設定します．