dot big bang

API Version

Hierarchy

Transform

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Transform(position?: Vector3, rotation?: Euler, scale?: Vector3): Transform

Creates a new Transform.

Parameters
- Optional position: Vector3
  
  The position part of the transform. Default is (0, 0, 0).
- Optional rotation: Euler
  
  The rotation part of the transform. Default is (0, 0, 0, 'XYZ').
- Optional scale: Vector3
  
  The scale part of the transform. Scale components with a value of zero or extremely close to zero can cause certain methods to not operate properly. Default is (1, 1, 1).
Returns Transform

Accessors

position

get position(): Vector3

The position part of this transform.

Returns Vector3

rotation

get rotation(): Euler

The rotation part of this transform.

Returns Euler

scale

get scale(): Vector3

The scale part of this transform. Scale components with a value of zero or extremely close to zero can cause certain methods to not operate properly.

Returns Vector3

Methods

clone

clone(): Transform

Returns a new transform which is an exact copy of this one.

Returns Transform

copy

copy(transform: Transform): Transform

Copies the provided transform into this one.

Parameters
- transform: Transform
Returns Transform

getForward

getForward(optionalTarget?: Vector3): Vector3

Returns the "forward" direction unit-vector corresponding to this transform.

Parameters
- Optional optionalTarget: Vector3
  
  If provided, the vector to recevie the result.
Returns Vector3

getLeft

getLeft(optionalTarget?: Vector3): Vector3

Returns the "left" direction unit-vector corresponding to this transform.

Parameters
- Optional optionalTarget: Vector3
  
  If provided, the vector to recevie the result.
Returns Vector3

getMatrix

getMatrix(optionalTarget?: Matrix4): Matrix4

Returns the transform expressed as a Matrix4.

Parameters
- Optional optionalTarget: Matrix4
  
  If provided, a matrix to receive the result.
Returns Matrix4

getUp

getUp(optionalTarget?: Vector3): Vector3

Returns the "up" direction unit-vector corresponding to this transform.

Parameters
- Optional optionalTarget: Vector3
  
  If provided, the vector to recevie the result.
Returns Vector3

lookAt

lookAt(point: Vector3): Transform

Rotates this Transform to face a point in the same coordinate space. After this operation, the positive end of the object's local Z axis will face the point.

Parameters
- point: Vector3
  
  The location in our coordinate space to face towards.
Returns Transform

set

set(position: Vector3, rotation: Euler, scale: Vector3): Transform

Sets this transform by position, rotation and scale by copying the provided one

Parameters
- position: Vector3
- rotation: Euler
- scale: Vector3
Returns Transform

setFromMatrix

setFromMatrix(matrix: Matrix4): Transform

Sets this transform from a Matrix4.

Parameters
- matrix: Matrix4
  
  The matrix to set this transform from.
Returns Transform

Static setMatrixFromPositionRotationScale

setMatrixFromPositionRotationScale(matrix: Matrix4, position: Vector3, rotation: Euler, scale: Vector3): void

Parameters
- matrix: Matrix4
- position: Vector3
- rotation: Euler
- scale: Vector3
Returns void

Static setMatrixFromTransform

setMatrixFromTransform(matrix: Matrix4, transform: Transform): void

Sets the Matrix4 matrix from the provided transform.

Parameters
- matrix: Matrix4
  
  The matrix to set from the transform.
- transform: Transform
  
  The transform to set the matrix from.
Returns void

Static setPositionRotationScaleFromMatrix

setPositionRotationScaleFromMatrix(position: Vector3, rotation: Euler, scale: Vector3, matrix: Matrix4): void

Parameters
- position: Vector3
- rotation: Euler
- scale: Vector3
- matrix: Matrix4
Returns void

Static setTransformFromMatrix

setTransformFromMatrix(transform: Transform, matrix: Matrix4): void

Sets the transform from a Matrix4 matrix.

Parameters
- transform: Transform
  
  The transform to set from the matrix.
- matrix: Matrix4
  
  The matrix to set the transform from.
Returns void