1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
"""Module containing pyvista implementation of :vtk:`vtkProperty`."""
from __future__ import annotations
from typing import TYPE_CHECKING
from pyvista.core.utilities.misc import _NoNewAttrMixin
from .opts import InterpolationType
from .opts import RepresentationType
if TYPE_CHECKING:
from . import _vtk
class ActorProperties(_NoNewAttrMixin):
"""Properties wrapper for :vtk:`vtkProperty`.
Contains the surface properties of the object.
Parameters
----------
properties : :vtk:`vtkProperty`
VTK properties of the current object.
Examples
--------
Access the properties of the z-axis shaft.
>>> import pyvista as pv
>>> axes = pv.Axes()
>>> z_axes_prop = axes.axes_actor.z_axis_shaft_properties
>>> z_axes_prop.color = (1.0, 1.0, 0.0)
>>> z_axes_prop.opacity = 0.5
>>> axes.axes_actor.shaft_type = axes.axes_actor.ShaftType.CYLINDER
>>> pl = pv.Plotter()
>>> _ = pl.add_actor(axes.axes_actor)
>>> _ = pl.add_mesh(pv.Sphere())
>>> pl.show()
"""
def __init__(self, properties: _vtk.vtkProperty) -> None:
super().__init__()
self.properties = properties
@property
def color(self): # numpydoc ignore=RT01
"""Return or set the color of the actor."""
return self.properties.GetColor()
@color.setter
def color(self, color: tuple[float, float, float]):
self.properties.SetColor(color[0], color[1], color[2])
@property
def metallic(self): # numpydoc ignore=RT01
"""Return or set the metallic coefficient of the surface."""
return self.properties.GetMetallic()
@metallic.setter
def metallic(self, value: float):
self.properties.SetMetallic(value)
@property
def roughness(self): # numpydoc ignore=RT01
"""Return or set the roughness of the surface."""
return self.properties.GetRoughness()
@roughness.setter
def roughness(self, value: float):
self.properties.SetRoughness(value)
@property
def anisotropy(self): # numpydoc ignore=RT01
"""Return or set the anisotropy coefficient."""
return self.properties.GetAnisotropy()
@anisotropy.setter
def anisotropy(self, value: float):
self.properties.SetAnisotropy(value)
@property
def anisotropy_rotation(self): # numpydoc ignore=RT01
"""Return or set the anisotropy rotation coefficient."""
return self.properties.GetAnisotropyRotation()
@anisotropy_rotation.setter
def anisotropy_rotation(self, value: float):
self.properties.SetAnisotropyRotation(value)
@property
def lighting(self): # numpydoc ignore=RT01
"""Return or set the lighting activation flag."""
return self.properties.GetLighting()
@lighting.setter
def lighting(self, flag: bool):
self.properties.SetLighting(flag)
@property
def interpolation_model(self): # numpydoc ignore=RT01
"""Return or set the interpolation model.
Can be any of the options in :class:`pyvista.plotting.opts.InterpolationType` enum.
"""
return InterpolationType.from_any(self.properties.GetInterpolation())
@interpolation_model.setter
def interpolation_model(self, model: InterpolationType):
self.properties.SetInterpolation(model.value)
@property
def index_of_refraction(self): # numpydoc ignore=RT01
"""Return or set the Index Of Refraction of the base layer."""
return self.properties.GetBaseIOR()
@index_of_refraction.setter
def index_of_refraction(self, value: float):
self.properties.SetBaseIOR(value)
@property
def opacity(self): # numpydoc ignore=RT01
"""Return or set the opacity of the actor."""
return self.properties.GetOpacity()
@opacity.setter
def opacity(self, value: float):
self.properties.SetOpacity(value)
@property
def shading(self): # numpydoc ignore=RT01
"""Return or set the flag to activate the shading."""
return self.properties.GetShading()
@shading.setter
def shading(self, is_active: bool):
self.properties.SetShading(is_active)
@property
def representation(self) -> RepresentationType: # numpydoc ignore=RT01
"""Return or set the representation of the actor.
Can be any of the options in :class:`pyvista.plotting.opts.RepresentationType` enum.
"""
return RepresentationType.from_any(self.properties.GetRepresentation())
@representation.setter
def representation(self, value: RepresentationType):
self.properties.SetRepresentation(RepresentationType.from_any(value).value)
|
