pyvista.DataObjectFilters.rotate_vector

DataObjectFilters.rotate_vector(

vector: VectorLike[float],

angle: float,

point: VectorLike[float] | None = None,

transform_all_input_vectors: bool = False,

inplace: bool = False,

) → _MeshType_co

Rotate mesh about a vector.

Note

See also the notes at transform() which is used by this filter under the hood.

Parameters:

vectorVectorLike[float]

Vector to rotate about.

anglefloat

Angle to rotate.

pointVectorLike[float], optional

Point to rotate about. Defaults to origin.

transform_all_input_vectorsbool, default: False

When True, all input vectors are transformed. Otherwise, only the points, normals and active vectors are transformed.

inplacebool, default: False

Updates mesh in-place.

Returns:

DataSet | MultiBlock

Rotated dataset. Return type matches input.

See also

pyvista.Transform.rotate_vector

Concatenate a rotation about a vector with a transformation.

Examples

Rotate a mesh 30 degrees about the (1, 1, 1) axis.

>>> import pyvista as pv
>>> mesh = pv.Cube()
>>> rot = mesh.rotate_vector((1, 1, 1), 30, inplace=False)

Plot the rotated mesh.

>>> pl = pv.Plotter()
>>> _ = pl.add_mesh(rot)
>>> _ = pl.add_mesh(mesh, style='wireframe', line_width=3)
>>> _ = pl.add_axes_at_origin()
>>> pl.show()

Static Scene

Interactive Scene