pyvista.DataSetFilters.scale

DataSetFilters.scale(

xyz: float | VectorLike[float],

transform_all_input_vectors: bool = False,

inplace: bool = False,

point: VectorLike[float] | None = None,

)

Scale the mesh.

Note

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

Parameters:

xyzfloat | VectorLike[float]

A vector sequence defining the scale factors along x, y, and z. If a scalar, the same uniform scale is used along all three axes.

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.

pointVectorLike[float], optional

Point to scale from. Defaults to origin.

Returns:

pyvista.DataSet

Scaled dataset.

See also

pyvista.Transform.scale

Concatenate a scale matrix with a transformation.

Examples

>>> import pyvista as pv
>>> from pyvista import examples
>>> pl = pv.Plotter(shape=(1, 2))
>>> pl.subplot(0, 0)
>>> pl.show_axes()
>>> _ = pl.show_grid()
>>> mesh1 = examples.download_teapot()
>>> _ = pl.add_mesh(mesh1)
>>> pl.subplot(0, 1)
>>> pl.show_axes()
>>> _ = pl.show_grid()
>>> mesh2 = mesh1.scale([10.0, 10.0, 10.0], inplace=False)
>>> _ = pl.add_mesh(mesh2)
>>> pl.show(cpos="xy")

Static Scene

Interactive Scene