Class Transform3D

Represents a 3D transformation containing position, rotation, and scale components. This class provides a convenient way to handle 3D object transformations with automatic matrix composition and decomposition capabilities.

Example

const transform = new Transform3D();
transform.position = Vector3.fromCopyArray([1, 2, 3]);
transform.scale = Vector3.fromCopyArray([2, 2, 2]);
transform.rotation = Quaternion.fromEulerAngles(0, Math.PI / 4, 0);
const matrix = transform.matrix;

Constructors

constructor

new Transform3D(): Transform3D
Creates a new Transform3D instance.

Returns Transform3D
- Defined in foundation/math/Transform3D.ts:43
new Transform3D(Transform3D): Transform3D
Parameters
- Transform3D: Transform3D
Returns Transform3D
- Defined in foundation/math/Transform3D.ts:44

Accessors

eulerAngles

get eulerAngles(): IVector3
Gets a copy of the rotation as Euler angles (XYZ order).

Returns IVector3
A cloned Vector3 containing rotation angles in radians [x, y, z]
- Defined in foundation/math/Transform3D.ts:146
set eulerAngles(vec): void
Sets the rotation using Euler angles (XYZ order).
Parameters
- vec: IVector3
  Vector containing rotation angles in radians [x, y, z]
Returns void
- Defined in foundation/math/Transform3D.ts:126

eulerAnglesInner

get eulerAnglesInner(): Vector3
Gets the rotation as Euler angles (XYZ order) - direct reference.

Returns Vector3
A Vector3 containing rotation angles in radians [x, y, z]
- Defined in foundation/math/Transform3D.ts:154

matrix

get matrix(): IMatrix44
Gets a copy of the local transformation matrix.

Returns IMatrix44
A new Matrix44 representing the composed transformation
- Defined in foundation/math/Transform3D.ts:256
set matrix(mat): void
Sets the transform from a 4x4 transformation matrix. Decomposes the matrix into position, rotation, and scale components.
Parameters
- mat: IMatrix44
  The transformation matrix to decompose
Returns void
- Defined in foundation/math/Transform3D.ts:245

matrixInner

get matrixInner(): MutableMatrix44
Gets the local transformation matrix composed from position, rotation, and scale. The matrix is computed as: Translation * Rotation * Scale

Returns MutableMatrix44
A MutableMatrix44 representing the composed transformation
- Defined in foundation/math/Transform3D.ts:265

position

get position(): MutableVector3
Gets a copy of the local position vector.

Returns MutableVector3
A cloned MutableVector3 representing the position
- Defined in foundation/math/Transform3D.ts:110
set position(vec): void
Sets the position of the transform.
Parameters
- vec: IVector3
  The new position vector
Returns void
- Defined in foundation/math/Transform3D.ts:90

positionInner

get positionInner(): MutableVector3
Gets the internal position vector (direct reference).

Returns MutableVector3
The internal MutableVector3 position object
- Defined in foundation/math/Transform3D.ts:118

rotateMatrix44

get rotateMatrix44(): IMatrix44
Gets the rotation as a 4x4 rotation matrix.

Returns IMatrix44
A Matrix44 representing only the rotation component
- Defined in foundation/math/Transform3D.ts:436
set rotateMatrix44(rotateMatrix): void
Sets the rotation using a 4x4 rotation matrix.
Parameters
- rotateMatrix: IMatrix44
  The rotation matrix to extract rotation from
Returns void
- Defined in foundation/math/Transform3D.ts:428

rotation

get rotation(): IQuaternion
Gets a copy of the local rotation quaternion.

Returns IQuaternion
A cloned Quaternion representing the rotation
- Defined in foundation/math/Transform3D.ts:220
set rotation(quat): void
Sets the rotation using a quaternion.
Parameters
- quat: IQuaternion
  The new rotation quaternion
Returns void
- Defined in foundation/math/Transform3D.ts:199

rotationInner

get rotationInner(): Quaternion
Gets the internal rotation quaternion (direct reference).

Returns Quaternion
The internal Quaternion rotation object
- Defined in foundation/math/Transform3D.ts:228

scale

get scale(): IVector3
Gets a copy of the local scale vector.

Returns IVector3
A cloned MutableVector3 representing the scale
- Defined in foundation/math/Transform3D.ts:183
set scale(vec): void
Sets the scale of the transform.
Parameters
- vec: IVector3
  The new scale vector
Returns void
- Defined in foundation/math/Transform3D.ts:163

scaleInner

get scaleInner(): MutableVector3
Gets the internal scale vector (direct reference).

Returns MutableVector3
The internal MutableVector3 scale object
- Defined in foundation/math/Transform3D.ts:191

updateCount

get updateCount(): number
Gets the number of times this transform has been updated. This can be useful for optimization and caching purposes.

