translate#

UniformGrid.translate(xyz: Union[list, tuple, numpy.ndarray], transform_all_input_vectors=False, inplace=False)#

Translate the mesh.

Note

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

Parameters
xyzlist or tuple or np.ndarray

Length 3 list, tuple or array.

transform_all_input_vectorsbool, optional

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

inplacebool, optional

Updates mesh in-place.

Returns
pyvista.DataSet

Translated dataset.

Examples

Create a sphere and translate it by (2, 1, 2).

>>> import pyvista
>>> mesh = pyvista.Sphere()
>>> mesh.center
[0.0, 0.0, 0.0]
>>> trans = mesh.translate((2, 1, 2), inplace=False)
>>> trans.center
[2.0, 1.0, 2.0]