API Docs for:
Show:

LS.Components.Transform Class

Defined in: ../src/components/transform.js:2
Module: LS

Transform that contains the position (vec3), rotation (quat) and scale (vec3) It uses lazy update to recompute the matrices.

Constructor

LS.Components.Transform

(
  • object
)

Defined in ../src/components/transform.js:2

Parameters:

  • object Object

    to configure from

Methods

applyTransform

()

Defined in ../src/components/transform.js:1293

Apply a transform to this transform

applyTransformMatrix

(
  • matrix
  • center
  • is_global
)

Defined in ../src/components/transform.js:1315

Applies the transformation using a matrix

Parameters:

  • matrix Mat4

    with the transform

  • center Vec3

    different pivot [optional] if omited 0,0,0 will be used

  • is_global Bool

    (optional) tells if the transformation should be applied in global space or local space

configure

(
  • object
)

Defined in ../src/components/transform.js:311

Configure from a serialized object

Parameters:

  • object Object

    with the serialized info

copyFrom

(
  • src
)

Defined in ../src/components/transform.js:301

Copy the transform from another Transform

Parameters:

  • src Transform

fromGlobalMatrix

(
  • matrix
)

Defined in ../src/components/transform.js:797

Configure the transform from a global Matrix (do not tested carefully)

Parameters:

  • matrix Mat4

    the matrix in array format

fromMatrix

(
  • matrix
  • is_global
)

Defined in ../src/components/transform.js:737

Configure the transform from a local Matrix (do not tested carefully)

Parameters:

  • matrix Mat4

    the matrix in array format

  • is_global Bool

    tells if the matrix is in global space [optional]

getAncestors

() Array

Defined in ../src/components/transform.js:613

Returns an array with all the ancestors

Returns:

Array:

getFront

() Vec3

Defined in ../src/components/transform.js:1183

returns the [0,0,-1] vector in global space

Returns:

Vec3:

getGlobalMatrix

(
  • out
  • fast
)
Mat4

Defined in ../src/components/transform.js:581

Returns a copy of the global matrix of this transform (it updates the matrix automatically)

Parameters:

  • out Mat4

    optional

  • fast Boolean

    this flags skips recomputing parents matrices

Returns:

Mat4:

the matrix in array format

getGlobalMatrix

() Mat4

Defined in ../src/components/transform.js:600

Returns a copy of the global matrix of this transform (it updates the matrix automatically)

Returns:

Mat4:

the matrix in array format

getGlobalPosition

(
  • out
)
Vec3

Defined in ../src/components/transform.js:437

Returns a copy of the global position

Parameters:

  • out Vec3

    [optional] where to store the result, otherwise one vec3 is created and returned

Returns:

Vec3:

the position

getGlobalRotation

() Quat

Defined in ../src/components/transform.js:627

Returns a quaternion with all parents rotations

Returns:

Quat:

Quaternion

getGlobalRotationMatrix

() Mat4

Defined in ../src/components/transform.js:682

Returns the global rotation in quaternion array (a copy)

Returns:

Mat4:

the rotation

getGlobalRotationMatrix

() Mat4

Defined in ../src/components/transform.js:648

Returns a Matrix with all parents rotations

Returns:

Mat4:

Matrix rotation

getGlobalScale

(
  • out
)
Vec3

Defined in ../src/components/transform.js:501

Returns a copy of the global scale (this is not correct, there is no global_scale factor, because due to rotations the axis could change)

Parameters:

  • out Vec3

    [optional] where to store the result, otherwise one vec3 is created and returned

Returns:

Vec3:

the scale

getGlobalTranslationMatrix

() Mat4

Defined in ../src/components/transform.js:671

Returns the local matrix of this transform without the rotation or scale

Returns:

Mat4:

the matrix in array format

getGlobalTranslationRotationMatrix

() Mat4

Defined in ../src/components/transform.js:705

Returns the local matrix of this transform without the scale

Returns:

Mat4:

the matrix in array format

getLocalMatrixRef

() Mat4

Defined in ../src/components/transform.js:568

Returns the original local matrix of this transform (it updates the matrix automatically)

Returns:

Mat4:

the matrix in array format

getMatrix

(
  • out
)
Mat4

Defined in ../src/components/transform.js:553

