pyvista.CubeFacesSource.names

pyvista.CubeFacesSource.names#

property CubeFacesSource.names: tuple[str, str, str, str, str, str][source]#

Return or set the names of the faces.

Specify three strings, one for each ‘+/-’ face pair, or six strings, one for each individual face.

If three strings, plus '+' and minus '-' characters are added to the names.

Examples

>>> import pyvista as pv
>>> cube_faces = pv.CubeFacesSource()

Use three strings to set the names. Plus '+' and minus '-' characters are added automatically.

>>> cube_faces.names = ['U', 'V', 'W']
>>> cube_faces.names
('+U', '-U', '+V', '-V', '+W', '-W')

Alternatively, use six strings to set the names explicitly.

>>> cube_faces.names = [
...     'right',
...     'left',
...     'anterior',
...     'posterior',
...     'superior',
...     'inferior',
... ]
>>> cube_faces.names
('right', 'left', 'anterior', 'posterior', 'superior', 'inferior')