Class SceneObjectTransform

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

Hierarchy

FrameworkObject
- SceneObjectTransform

Constructors

`Protected`constructor

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

Accessors

localBackward

get localBackward(): Immutable<Vector3>
The local backward axis of the SceneObject.

Returns Immutable<Vector3>
Note
World backward axis is considered to be negative Z.

localDown

get localDown(): Immutable<Vector3>
The local down axis of the SceneObject.

Returns Immutable<Vector3>
Note
World down axis is considered to be negative Y.

localForward

get localForward(): Immutable<Vector3>
The local forward axis of the SceneObject.

Returns Immutable<Vector3>
Note
World forward axis is considered to be positive Z.
set localForward(value): void
Parameters
- value: Immutable<Vector3>
Returns void

localLeft

get localLeft(): Immutable<Vector3>
The local left axis of the SceneObject.

Returns Immutable<Vector3>
Note
World left axis is considered to be positive X.

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

localRight

get localRight(): Immutable<Vector3>
The local right axis of the SceneObject.

Returns Immutable<Vector3>
Note
World right axis is considered to be negative X.

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

localSkew

get localSkew(): Immutable<Vector3>
Local skew of the object.

Returns Immutable<Vector3>
set localSkew(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

localUp

get localUp(): Immutable<Vector3>
The local up axis of the SceneObject.

Returns Immutable<Vector3>
Note
World up axis is considered to be positive Y.

worldBackward

get worldBackward(): Immutable<Vector3>
The world backward axis of the SceneObject.

Returns Immutable<Vector3>
Note
World backward axis is considered to be negative Z.

worldDown

get worldDown(): Immutable<Vector3>
The world down axis of the SceneObject.

Returns Immutable<Vector3>
Note
World down axis is considered to be negative Y.

worldForward

get worldForward(): Immutable<Vector3>
The world forward axis of the SceneObject.

Returns Immutable<Vector3>
Note
World forward axis is considered to be positive Z.
set worldForward(value): void
Parameters
- value: Immutable<Vector3>
Returns void

worldLeft

get worldLeft(): Immutable<Vector3>
The world left axis of the SceneObject.

Returns Immutable<Vector3>
Note
World left axis is considered to be positive X.

worldMatrix

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

Returns Immutable<Matrix4>

worldMatrixInverse

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

Returns Immutable<Matrix4>

worldPosition

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

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

worldRight

get worldRight(): Immutable<Vector3>
The world right axis of the SceneObject.

Returns Immutable<Vector3>
Note
World right axis is considered to be negative X.

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

worldUp

get worldUp(): Immutable<Vector3>
The world up axis of the SceneObject.

Returns Immutable<Vector3>
Note
World up axis is considered to be positive Y.

Methods

lookAt

lookAt(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>
- up: Immutable<Vector3>
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

pitchWithDegrees

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

pitchWithRadians

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

rollWithDegrees

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

rollWithRadians

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

rotate

rotate(rotation): void
Rotate the object around an arbitrary axis using a Quaternion.
Parameters
- rotation: Immutable<Quaternion>
Returns void

rotateWithDegrees

rotateWithDegrees(axis, angle): void
Rotate the object around an arbitrary axis.
Parameters
- axis: Immutable<Vector3>
- angle: rsx.Degree
Returns void

rotateWithRadians

rotateWithRadians(axis, angle): void
Rotate the object around an arbitrary axis.
Parameters
- axis: Immutable<Vector3>
- angle: rsx.Radian
Returns void

setLocalPositionWithLockedChildren

setLocalPositionWithLockedChildren(position): void
Sets the local position, but without affecting the world transform of any child objects. The local transform of the children will be updated accordingly.
Parameters
- position: Immutable<Vector3>
Returns void

setLocalRotationWithLockedChildren

setLocalRotationWithLockedChildren(rotation): void
Sets the local rotation, but without affecting the world transform of any child objects. The local transform of the children will be updated accordingly.
Parameters
- rotation: Immutable<Quaternion>
Returns void

setLocalScaleWithLockedChildren

setLocalScaleWithLockedChildren(scale): void
Sets the local scale, but without affecting the world transform of any child objects. The local transform of the children will be updated accordingly.
Parameters
- scale: Immutable<Vector3>
Returns void

setLocalSkewWithLockedChildren

setLocalSkewWithLockedChildren(skew): void
Sets the local skew, but without affecting the world transform of any child objects. The local transform of the children will be updated accordingly.
Parameters
- skew: Immutable<Vector3>
Returns void

setLocalTransformWithLockedChildren

setLocalTransformWithLockedChildren(transform): void
Sets the local transform, but without affecting the world transform of any child objects. The local transform of the children will be updated accordingly.
Parameters
- transform: Immutable<Transform>
Returns void

setWorldPositionWithLockedChildren

setWorldPositionWithLockedChildren(position): void
Sets the world space position, but without affecting the world transform of any child objects. The local transform of the children will be updated accordingly.
Parameters
- position: Immutable<Vector3>
Returns void

setWorldRotationWithLockedChildren

setWorldRotationWithLockedChildren(rotation): void
Sets the world space rotation, but without affecting the world transform of any child objects. The local transform of the children will be updated accordingly.
Parameters
- rotation: Immutable<Quaternion>
Returns void

setWorldScaleWithLockedChildren

setWorldScaleWithLockedChildren(scale): void
Sets the world space scale, but without affecting the world transform of any child objects. The local transform of the children will be updated accordingly.
Parameters
- scale: Immutable<Vector3>
Returns void

setWorldTransformWithLockedChildren

setWorldTransformWithLockedChildren(transform): void
Sets the world transform, but without affecting the world transform of any child objects. The local transform of the children will be updated accordingly.
Parameters
- transform: Immutable<Transform>
Returns void

yawWithDegrees

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

yawWithRadians

yawWithRadians(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

localBackward

Returns Immutable<Vector3>

Note

localDown

Returns Immutable<Vector3>

Note

localForward

Returns Immutable<Vector3>

Note

Parameters

Returns void

localLeft

Returns Immutable<Vector3>

Note

localMatrix

Returns Immutable<Matrix4>

localPosition

Returns Immutable<Vector3>

Parameters

Returns void

localRight

Returns Immutable<Vector3>

Note

localRotation

Returns Immutable<Quaternion>

Parameters

Returns void

localScale

Returns Immutable<Vector3>

Parameters

Returns void

localSkew

Returns Immutable<Vector3>

Parameters

Returns void

localTransform

Returns Immutable<Transform>

Parameters

Returns void

localUp

Returns Immutable<Vector3>

Note

worldBackward

Returns Immutable<Vector3>

Note

worldDown

Returns Immutable<Vector3>

Note

worldForward

Returns Immutable<Vector3>

Note

Parameters

Returns void

worldLeft

Returns Immutable<Vector3>

Note

worldMatrix

Returns Immutable<Matrix4>

worldMatrixInverse

Returns Immutable<Matrix4>

worldPosition

Returns Immutable<Vector3>

Parameters

Returns void

worldRight

Returns Immutable<Vector3>

Note

worldRotation

Returns Immutable<Quaternion>

`Protected`constructor