Returns a copy of the local matrix of this transform (it updates the matrix automatically)

Parameters:

  • out Mat4

    [optional] where to store the result, otherwise one mat4 is created and returned

Returns:

Mat4:

the matrix

getNormalMatrix

() Mat4

Defined in ../src/components/transform.js:719

Returns the matrix for the normals in the shader

Returns:

Mat4:

the matrix in array format

getPosition

(
  • out
)
Vec3

Defined in ../src/components/transform.js:424

Returns a copy of the local position

Parameters:

  • out Vec3

    [optional] where to store the result, otherwise one vec3 is created and returned

Returns:

Vec3:

the position

getRight

() Vec3

Defined in ../src/components/transform.js:1201

returns the [1,0,0] vector in global space

Returns:

Vec3:

getRotation

(
  • out
)
Quat

Defined in ../src/components/transform.js:451

Returns the rotation in quaternion array (a copy)

Parameters:

  • out Quat

    [optional] where to store the result, otherwise one quat is created and returned

Returns:

Quat:

the rotation

getRotation

(
  • out
)
Quat

Defined in ../src/components/transform.js:463

Returns the global rotation in quaternion array (a copy)

Parameters:

  • out Quat

    [optional] where to store the result, otherwise one quat is created and returned

Returns:

Quat:

the rotation

getScale

(
  • out
)
Vec3

Defined in ../src/components/transform.js:489

Returns the scale (its a copy)

Parameters:

  • out Vec3

    [optional] where to store the result, otherwise one vec3 is created and returned

Returns:

Vec3:

the scale

getTop

() Vec3

Defined in ../src/components/transform.js:1192

returns the [0,1,0] vector in global space

Returns:

Vec3:

globalToLocal

(
  • point
  • destination
)

Defined in ../src/components/transform.js:1247

convert from global coordinates to local coordinates

Parameters:

  • point Vec3
  • destination Vec3

    (optional)

identity

()

Defined in ../src/components/transform.js:370

Reset this transform

interpolate

(
  • a
  • b
  • factor
  • the
)

Defined in ../src/components/transform.js:1067

This method is static (call it from Transform.interpolate) interpolate the transform between two transforms and stores the result in another Transform

Parameters:

  • a Transform
  • b Transform
  • factor Number

    from 0 to 1

  • the Transform

    destination

localToGlobal

(
  • point
  • destination
)

Defined in ../src/components/transform.js:1225

convert from local coordinates to global coordinates If no destination is specified a new vector is created

Parameters:

  • point Vec3
  • destination Vec3

    (optional)

localVectorToGlobal

(
  • vector
  • destination
)

Defined in ../src/components/transform.js:1275

Applies the transformation to a vector (rotate but not translate)

Parameters:

  • vector Vec3
  • destination Vec3

    (optional)

lookAt

(
  • position
  • target
  • up
  • in_world
)

Defined in ../src/components/transform.js:1112

Orients the transform to look from one position to another

Parameters:

  • position Vec3
  • target Vec3
  • up Vec3
  • in_world Boolean

    tells if the values are in world coordinates (otherwise asume its in local coordinates)

orbit

(
  • angle_in_deg
  • axis
  • center
)

Defined in ../src/components/transform.js:1085

Orbits around a point

Parameters:

  • angle_in_deg Number
  • axis Vec3
  • center Vec3

    in local coordinates

resetPosition

()

Defined in ../src/components/transform.js:399

Sets the position to 0,0,0

resetRotation

()

Defined in ../src/components/transform.js:387

Sets the rotation to identity

resetScale

()

Defined in ../src/components/transform.js:411

Sets the scale to 1,1,1

rotate

(
  • angle_in_deg
  • axis
  • is_global
)

Defined in ../src/components/transform.js:952

rotate object in local space (axis is in local space)

Parameters:

  • angle_in_deg Number
  • axis Vec3
  • is_global Boolean

    tells if the axis is in global coordinates or local coordinates

rotateGlobal

(
  • angle_in_deg
  • axis
)

Defined in ../src/components/transform.js:1012

rotate object in global space (axis is in global space)

Parameters:

  • angle_in_deg Number
  • axis Vec3

rotateQuat

(
  • quaternion
)

Defined in ../src/components/transform.js:1026

