Class Transform

constructor

• new Transform(position?, rotation?, scale?, skew?): Transform

• Parameters

  • Optionalposition: Immutable<Vector3>
  • Optionalrotation: Immutable<Quaternion>
  • Optionalscale: Immutable<Vector3>
  • Optionalskew: Immutable<Vector3>

  Returns Transform

Static Readonlyidentity

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): void

• Parameters

  • value: Immutable<Matrix3>

  Returns void

right

• get right(): Vector3

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

  Returns Vector3

up

• get up(): Vector3

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

  Returns Vector3

doLookAt

• doLookAt(location): 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, up): 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): 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): 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): 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): 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): Transform

• Rotates around local X axis.

  Parameters

  • angle: rsx.Degree

    Angle to rotate by.

  Returns Transform

doPitchWithRadians

• doPitchWithRadians(angle): Transform

• Rotates around local X axis.

  Parameters

  • angle: rsx.Radian

    Angle to rotate by.

  Returns Transform

doRollWithDegrees

• doRollWithDegrees(angle): Transform

• Rotates around local Y axis.

  Parameters

  • angle: rsx.Degree

    Angle to rotate by.

  Returns Transform

doRollWithRadians

• doRollWithRadians(angle): Transform

• Rotates around local Z axis.

  Parameters

  • angle: rsx.Radian

    Angle to rotate by.

  Returns Transform

doRotateWithAxisAngleDegrees

• doRotateWithAxisAngleDegrees(axis, angle): 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, angle): 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): 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): Transform

• Rotates around local Y axis.

  Parameters

  • angle: rsx.Degree

    Angle to rotate by.

  Returns Transform

doYawWithRadians

• doYawWithRadians(angle): Transform

• Rotates around local Y axis.

  Parameters

  • angle: rsx.Radian

    Angle to rotate by.

  Returns Transform

isEqual

• isEqual(right): boolean

• Determines if both transforms are equal.

  Parameters

  • right: Immutable<Transform>

  Returns boolean

makeLocal

• makeLocal(parent): 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): 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): 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): 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): Transform

• Rotates around local X axis.

  Parameters

  • angle: rsx.Degree

    Angle to rotate by.

  Returns Transform

pitchWithRadians

• pitchWithRadians(angle): Transform

• Rotates around local X axis.

  Parameters

  • angle: rsx.Radian

    Angle to rotate by.

  Returns Transform

rollWithDegrees

• rollWithDegrees(angle): Transform

• Rotates around local Z axis.

  Parameters

  • angle: rsx.Degree

    Angle to rotate by.

  Returns Transform

rollWithRadians

• rollWithRadians(angle): Transform

• Rotates around local Z axis.

  Parameters

  • angle: rsx.Radian

    Angle to rotate by.

  Returns Transform

rotateWithAxisAngleDegrees

• rotateWithAxisAngleDegrees(axis, angle): 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, angle): 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): 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): void

• Assigns the forward as new forward (look at) vector.

  Parameters

  • forward: Immutable<Vector3>

  Returns void

setWorldPosition

• setWorldPosition(position, parent): 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, parent): 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, parent): 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): Transform

• Rotates around local Y axis.

  Parameters

  • angle: rsx.Degree

    Angle to rotate by.

  Returns Transform

yawWithRadians

• yawWithRadians(angle): Transform

• Rotates around local Y axis.

  Parameters

  • angle: rsx.Radian

    Angle to rotate by.

  Returns Transform

StaticisEqual

• isEqual(left, right): boolean

• Determines if both transforms are equal by comparing position, rotation and scale.

  Parameters

  • left: Immutable<Transform>
  • right: Immutable<Transform>

  Returns boolean