Interface TransformInterface

Transform coordinates and quaternions from one coordinate reference system into another one

interface TransformInterface {
    source: ReferenceSystemInterface;
    target: ReferenceSystemInterface;
    getInverse(): TransformInterface;
    transform(vector: Vector2): Vector2;
    transform(vector: Vector3): Vector3;
    transformQuaternion(quaternion: Quaternion, location?: Vector2 | Vector3): Quaternion;
}

Index

Properties

Methods

getInverse transform transformQuaternion

Properties

source

source: ReferenceSystemInterface

Source coordinate reference system

target

target: ReferenceSystemInterface

Target coordinate reference system

Methods

getInverse

getInverse(): TransformInterface
Compute and return the inverse transform, i.e., the one that transforms from the target to the source reference system.

Returns TransformInterface
Inverse transform

transform

transform(vector): Vector2
Transform a two-dimensional vector from the source to the target reference system.

This method operates in-place, i.e., the vector is modified.
Parameters
- vector: Vector2
  Vector to transform
Returns Vector2
Transformed vector (same object as the argument)
transform(vector): Vector3
Transform a three-dimensional vector from the source to the target reference system.

This method operates in-place, i.e., the vector is modified.
Parameters
- vector: Vector3
  Vector to transform
Returns Vector3
Transformed vector (same object as the argument)

transformQuaternion

transformQuaternion(quaternion, location?): Quaternion
Transform a quaternion from the source to the target reference system.
Parameters
- quaternion: Quaternion
  Quaternion to transform
- Optionallocation: Vector2 | Vector3
Returns Quaternion
Transformed quaternion (same object as the argument)