rotate object in local space using a quat

Parameters:

  • quaternion Quat

rotateQuatGlobal

(
  • quaternion
)

Defined in ../src/components/transform.js:1038

rotate object in global space using a quat

Parameters:

  • quaternion Quat

rotateX

(
  • angle_in_rad
)

Defined in ../src/components/transform.js:975

rotate object in local space in local X axis

Parameters:

  • angle_in_rad Number

rotateY

(
  • angle_in_rad
)

Defined in ../src/components/transform.js:987

rotate object in local space in local Y axis

Parameters:

  • angle_in_rad Number

rotateZ

(
  • angle_in_rad
)

Defined in ../src/components/transform.js:999

rotate object in local space in local Z axis

Parameters:

  • angle_in_rad Number

scale

(
  • x
  • y
  • z
)

Defined in ../src/components/transform.js:1050

scale the object

Parameters:

  • x Number
  • y Number
  • z Number

serialize

() Object

Defined in ../src/components/transform.js:340

Serialize the object

Returns:

Object:

object with the serialized info

setPosition

(
  • x
  • y
  • z
)

Defined in ../src/components/transform.js:861

sets the position

Parameters:

  • x Number
  • y Number
  • z Number

setRotation

(
  • rotation
)

Defined in ../src/components/transform.js:878

sets the rotation from a quaternion or from an angle(rad) and axis

Parameters:

  • rotation Quat

    in quaterion format or angle

setRotationFromEuler

(
  • src,
)

Defined in ../src/components/transform.js:849

Configure the transform rotation from a vec3 Euler angles (heading,attitude,bank)

Parameters:

  • src, Mat4

    the matrix in array format

setScale

(
  • x
  • y
  • z
)

Defined in ../src/components/transform.js:893

sets the scale

Parameters:

  • x Number
  • y Number
  • z Number

transformPoint

(
  • point
  • destination
)

Defined in ../src/components/transform.js:1210

Multiplies a point by the local matrix (not global) If no destination is specified a new vector is created

Parameters:

  • point Vec3
  • destination Vec3

    (optional)

transformPointGlobal

(
  • point
  • destination
)

Defined in ../src/components/transform.js:1239

same as localToGlobal

Parameters:

  • point Vec3
  • destination Vec3

    (optional)

transformVector

(
  • vector
  • destination
)

Defined in ../src/components/transform.js:1265

Applies the transformation to a vector (rotate but not translate)

Parameters:

  • vector Vec3
  • destination Vec3

    (optional)

translate

(
  • x
  • y
  • z
)

Defined in ../src/components/transform.js:910

translates object in local coordinates (using the rotation and the scale)

Parameters:

  • x Number
  • y Number
  • z Number

translateGlobal

(
  • x
  • y
  • z
)

Defined in ../src/components/transform.js:935

translates object in local coordinates (adds to the position)

Parameters:

  • x Number
  • y Number
  • z Number

updateGlobalMatrix

(
  • fast
)

Defined in ../src/components/transform.js:538

updates the global matrix using the parents transformation

Parameters:

  • fast Bool

    it doesnt recompute parent matrices, just uses the stored one, is faster but could create errors if the parent doesnt have its global matrix update

updateMatrix

()

Defined in ../src/components/transform.js:524

update the local Matrix to match the position,scale and rotation

Properties

forward

Mat4

Defined in ../src/components/transform.js:247

The forward vector in global coordinates

globalMatrix

Mat4

Defined in ../src/components/transform.js:232

The matrix transform relative to world coordinates

matrix

Mat4

Defined in ../src/components/transform.js:164

The local matrix transform relative to its parent in mat4 format

mustUpdate

Boolean

Defined in ../src/components/transform.js:262

Force object to update matrices in case they were modified

position

Vec3

Defined in ../src/components/transform.js:82

The position relative to its parent in vec3 format

position

Vec3

Defined in ../src/components/transform.js:221

The position relative to its parent in vec3 format

rotation

Quat

Defined in ../src/components/transform.js:135

The orientation relative to its parent in quaternion format

scaling

Vec3

Defined in ../src/components/transform.js:148

The scaling relative to its parent in vec3 format (default is [1,1,1])

Events

changed

Defined in ../src/components/transform.js:1172

Fired when the node has changed its transform