pyvista.Prop3D#

class Prop3D[source]#

Prop3D wrapper for vtkProp3D.

Used to represent an entity in a rendering scene. It provides spatial properties and methods relating to an entity’s position, orientation and scale. It is used as parent class for pyvista.Actor, pyvista.AxesActor, and pyvista.plotting.volume.Volume.

Prop3D applies transformations in the following order:

  1. Translate entity to its origin.

  2. Scale entity by the values in scale.

  3. Rotate entity using the values in orientation. Internally, rotations are applied in the order rotate_y(), then rotate_x(), then rotate_z().

  4. Translate entity away from its origin and to its position.

  5. Transform entity with user_matrix.

Methods

Prop3D.rotate_x(angle)

Rotate the entity about the x-axis.

Prop3D.rotate_y(angle)

Rotate the entity about the y-axis.

Prop3D.rotate_z(angle)

Rotate the entity about the z-axis.

Attributes

Prop3D.bounds

Return the bounds of the entity.

Prop3D.center

Return the center of the entity.

Prop3D.length

Return the length of the entity.

Prop3D.orientation

Return or set the entity orientation angles.

Prop3D.origin

Return or set the entity origin.

Prop3D.position

Return or set the entity position.

Prop3D.scale

Return or set entity scale.

Prop3D.user_matrix

Return or set the user matrix.