Transform | CoSpaces API

Defines the position, scale and rotation of an item.

Every Transform can be assigned to a BaseItem.parent which allows hierarchical editing of their position, scale and rotation. Created hierarchies are displayed in the Item Hierarchy tab.

Hierarchy

ReadonlyTransform
- Transform

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Transform(): Transform

Inherited from ReadonlyTransform.constructor
Returns Transform

Properties

Readonly axisX

axisX: Vector3

Red axis of this Transform.

Readonly axisY

axisY: Vector3

Green axis of this Transform.

Readonly axisZ

axisZ: Vector3

Blue axis of this Transform.

Readonly forward

forward: Vector3

Shorthand for Y - axis.

Note: By default, DX Engine uses the green Y axis as forward vector.

position

position: Vector3

Position of this Transform using X, Y, and Z coordinates.

Note: By default, DX engine uses Z for "up".

Readonly right

right: Vector3

Shorthand for X - axis.

Note: By default, DX Engine uses the red X axis as right vector.

rotation

rotation: Quat

Rotation of this Transform stored as Quat.

scale

scale: number

Scale of this Transform.

Default value is 1.

Readonly up

up: Vector3

Shorthand for Z - axis.

Note: By default, DX Engine uses the Z axis as up vector.

Methods

apply

apply(other: ReadonlyTransform): Transform

- Defined in api.ts:2868
Additively applies values of another Transform to this Transform.

Parameters
- other: ReadonlyTransform
  
  Transform to add values from.
Returns Transform

compose

compose(other: ReadonlyTransform): Transform

- Defined in api.ts:2877
Returns a new Transform created by combining this and other.

Parameters
- other: ReadonlyTransform
  
  Transform to add values from.
Returns Transform
new Transform.

copy

copy(): Transform

Inherited from ReadonlyTransform.copy
- Defined in api.ts:2723
Returns a copy of this Transform.

Returns Transform
copy of this Transform.

invert

invert(): Transform

- Defined in api.ts:2882
Inverts all values of this Transform.

Returns Transform

localToWorldPoint

localToWorldPoint(position: Vector3): Vector3

Inherited from ReadonlyTransform.localToWorldPoint
- Defined in api.ts:2707
Converts local position to world position of this Transform.

Parameters
- position: Vector3
  
  local space point.`
Returns Vector3
world space point.

localToWorldVector

localToWorldVector(direction: Vector3): Vector3

Inherited from ReadonlyTransform.localToWorldVector
- Defined in api.ts:2716
Converts local direction to world direction of this Transform.

Parameters
- direction: Vector3
  
  local space direction.
Returns Vector3
world space direction.

lookAt

lookAt(worldPosition: Vector3, worldUp: Vector3): Transform
lookAt(worldPosition: Vector3): Transform

- Defined in api.ts:2769
Rotates this Transform so that the forward vector points to the worldPosition.

Note: By default, DX engine uses Y axis as forward vector.

Parameters
- worldPosition: Vector3
  
  point to look at.
- worldUp: Vector3
  
  upward direction.
Returns Transform
- Defined in api.ts:2778
Rotates this Transform so that the forward vector points to the worldPosition.

Note: By default, DX engine uses Y axis as forward vector.

Parameters
- worldPosition: Vector3
  
  point to look at.
Returns Transform

multScale

multScale(scaleFactor: number): Transform

- Defined in api.ts:2861
Multiplies this Transform current scale by scale

Parameters
- scaleFactor: number
Returns Transform

rotate

rotate(origin: Vector3, axis: Vector3, angleInRadians: number): Transform
rotate(axis: Vector3, angleInRadians: number): Transform

- Defined in api.ts:2811
Rotates this Transform by angleInRadians around an origin point using axis as rotation direction.

Parameters
- origin: Vector3
  
  world space position to rotate around.
- axis: Vector3
  
  rotation axis.
- angleInRadians: number
  
  rotation in radians.
Returns Transform
- Defined in api.ts:2820
Rotates this Transform by angleInRadians around world position (0,0,0) towards axis direction.

Parameters
- axis: Vector3
  
  rotation axis.
- angleInRadians: number
  
  rotation in radians.
Returns Transform

rotateLocal

rotateLocal(offset: Vector3, axis: Vector3, angleInRadians: number): Transform
rotateLocal(axis: Vector3, angleInRadians: number): Transform

- Defined in api.ts:2831
Rotates this Transform by angleInRadians around an offset towards axis direction.

Parameters
- offset: Vector3
  
  offset relative to current position.
- axis: Vector3
  
  rotation axis.
- angleInRadians: number
  
  rotation in radians.
Returns Transform
- Defined in api.ts:2840
Rotates this Transform by angleInRadians around its pivot towards axis direction.

Parameters
- axis: Vector3
  
  rotation axis.
- angleInRadians: number
  
  rotation in radians.
Returns Transform

set

set(transform: ReadonlyTransform): Transform

- Defined in api.ts:2758
Sets values of this Transform to another Transform.

Parameters
- transform: ReadonlyTransform
  
  Transform to copy values from.
Returns Transform

setDirection

setDirection(direction: Vector3, worldUp: Vector3): Transform
setDirection(direction: Vector3): Transform

- Defined in api.ts:2792
Rotates this Transform so that
- its local Y-axis points towards the defined direction.
- its local Z-axis points towards the worldUp direction.
Note: The local Z-axis always attempts to be perpendicular to Y, which may lead to worldUp not always accurately pointed at.
Parameters
- direction: Vector3
  
  euler rotation to apply.
- worldUp: Vector3
  
  upward direction.
Returns Transform
- Defined in api.ts:2800
Rotates this Transform so that
- its local Y-axis points towards the defined direction.
Parameters
- direction: Vector3
Returns Transform

swapYZ

swapYZ(): Transform

- Defined in api.ts:2887
Swaps Y and Z axes of this `Transform.

