Class Transform

The Transform contains information about 3D object's position, rotation and scale. The class follows the 'copy-on-write' pattern, which means that every operation returns a copy of the transform with updated values. It also implies that the values of the transform cannot be directly modified.

The concept of immutability improves sharing of objects as all types in TypeScript are assigned by identity, instead of by-value (e.g. a copy) as in other programming languages like C.

Constructors

constructor

new Transform(
    position?: Immutable<Vector3>,
    rotation?: Immutable<Quaternion>,
    scale?: Immutable<Vector3>,
    skew?: Immutable<Vector3>,
): Transform
Parameters
- Optionalposition: Immutable<Vector3>
- Optionalrotation: Immutable<Quaternion>
- Optionalscale: Immutable<Vector3>
- Optionalskew: Immutable<Vector3>
Returns Transform

Inherited from TransformGenerated.constructor

Properties

`Protected`_position

_position: Vector3

`Protected`_rotation

_rotation: Quaternion

`Protected`_scale

_scale: Vector3

`Protected`_skew

_skew: Vector3

`Static` `Readonly`identity

identity: Immutable<Transform>

Accessors

backward

get backward(): Vector3

Determines the negative Z (backward) axis of the object.

Returns Vector3

down

get down(): Vector3

Gets the negative Y (down) axis of the object.

Returns Vector3

forward

get forward(): Vector3

Determines the positive Z (forward) axis of the object.

Returns Vector3

inverseMatrix

get inverseMatrix(): Matrix4

Builds the inverse transform matrix.

Returns Matrix4

isUsingSkew

get isUsingSkew(): boolean

Returns true if the transform has a non-zero skew.

Returns boolean

left

get left(): Vector3

Gets the positive X (left) axis of the object.

Returns Vector3

matrix

get matrix(): Matrix4

Builds the transform matrix from current translation, rotation and scale properties.

Returns Matrix4

matrix3

get matrix3(): Matrix3

Builds the 3x3 upper left transform matrix from rotation, scale and skew.

Returns Matrix3
set matrix3(value: Immutable<Matrix3>): void
Parameters
- value: Immutable<Matrix3>
Returns void

position

get position(): Vector3

Returns Vector3

