pyvista.Property#
- class Property(theme=None, interpolation=None, color=None, style=None, 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)[source]#
Wrap vtkProperty and expose it pythonically.
This class is used to set the property of actors.
- Parameters:
- theme
pyvista.themes.DefaultTheme
,optional
Plot-specific theme.
- interpolation
str
,optional
Set the method of shading. One of the following:
'Physically based rendering'
- Physically based rendering.'pbr'
- Alias for Physically based rendering.'Phong'
- Phong shading.'Gouraud'
- Gouraud shading.'Flat'
- Flat Shading.
This parameter is case insensitive.
- color
ColorLike
,optional
Used to make the entire mesh have a single solid color. Either a string, RGB list, or hex color string. For example:
color='white'
,color='w'
,color=[1.0, 1.0, 1.0]
, orcolor='#FFFFFF'
. Color will be overridden if scalars are specified.- style
str
,optional
Visualization style of the mesh. One of the following:
style='surface'
,style='wireframe'
,style='points'
. Defaults to'surface'
. Note that'wireframe'
only shows a wireframe of the outer geometry.- metallic
float
,optional
Usually this value is either 0 or 1 for a real material but any value in between is valid. This parameter is only used by PBR interpolation.
- roughness
float
,optional
This value has to be between 0 (glossy) and 1 (rough). A glossy material has reflections and a high specular part. This parameter is only used by PBR interpolation.
- point_size
float
,optional
Size of the points represented by this property.
- opacity
float
,optional
Opacity of the mesh. A single float value that will be applied globally opacity of the mesh and uniformly applied everywhere - should be between 0 and 1.
- ambient
float
,optional
When lighting is enabled, this is the amount of light in the range of 0 to 1 (default 0.0) that reaches the actor when not directed at the light source emitted from the viewer.
- diffuse
float
,optional
The diffuse lighting coefficient. Default 1.0.
- specular
float
,optional
The specular lighting coefficient. Default 0.0.
- specular_power
float
,optional
The specular power. Between 0.0 and 128.0.
- show_edgesbool,
optional
Shows the edges. Does not apply to a wireframe representation.
- edge_color
ColorLike
,optional
The solid color to give the edges when
show_edges=True
. Either a string, RGB list, or hex color string.- render_points_as_spheresbool,
optional
Render points as spheres rather than dots.
- render_lines_as_tubesbool,
optional
Show lines as thick tubes rather than flat lines. Control the width with
line_width
.- lightingbool,
optional
Enable or disable view direction lighting.
- line_width
float
,optional
Thickness of lines. Only valid for wireframe and surface representations.
- culling
str
, bool,optional
Does not render faces that are culled. This can be helpful for dense surface meshes, especially when edges are visible, but can cause flat meshes to be partially displayed. Defaults to
'none'
. One of the following:"back"
- Enable backface culling"front"
- Enable frontface culling'none'
- Disable both backface and frontface culling
- theme
Examples
Create a
pyvista.Actor
and assign properties to it.>>> 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 ... )
Visualize how the property would look when applied to a mesh.
>>> 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()
Methods
Create a deep copy of this property.
Property.plot
(**kwargs)Plot this property on the Stanford Bunny.
Attributes
Return or set ambient.
Return or set the ambient color of this property.
Return or set the anisotropy coefficient.
Return or set the color of this property.
Return or set face culling.
Return or set the diffuse lighting coefficient.
Return or set the diffuse color of this property.
Return or set the edge color of this property.
Return or set the method of shading.
Return or set view direction lighting.
Return or set the line width.
Return or set metallic.
Return or set the opacity of this property.
Return or set the point size.
Return or set rendering lines as tubes.
Return or set rendering points as spheres.
Return or set roughness.
Return or set the visibility of edges.
Return or set specular.
Return or set the specular color of this property.
Return or set specular power.
Return or set Visualization style of the mesh.