Returns number
The update count as a number
- Defined in foundation/math/Transform3D.ts:420

Methods

clone

clone(): Transform3D
Creates a deep copy of this transform.

Returns Transform3D
A new Transform3D instance with the same values
- Defined in foundation/math/Transform3D.ts:81

getMatrixInnerTo

getMatrixInnerTo(mat): void
Efficiently computes the transformation matrix and stores it in the provided matrix. This method avoids memory allocation by reusing an existing matrix object.
Parameters
- mat: MutableMatrix44
  The target matrix to store the result in
Returns void
- Defined in foundation/math/Transform3D.ts:344

headToDirection

headToDirection(fromVec, toVec): void
Rotates the transform to face from one direction to another. Calculates the rotation needed to align the 'from' direction with the 'to' direction.
Parameters
- fromVec: Vector3
  The current forward direction
- toVec: Vector3
  The target direction to face towards
Returns void
- Defined in foundation/math/Transform3D.ts:503

isEqual

isEqual(rhs, delta?): boolean
Checks if this transform is equal to another transform within a given tolerance.
Parameters
- rhs: Transform3D
  The transform to compare against
- delta: number = Number.EPSILON
  The tolerance for comparison (default: Number.EPSILON)
Returns boolean
True if the transforms are equal within the specified tolerance
- Defined in foundation/math/Transform3D.ts:69

setPositionAsArray3

setPositionAsArray3(array): void
Sets the position using an array of three numbers.
Parameters
- array: Array3<number>
  Array containing [x, y, z] position values
Returns void
- Defined in foundation/math/Transform3D.ts:99

setPropertiesFromJson

setPropertiesFromJson(arg): void
Sets transform properties from a JSON object. Supports setting position, scale, rotation (as quaternion), and matrix properties.
Parameters
- arg: JSON
  JSON object or JSON string containing transform properties
Returns void
- Defined in foundation/math/Transform3D.ts:445

setRotationAsArray4

setRotationAsArray4(array): void
Sets the rotation using an array of four numbers representing a quaternion.
Parameters
- array: Array4<number>
  Array containing [x, y, z, w] quaternion values
Returns void
- Defined in foundation/math/Transform3D.ts:208

setRotationFromNewUpAndFront

setRotationFromNewUpAndFront(UpVec, FrontVec): void
Sets the rotation to align with specified up and front vectors. Creates a coordinate system where the Y-axis aligns with the up vector and the Z-axis aligns with the front vector.
Parameters
- UpVec: IVector3
  The desired up direction (Y-axis)
- FrontVec: IVector3
  The desired front direction (Z-axis)
Returns void
- Defined in foundation/math/Transform3D.ts:470

setScaleAsArray3

setScaleAsArray3(array): void
Sets the scale using an array of three numbers.
Parameters
- array: Array3<number>
  Array containing [x, y, z] scale values
Returns void
- Defined in foundation/math/Transform3D.ts:172

setTransform

setTransform(translate, scale, rotation): void
Sets multiple transform components at once for optimal performance. This method reduces the cost of automatically updating transform matrices by setting all components in a single operation. Useful for animation and batch updates where performance is critical.

Note: The provided transform components must be mutually consistent. For example, if a matrix is provided, its decomposed translate, rotate, and scale components should match the individual component arguments.
Parameters
- translate: MutableVector3
  The position component
- scale: MutableVector3
  The scale component
- rotation: MutableQuaternion
  The rotation component as a quaternion
Returns void
- Defined in foundation/math/Transform3D.ts:527

Class Transform3D

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Transform3D

Parameters

Returns Transform3D

Accessors

eulerAngles

Returns IVector3

Parameters

Returns void

eulerAnglesInner

Returns Vector3

matrix

Returns IMatrix44

Parameters

Returns void

matrixInner

Returns MutableMatrix44

position

Returns MutableVector3

Parameters

Returns void

positionInner

Returns MutableVector3

rotateMatrix44

Returns IMatrix44

Parameters

Returns void

rotation

Returns IQuaternion

Parameters

Returns void

rotationInner

Returns Quaternion

scale

Returns IVector3

Parameters

Returns void

scaleInner

Returns MutableVector3

updateCount

Returns number

Methods

clone

Returns Transform3D

getMatrixInnerTo

Parameters

Returns void

headToDirection

Parameters

Returns void

isEqual

Parameters

Returns boolean

setPositionAsArray3

Parameters

Returns void

setPropertiesFromJson

Parameters

Returns void

setRotationAsArray4

Parameters

Returns void

setRotationFromNewUpAndFront

Parameters

Returns void

setScaleAsArray3

Parameters

Returns void

setTransform

Parameters

Returns void

Settings

On This Page