Transform.apply_to_vectors

Transform.apply_to_vectors#

Transform.apply_to_vectors(
vectors: VectorLikeFloat | MatrixLikeFloat,
/,
*,
inverse: bool = False,
copy: bool = True,
) → NDArray[np.floating][source]#

Apply the current transformation matrix to a vector or vectors.

This is equivalent to apply(vectors, 'vectors'). See apply() for details and examples.

Parameters:
vectorsVectorLikeFloat | MatrixLikeFloat

Single vector or Nx3 vectors array to apply the transformation to.

inversebool, default: False

Apply the transformation using the inverse_matrix instead of the matrix.

copybool, default: True

Return a copy of the input with the transformation applied. Set this to False to transform the input directly and return it. Only applies to NumPy arrays. A copy is always returned for tuple and list inputs or point arrays with integers.

Returns:
np.ndarray

Transformed vectors.

See Also#

apply

Apply this transformation to any input.

apply_to_points

Apply this transformation to points.

apply_to_dataset

Apply this transformation to a dataset.

apply_to_actor

Apply this transformation to an actor.