Inherited from TransformGenerated.position
set position(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

Inherited from TransformGenerated.position

right

get right(): Vector3

Gets the negative X (right) axis of the object.

Returns Vector3

rotation

get rotation(): Quaternion

Returns Quaternion

Inherited from TransformGenerated.rotation
set rotation(value: Immutable<Quaternion>): void
Parameters
- value: Immutable<Quaternion>
Returns void

Inherited from TransformGenerated.rotation

scale

get scale(): Vector3

Returns Vector3

Inherited from TransformGenerated.scale
set scale(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

Inherited from TransformGenerated.scale

skew

get skew(): Vector3

Skew factors in QDU convention: XY, XZ, YZ (vecU from QDUDecomposition). kZero means no skew.

Returns Vector3

Inherited from TransformGenerated.skew
set skew(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

Inherited from TransformGenerated.skew

up

get up(): Vector3

Gets the positive Y (up) axis of the object.

Returns Vector3

Methods

assign

assign(other: Immutable<Transform>): Transform
Copies all properties defined by the prototype of Transform from other to this instance.
Parameters
- other: Immutable<Transform>
Returns Transform

Inherited from TransformGenerated.assign

clone

clone(): Transform

Clones this instance and returns a new Transform with identical values.

Returns Transform

Inherited from TransformGenerated.clone

doLookAt

doLookAt(location: Immutable<Vector3>): Transform
Orients the object so it is looking at the provided location (world space) while using the Y axis as the up axis.
Parameters
- location: Immutable<Vector3>
  Location towards which to look at
Returns Transform

doLookAtWithUp

doLookAtWithUp(location: Immutable<Vector3>, up: Immutable<Vector3>): Transform
Orients the object so it is looking at the provided location (world space) where up is used for determining the location of the object's Y axis.
Parameters
- location: Immutable<Vector3>
  Location towards which to look at
- up: Immutable<Vector3>
  Determines the object's Y axis.
Returns Transform

doMakeLocal

doMakeLocal(parent: Immutable<Transform>): Transform
Makes the current transform relative to the provided transform and returns the result. In other words, converts from a world coordinate system to one local to the provided transform.
Parameters
- parent: Immutable<Transform>
  Transform relative to which to make the current transform local.
Returns Transform

doMakeWorld

doMakeWorld(parent: Immutable<Transform>): Transform
Makes the current transform absolute. In other words, converts from a local coordinate system relative to the provided transform, to a world coordinate system.
Parameters
- parent: Immutable<Transform>
  Transform relative to which to make the current transform in world space.
Returns Transform

doMove

doMove(vector: Immutable<Vector3>): Transform
Moves the object's position by the vector offset provided along world axes.
Parameters
- vector: Immutable<Vector3>
  Amount to move the position by.
Returns Transform

doMoveRelative

doMoveRelative(vector: Immutable<Vector3>): Transform
Moves the object's position by the vector offset provided along it's own axes (relative to orientation).
Parameters
- vector: Immutable<Vector3>
  Amount to move the position by.
Returns Transform

doPitchWithDegrees

doPitchWithDegrees(angle: rsx.Degree): Transform
Rotates around local X axis.
Parameters
- angle: rsx.Degree
  Angle to rotate by.
Returns Transform

doPitchWithRadians

doPitchWithRadians(angle: rsx.Radian): Transform
Rotates around local X axis.
Parameters
- angle: rsx.Radian
  Angle to rotate by.
Returns Transform

doRollWithDegrees

doRollWithDegrees(angle: rsx.Degree): Transform
Rotates around local Y axis.
Parameters
- angle: rsx.Degree
  Angle to rotate by.
Returns Transform

doRollWithRadians

doRollWithRadians(angle: rsx.Radian): Transform
Rotates around local Z axis.
Parameters
- angle: rsx.Radian
  Angle to rotate by.
Returns Transform

doRotateWithAxisAngleDegrees

doRotateWithAxisAngleDegrees(
axis: Immutable<Vector3>,
angle: rsx.Degree,
): Transform
Rotate the object around an arbitrary axis.
Parameters
- axis: Immutable<Vector3>
  Axis to rotate around.
- angle: rsx.Degree
  Amount to rotate around the axis.
Returns Transform

doRotateWithAxisAngleRadians

doRotateWithAxisAngleRadians(
axis: Immutable<Vector3>,
angle: rsx.Radian,
): Transform
Rotate the object around an arbitrary axis.
Parameters
- axis: Immutable<Vector3>
  Axis to rotate around.
- angle: rsx.Radian
  Amount to rotate around the axis.
Returns Transform

doRotateWithQuaternion

doRotateWithQuaternion(rotation: Immutable<Quaternion>): Transform
Rotate the object around an arbitrary axis using a Quaternion.
Parameters
- rotation: Immutable<Quaternion>
  Amount and direction to rotate.
Returns Transform

doYawWithDegrees

doYawWithDegrees(angle: rsx.Degree): Transform
Rotates around local Y axis.
Parameters
- angle: rsx.Degree
  Angle to rotate by.
Returns Transform

doYawWithRadians

doYawWithRadians(angle: rsx.Radian): Transform
Rotates around local Y axis.
Parameters
- angle: rsx.Radian
  Angle to rotate by.
Returns Transform

isEqual

isEqual(right: Immutable<Transform>): boolean
Determines if both transforms are equal.
Parameters
- right: Immutable<Transform>
Returns boolean

Overrides TransformGenerated.isEqual

makeLocal

makeLocal(parent: Immutable<Transform>): Transform
Makes the current transform relative to the provided transform and returns the result. In other words, converts from a world coordinate system to one local to the provided transform.
Parameters
- parent: Immutable<Transform>
  Transform relative to which to make the current transform local.
Returns Transform

makeWorld

makeWorld(parent: Immutable<Transform>): Transform
Makes the current transform absolute and returns the result. In other words, converts from a local coordinate system relative to the provided transform, to a world coordinate system.
Parameters
- parent: Immutable<Transform>
  Transform relative to which to make the current transform in world space.
Returns Transform

move

move(vector: Immutable<Vector3>): Transform
Moves the object's position by the vector offset provided along world axes.
Parameters
- vector: Immutable<Vector3>
  Amount to move the position by.
Returns Transform

moveRelative

moveRelative(vector: Immutable<Vector3>): Transform
Moves the object's position by the vector offset provided along it's own axes (relative to orientation).
Parameters
- vector: Immutable<Vector3>
  Amount to move the position by.
Returns Transform

pitchWithDegrees

pitchWithDegrees(angle: rsx.Degree): Transform
Rotates around local X axis.
Parameters
- angle: rsx.Degree
  Angle to rotate by.
Returns Transform

pitchWithRadians

pitchWithRadians(angle: rsx.Radian): Transform
Rotates around local X axis.
Parameters
- angle: rsx.Radian
  Angle to rotate by.
Returns Transform

rollWithDegrees

rollWithDegrees(angle: rsx.Degree): Transform
Rotates around local Z axis.
Parameters
- angle: rsx.Degree
  Angle to rotate by.
Returns Transform

rollWithRadians

rollWithRadians(angle: rsx.Radian): Transform
Rotates around local Z axis.
Parameters
- angle: rsx.Radian
  Angle to rotate by.
Returns Transform

rotateWithAxisAngleDegrees

rotateWithAxisAngleDegrees(
axis: Immutable<Vector3>,
angle: rsx.Degree,
): Transform
Rotate the object around an arbitrary axis.
Parameters
- axis: Immutable<Vector3>
  Axis to rotate around.
- angle: rsx.Degree
  Amount to rotate around the axis.
Returns Transform

rotateWithAxisAngleRadians

rotateWithAxisAngleRadians(
axis: Immutable<Vector3>,
angle: rsx.Radian,
): Transform
Rotate the object around an arbitrary axis.
Parameters
- axis: Immutable<Vector3>
  Axis to rotate around.
- angle: rsx.Radian
  Amount to rotate around the axis.
Returns Transform

rotateWithQuaternion

rotateWithQuaternion(rotation: Immutable<Quaternion>): Transform
Rotate the object around an arbitrary axis using a Quaternion.
Parameters
- rotation: Immutable<Quaternion>
  Amount and direction to rotate.
Returns Transform

setForward

setForward(forward: Immutable<Vector3>): void
Assigns the forward as new forward (look at) vector.
Parameters
- forward: Immutable<Vector3>
Returns void

setWorldPosition

setWorldPosition(
position: Immutable<Vector3>,
parent: Immutable<Transform>,
): void
Converts the provided world position to a space relative to the provided parent, and sets it as the current transform's position.
Parameters
- position: Immutable<Vector3>
  Position to set.
- parent: Immutable<Transform>
  Parent relative to which to convert the position to.
Returns void

setWorldRotation

setWorldRotation(
rotation: Immutable<Quaternion>,
parent: Immutable<Transform>,
): void
Converts the provided world rotation to a space relative to the provided parent, and sets it as the current transform's rotation.
Parameters
- rotation: Immutable<Quaternion>
  Rotation to set.
- parent: Immutable<Transform>
  Parent relative to which to convert the rotation to.
Returns void

setWorldScale

setWorldScale(scale: Immutable<Vector3>, parent: Immutable<Transform>): void
Converts the provided world scale to a space relative to the provided parent, and sets it as the current transform's scale.
Parameters
- scale: Immutable<Vector3>
- parent: Immutable<Transform>
Returns void

toString

toString(): string

Returns a string representation of an object.

Returns string

yawWithDegrees

yawWithDegrees(angle: rsx.Degree): Transform
Rotates around local Y axis.
Parameters
- angle: rsx.Degree
  Angle to rotate by.
Returns Transform

yawWithRadians

yawWithRadians(angle: rsx.Radian): Transform
Rotates around local Y axis.
Parameters
- angle: rsx.Radian
  Angle to rotate by.
Returns Transform

`Static`isEqual

isEqual(left: Immutable<Transform>, right: Immutable<Transform>): boolean
Determines if both transforms are equal by comparing position, rotation and scale.
Parameters
- left: Immutable<Transform>
- right: Immutable<Transform>
Returns boolean

Overrides TransformGenerated.isEqual

Class Transform

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Transform

Properties

Protected_position

Protected_rotation

Protected_scale

Protected_skew

Static Readonlyidentity

Accessors

backward

Returns Vector3

down

Returns Vector3

forward

Returns Vector3

inverseMatrix

Returns Matrix4

isUsingSkew

Returns boolean

left

Returns Vector3

matrix

Returns Matrix4

matrix3

Returns Matrix3

Parameters

Returns void

position

Returns Vector3

Parameters

Returns void

right

Returns Vector3

rotation

Returns Quaternion

Parameters

Returns void

scale

Returns Vector3

Parameters

Returns void

skew

Returns Vector3

Parameters

Returns void

up

Returns Vector3

Methods

assign

Parameters

Returns Transform

clone

Returns Transform

doLookAt

Parameters

Returns Transform

doLookAtWithUp

Parameters

Returns Transform

doMakeLocal

Parameters

Returns Transform

doMakeWorld

Parameters

Returns Transform

doMove

Parameters

Returns Transform

doMoveRelative

Parameters

Returns Transform

doPitchWithDegrees

`Protected`_position

`Protected`_rotation

`Protected`_scale

`Protected`_skew

`Static` `Readonly`identity