pyvista.Actor#

class Actor(mapper=None, prop=None, name=None)[source]#

Wrap vtkActor.

This class represents the geometry & properties in a rendered scene. Normally, a pyvista.Actor is constructed from pyvista.Plotter.add_mesh(), but there may be times when it is more convenient to construct an actor directly from a pyvista.DataSetMapper.

Parameters:
mapperpyvista.DataSetMapper, optional

DataSetMapper.

proppyvista.Property, optional

Property of the actor.

namestr, optional

The name of this actor used when tracking on a plotter.

Examples

Create an actor without using pyvista.Plotter.

>>> import pyvista as pv
>>> mesh = pv.Sphere()
>>> mapper = pv.DataSetMapper(mesh)
>>> actor = pv.Actor(mapper=mapper)
>>> actor
Actor (...)
  Center:                     (0.0, 0.0, 0.0)
  Pickable:                   True
  Position:                   (0.0, 0.0, 0.0)
  Scale:                      (1.0, 1.0, 1.0)
  Visible:                    True
  X Bounds                    -4.993E-01, 4.993E-01
  Y Bounds                    -4.965E-01, 4.965E-01
  Z Bounds                    -5.000E-01, 5.000E-01
  User matrix:                Set
  Has mapper:                 True
...

Change the actor properties and plot the actor.

>>> import pyvista as pv
>>> mesh = pv.Sphere()
>>> mapper = pv.DataSetMapper(mesh)
>>> actor = pv.Actor(mapper=mapper)
>>> actor.prop.color = 'blue'
>>> actor.plot()
https://d33wubrfki0l68.cloudfront.net/1a1796fb6a6c33ee8e6ad57e72c61c1b97f45d94/02a41/_images/pyvista-actor-1_00_00.png

Create an actor using the pyvista.Plotter and then change the visibility of the actor.

>>> import pyvista as pv
>>> pl = pv.Plotter()
>>> mesh = pv.Sphere()
>>> actor = pl.add_mesh(mesh)
>>> actor.visibility = False
>>> actor.visibility
False
https://d33wubrfki0l68.cloudfront.net/8d857d80b4aa52de3ad5db22f6e1210632178bb4/1934e/_images/pyvista-actor-1_01_00.png

Methods

Actor.copy([deep])

Create a copy of this actor.

Actor.plot(**kwargs)

Plot just the actor.

Attributes

Actor.backface_prop

Return or set the backface property.

Actor.mapper

Return or set the mapper of the actor.

Actor.memory_address

Return the memory address of this actor.

Actor.name

Get or set the unique name identifier used by PyVista.

Actor.pickable

Return or set actor pickability.

Actor.prop

Return or set the property of this actor.

Actor.texture

Return or set the actor texture.

Actor.visibility

Return or set actor visibility.