Class Transform

constructor

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

• Parameters

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

  Returns Transform

Static Readonlyidentity

forward

• get forward(): Vector3

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

  Returns Vector3

inverseMatrix

• get inverseMatrix(): Matrix4

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

  Returns Matrix4

matrix

• get matrix(): Matrix4

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

  Returns Matrix4

right

• get right(): Vector3

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

  Returns Vector3

up

• get up(): Vector3

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

  Returns Vector3

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

doPitch

• doPitch(angle): Transform

• Rotates around local X axis.

  Parameters

  • angle: rsx.Radian

    Angle to rotate by.

  Returns Transform

doRoll

• doRoll(angle): Transform

• Rotates around local Z axis.

  Parameters

  • angle: rsx.Radian

    Angle to rotate by.

  Returns Transform

doRotateWithAxis

• doRotateWithAxis(axis, angle): void

• 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 void

doRotateWithQuaternion

• doRotateWithQuaternion(rotation): void

• Rotate the object around an arbitrary axis using a Quaternion.

  Parameters

  • rotation: Immutable<Quaternion>

    Amount and direction to rotate.

  Returns void

doYaw

• doYaw(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

setForward

• setForward(value): void

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

  Parameters

  • value: Vector3

  Returns void

setLookAt

• setLookAt(location): void

• 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 void

setLookAtWithUp

• setLookAtWithUp(location, up): void

• 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 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

StaticisEqual

• isEqual(left, right): boolean

• Determines if both transforms are equal.

  Parameters

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

  Returns boolean