pyvista.DataSetFilters.texture_map_to_plane#

DataSetFilters.texture_map_to_plane( origin=None, point_u=None, point_v=None, inplace=False, name='Texture Coordinates', use_bounds=False, progress_bar=False, )[source]#

Texture map this dataset to a user defined plane.

This is often used to define a plane to texture map an image to this dataset. The plane defines the spatial reference and extent of that image.

Parameters:

originsequence[float], optional: Length 3 iterable of floats defining the XYZ coordinates of the bottom left corner of the plane.
point_usequence[float], optional: Length 3 iterable of floats defining the XYZ coordinates of the bottom right corner of the plane.
point_vsequence[float], optional: Length 3 iterable of floats defining the XYZ coordinates of the top left corner of the plane.
inplacebool, default: False: If True, the new texture coordinates will be added to this dataset. If False, a new dataset is returned with the texture coordinates.
namestr, default: “Texture Coordinates”: The string name to give the new texture coordinates if applying the filter inplace.
use_boundsbool, default: False: Use the bounds to set the mapping plane by default (bottom plane of the bounding box).
progress_barbool, default: False: Display a progress bar to indicate progress.

Returns:

pyvista.DataSet: Original dataset with texture coordinates if inplace=True, otherwise a copied dataset.

Examples

See Topographic Map