Returns Transform

translate

translate(translation: Vector3): Transform

- Defined in api.ts:2847
Moves this Transform by translation.

Parameters
- translation: Vector3
  
  translation relative to world coordinate system.
Returns Transform

translateLocal

translateLocal(translation: Vector3): Transform

- Defined in api.ts:2854
Moves this Transform by translation.

Parameters
- translation: Vector3
  
  translation relative to this Transform.
Returns Transform

worldToLocalPoint

worldToLocalPoint(position: Vector3): Vector3

Inherited from ReadonlyTransform.worldToLocalPoint
- Defined in api.ts:2689
Converts world position to local position of this Transform.

Parameters
- position: Vector3
  
  world space point.
Returns Vector3
local space point.

worldToLocalVector

worldToLocalVector(direction: Vector3): Vector3

Inherited from ReadonlyTransform.worldToLocalVector
- Defined in api.ts:2698
Converts world direction to local direction of this Transform.

Parameters
- direction: Vector3
  
  world space direction.
Returns Vector3
local space direction.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Transform

Properties

Readonly axisX

Readonly axisY

Readonly axisZ

Readonly forward

position

Readonly right

rotation

scale

Readonly up

Methods

apply

Parameters

other: ReadonlyTransform

Returns Transform

compose

Parameters

other: ReadonlyTransform

Returns Transform

copy

Returns Transform

invert

Returns Transform

localToWorldPoint

Parameters

position: Vector3

Returns Vector3

localToWorldVector

Parameters

direction: Vector3

Returns Vector3

lookAt

Parameters

worldPosition: Vector3

worldUp: Vector3

Returns Transform

Parameters

worldPosition: Vector3

Returns Transform

multScale

Parameters

scaleFactor: number

Returns Transform

rotate

Parameters

origin: Vector3

axis: Vector3

angleInRadians: number

Returns Transform

Parameters

axis: Vector3

angleInRadians: number

Returns Transform

rotateLocal

Parameters

offset: Vector3

axis: Vector3

angleInRadians: number

Returns Transform

Parameters

axis: Vector3

angleInRadians: number

Returns Transform

set

Parameters

transform: ReadonlyTransform

Returns Transform

setDirection

Parameters

direction: Vector3

worldUp: Vector3

Returns Transform