Class SceneObjectTransform

Contains local and world transforms for a SceneObject, as well as various cached data as well as helper functionality.

Hierarchy

FrameworkObject
- SceneObjectTransform

Index

Constructors

`Protected`constructor

new SceneObjectTransform(isInternalConstructor?): SceneObjectTransform
Parameters
- OptionalisInternalConstructor: boolean
Returns SceneObjectTransform
Overrides FrameworkObject.constructor

Accessors

localMatrix

get localMatrix(): Immutable<Matrix4>
Gets the objects local transform matrix.

Returns Immutable<Matrix4>

localPosition

get localPosition(): Immutable<Vector3>
Local position of the object.

Returns Immutable<Vector3>
set localPosition(value): void
Parameters
- value: Immutable<Vector3>
Returns void

localRotation

get localRotation(): Immutable<Quaternion>
Local rotation of the object.

Returns Immutable<Quaternion>
set localRotation(value): void
Parameters
- value: Immutable<Quaternion>
Returns void

localScale

get localScale(): Immutable<Vector3>
Local scale of the object.

Returns Immutable<Vector3>
set localScale(value): void
Parameters
- value: Immutable<Vector3>
Returns void

localTransform

get localTransform(): Immutable<Transform>
Gets the transform object representing object's position/rotation/scale relative to its parent.

Returns Immutable<Transform>
set localTransform(value): void
Parameters
- value: Immutable<Transform>
Returns void

worldMatrix

get worldMatrix(): Immutable<Matrix4>
Gets the objects world transform matrix.

Returns Immutable<Matrix4>
Note
Performance warning: This might involve updating the transforms if the transform is dirty.

worldMatrixInverse

get worldMatrixInverse(): Immutable<Matrix4>
Gets the objects inverse world transform matrix.

Returns Immutable<Matrix4>
Note
Performance warning: This might involve updating the transforms if the transform is dirty.

worldPosition

get worldPosition(): Immutable<Vector3>
World position of the object.

Returns Immutable<Vector3>
set worldPosition(value): void
Parameters
- value: Immutable<Vector3>
Returns void

worldRotation

get worldRotation(): Immutable<Quaternion>
World rotation of the object.

Returns Immutable<Quaternion>
set worldRotation(value): void
Parameters
- value: Immutable<Quaternion>
Returns void

worldScale

get worldScale(): Immutable<Vector3>
World scale of the object.

Setting this will not work properly if this object or any of its parents have non-affine transform matrices.

Returns Immutable<Vector3>
set worldScale(value): void
Parameters
- value: Immutable<Vector3>
Returns void

worldTransform

get worldTransform(): Immutable<Transform>
Gets the transform object representing object's position/rotation/scale in world space.

Returns Immutable<Transform>
set worldTransform(value): void
Parameters
- value: Immutable<Transform>
Returns void

Methods

lookAt

lookAt(location, up, positiveZ?): 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>
- up: Immutable<Vector3>
- OptionalpositiveZ: boolean
Returns void
Note
The positiveZ determine if the object looks through its positive or negative Z-Axis. For cameras and lights, this should be false, for all other objects it's best to set this to true (Default).

moveLocal

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

moveWorld

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

pitch

pitch(angle): void
Rotates around X axis
Parameters
- angle: rsx.Radian
  Angle to rotate by.
Returns void

roll

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

rotate

rotate(options): void
Rotate the object around an arbitrary axis.
Parameters
- options: {
      angle: rsx.Radian;
      axis: Immutable<Vector3>;
  } | {
      rotation: Immutable<Quaternion>;
  }
  Options object for the function call.
Returns void

setForward

setForward(direction): void
Rotates the game object so it's forward axis faces the provided direction.
Parameters
- direction: Immutable<Vector3>
  The forward direction to face, in world space.
Returns void
Note
Local forward axis is considered to be positive Z.

yaw

yaw(angle): void
Rotates around Y axis.
Parameters
- angle: rsx.Radian
  Angle to rotate by.
Returns void

Class SceneObjectTransform

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns SceneObjectTransform

Accessors

localMatrix

Returns Immutable<Matrix4>

localPosition

Returns Immutable<Vector3>

Parameters

Returns void

localRotation

Returns Immutable<Quaternion>

Parameters

Returns void

localScale

Returns Immutable<Vector3>

Parameters

Returns void

localTransform

Returns Immutable<Transform>

Parameters

Returns void

worldMatrix

Returns Immutable<Matrix4>

Note

worldMatrixInverse

Returns Immutable<Matrix4>

Note

worldPosition

Returns Immutable<Vector3>

Parameters

Returns void

worldRotation

Returns Immutable<Quaternion>

Parameters

Returns void

worldScale

Returns Immutable<Vector3>

Parameters

Returns void

worldTransform

Returns Immutable<Transform>

Parameters

Returns void

Methods

lookAt

Parameters

Returns void

Note

moveLocal

Parameters

Returns void

moveWorld

Parameters

Returns void

pitch

Parameters

Returns void

roll

Parameters

Returns void

rotate

Parameters

Returns void

setForward

Parameters

Returns void

Note

yaw

Parameters

Returns void

Settings

On This Page

`Protected`constructor