Actor

class Actor(*args, **kwargs)

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

Download Python source code | Download Jupyter notebook

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:                Identity
  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()

Static Scene

Interactive Scene

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

Methods

Actor.add_shader_replacement(shader_type, ...)	Add a GLSL shader replacement to this actor.
Actor.clear_point_sprite_shape()	Clear the custom point sprite shape.
Actor.clear_shader_replacements(*[, ...])	Clear shader replacements from this actor.
Actor.copy([deep])	Create a copy of this actor.
Actor.disable_maximum_intensity_projection()	Disable maximum intensity projection.
Actor.enable_maximum_intensity_projection([clim])	Enable maximum intensity projection.
Actor.plot(**kwargs)	Plot just the actor.
Actor.set_point_sprite_shape(shape)	Set a custom point sprite shape via fragment shader.

Attributes

Actor.backface_prop	Return or set the backface property.
Actor.force_opaque	Return or set actor opacity behavior.
Actor.mapper	Return or set the mapper of the actor.
Actor.memory_address	Return the memory address of this actor.
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.use_bounds	Return or set the use of actor's bounds.
Actor.visibility	Return or set actor visibility.