Object

Object 

Scene graph object

Node in the scene graph or “entity”. Consists of transformation and a reference to its parent object. Usually holds components and is accessible by components through object.

Objects are stored in a data oriented manner inside WebAssembly memory. This class is a JavaScript API wrapper around this memory for more convenient use in components.

Objects can be created and added to a scene through addObject on the main scene.

Kind: global class

• Object
  • new Object(o)
  • .name ⇒ string
  • .name
  • .parent ⇒ Object
  • .children ⇒ Array.<Object>
  • .parent
  • .transformLocal ⇒ Float32Array
  • .transformLocal
  • .transformWorld ⇒ Float32Array
  • .transformWorld
  • .scalingLocal ⇒ Float32Array
  • .scalingLocal
  • .scalingWorld ⇒ Float32Array
  • .scalingWorld
  • .rotationLocal ⇒ Array.<number>
  • .rotationWorld ⇒ Array.<number>
  • .rotationLocal
  • .rotationWorld
  • .active
  • .changed ⇒ boolean
  • .resetTransform()
  • .resetTranslationRotation()
  • .resetRotation()
  • .resetTranslation()
  • .resetScaling()
  • .translate(v)
  • .translateObject(v)
  • .translateWorld(v)
  • .rotateAxisAngleDeg(a, d)
  • .rotateAxisAngleRad(a, d)
  • .rotateAxisAngleDegObject(a, d)
  • .rotateAxisAngleRadObject(a, d)
  • .rotate(q)
  • .rotateObject(q)
  • .scale(v)
  • .getTranslationLocal(out) ⇒ Array.<number>
  • .getTranslationWorld(out) ⇒ Array.<number>
  • .setTranslationLocal(v)
  • .setTranslationWorld(v)
  • .getForward(out) ⇒ Array.<number>
  • .getUp(out) ⇒ Array.<number>
  • .getRight(out) ⇒ Array.<number>
  • .transformVectorWorld(out, v) ⇒ Array.<number>
  • .transformVectorLocal(out, v) ⇒ Array.<number>
  • .transformPointWorld(out, v) ⇒ Array.<number>
  • .transformPointLocal(out, v) ⇒ Array.<number>
  • .transformVectorInverseWorld(out, v) ⇒ Array.<number>
  • .transformVectorInverseLocal(out, v) ⇒ Array.<number>
  • .transformPointInverseWorld(out, v) ⇒ Array.<number>
  • .transformPointInverseLocal(out, p) ⇒ Array.<number>
  • .toWorldSpaceTransform(out, q) ⇒ Array.<number>
  • .toLocalSpaceTransform(out, q) ⇒ Array.<number>
  • .toObjectSpaceTransform(out, q) ⇒ Array.<number>
  • .lookAt(v, up)
  • .destroy()
  • .setDirty()
  • .getComponent(typeOrClass, index) ⇒ Component | CollisionComponent | TextComponent | ViewComponent | MeshComponent | InputComponent | LightComponent | AnimationComponent | PhysXComponent
  • .getComponents(typeOrClass) ⇒ Array.<Component>
  • .addComponent(typeOrClass, [params]) ⇒ Component | CollisionComponent | TextComponent | ViewComponent | MeshComponent | InputComponent | LightComponent | AnimationComponent | PhysXComponent
  • .equals(otherObject) ⇒ boolean

new Object (o) 

.name ⇒ string 

Useful for identifying objects during debugging.

Kind: instance property of Object
Returns: string - Name of the object

.name 

Set the object’s name

Kind: instance property of Object

.parent ⇒ Object 

Kind: instance property of Object
Returns: Object - Parent of this object or null if parented to root

.children ⇒ Array.<Object> 

Kind: instance property of Object
Returns: Array.<Object> - Children of this object

.parent 

Reparent object to given object.

Kind: instance property of Object
Note: Reparenting is not trivial and might have a noticeable performance impact

.transformLocal ⇒ Float32Array 

Kind: instance property of Object
Returns: Float32Array - Local / object space transformation

.transformLocal 

Set local transform.

Kind: instance property of Object
0.8.5+

.transformWorld ⇒ Float32Array 

May recompute transformations of the hierarchy of this object, if they were changed by JavaScript components this frame.

Kind: instance property of Object
Returns: Float32Array - Global / world space transformation

.transformWorld 

Set world transform.

Kind: instance property of Object
0.8.5+

.scalingLocal ⇒ Float32Array 

Kind: instance property of Object
Returns: Float32Array - Local / object space scaling

.scalingLocal 

Set scaling local

Kind: instance property of Object
0.8.7+

.scalingWorld ⇒ Float32Array 

Kind: instance property of Object
Returns: Float32Array - Global / world space scaling May recompute transformations of the hierarchy of this object, if they were changed by JavaScript components this frame.

.scalingWorld 

Set scaling world

Kind: instance property of Object
0.8.7+

.rotationLocal ⇒ Array.<number> 

Kind: instance property of Object
Returns: Array.<number> - Local space rotation
0.8.7+

.rotationWorld ⇒ Array.<number> 

Kind: instance property of Object
Returns: Array.<number> - Global / world space rotation
0.8.7+

.rotationLocal 

Set rotation local

Kind: instance property of Object
0.8.7+

.rotationWorld 

Set rotation world

Kind: instance property of Object
0.8.7+

.active 

Disable/enable all components of this object

Kind: instance property of Object
0.8.5+

.changed ⇒ boolean 

Kind: instance property of Object
Returns: boolean - Whether given object’s transformation has changed.

.resetTransform () 

Reset local transformation (translation, rotation and scaling) to identity

Kind: instance method of Object

.resetTranslationRotation () 

Reset local translation and rotation to identity

Kind: instance method of Object

.resetRotation () 

Reset local rotation, keep translation.

Kind: instance method of Object
Note: To reset both rotation and translation, prefer resetTranslationRotation.

.resetTranslation () 

Reset local translation, keep rotation.

Kind: instance method of Object
Note: To reset both rotation and translation, prefer resetTranslationRotation.

.resetScaling () 

Reset local scaling to identity ([1.0, 1.0, 1.0])

Kind: instance method of Object

.translate (v) 

Translate object by a vector in the parent’s space

Kind: instance method of Object

.translateObject (v) 

Translate object by a vector in object space

Kind: instance method of Object

.translateWorld (v) 

Translate object by a vector in world space

Kind: instance method of Object

.rotateAxisAngleDeg (a, d) 

Rotate around given axis by given angle (degrees) in local space

Kind: instance method of Object
Note: If the object is translated the rotation will be around the parent. To rotate around the object origin, use rotateAxisAngleDegObject
See: rotateAxisAngleRad

.rotateAxisAngleRad (a, d) 

Rotate around given axis by given angle (radians) in local space

Kind: instance method of Object
Note: If the object is translated the rotation will be around the parent. To rotate around the object origin, use rotateAxisAngleDegObject
See: rotateAxisAngleDeg

.rotateAxisAngleDegObject (a, d) 

Rotate around given axis by given angle (degrees) in object space

Kind: instance method of Object
See: rotateAxisAngleRadObject

.rotateAxisAngleRadObject (a, d) 

Rotate around given axis by given angle (radians) in object space Equivalent to prepending a rotation quaternion to the object’s local transformation.

Kind: instance method of Object
See: rotateAxisAngleDegObject

.rotate (q) 

Rotate by a quaternion

Kind: instance method of Object

.rotateObject (q) 

Rotate by a quaternion in object space

Equivalent to prepending a rotation quaternion to the object’s local transformation.

Kind: instance method of Object

.scale (v) 

Scale object by a vector in object space

Kind: instance method of Object

.getTranslationLocal (out) ⇒ Array.<number> 

Compute local / object space translation from transformation

Kind: instance method of Object
Returns: Array.<number> - out

.getTranslationWorld (out) ⇒ Array.<number> 

Compute local / object space translation from transformation

May recompute transformations of the hierarchy of this object, if they were changed by JavaScript components this frame.

Kind: instance method of Object
Returns: Array.<number> - out

.setTranslationLocal (v) 

Set local / object space translation

Concatenates a new translation dual quaternion onto the existing rotation.

Kind: instance method of Object

.setTranslationWorld (v) 

Set world space translation

Applies the inverse parent transform with a new translation dual quaternion which is concatenated onto the existing rotation.

Kind: instance method of Object

.getForward (out) ⇒ Array.<number> 

Compute the object’s forward facing world space vector

Kind: instance method of Object
Returns: Array.<number> - out

.getUp (out) ⇒ Array.<number> 

Compute the object’s up facing world space vector

Kind: instance method of Object
Returns: Array.<number> - out

.getRight (out) ⇒ Array.<number> 

Compute the object’s right facing world space vector

Kind: instance method of Object
Returns: Array.<number> - out

.transformVectorWorld (out, v) ⇒ Array.<number> 

Transform a vector by this object’s world transform

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.transformVectorLocal (out, v) ⇒ Array.<number> 

Transform a vector by this object’s local transform

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.transformPointWorld (out, v) ⇒ Array.<number> 

Transform a point by this object’s world transform

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.transformPointLocal (out, v) ⇒ Array.<number> 

Transform a point by this object’s local transform

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.transformVectorInverseWorld (out, v) ⇒ Array.<number> 

Transform a vector by this object’s inverse world transform

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.transformVectorInverseLocal (out, v) ⇒ Array.<number> 

Transform a point by this object’s inverse local transform

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.transformPointInverseWorld (out, v) ⇒ Array.<number> 

Transform a point by this object’s inverse world transform

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.transformPointInverseLocal (out, p) ⇒ Array.<number> 

Transform a point by this object’s inverse local transform

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.toWorldSpaceTransform (out, q) ⇒ Array.<number> 

Transform a object space dual quaternion into world space

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.toLocalSpaceTransform (out, q) ⇒ Array.<number> 

Transform a world space dual quaternion into local space

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.toObjectSpaceTransform (out, q) ⇒ Array.<number> 

Transform a world space dual quaternion into object space

Kind: instance method of Object
Returns: Array.<number> - out
0.8.7+

.lookAt (v, up) 

Turn towards / look at target

Kind: instance method of Object

.destroy () 

Destroy the object with all of its components and remove it from the scene

Kind: instance method of Object

.setDirty () 

Mark transformation dirty

Causes an eventual recalculation of transformWorld, either on next getTranslationWorld, transformWorld or scalingWorld or the beginning of next frame, whichever happens first.

Kind: instance method of Object

.getComponent (typeOrClass, index) ⇒ Component | CollisionComponent | TextComponent | ViewComponent | MeshComponent | InputComponent | LightComponent | AnimationComponent | PhysXComponent 

Get a component attached to this object

Kind: instance method of Object
Returns: Component | CollisionComponent | TextComponent | ViewComponent | MeshComponent | InputComponent | LightComponent | AnimationComponent | PhysXComponent - The component or null if there is no such component on this object

.getComponents (typeOrClass) ⇒ Array.<Component> 

Kind: instance method of Object
Returns: Array.<Component> - All components of given type attached to this object
Note: As this function is non-trivial, avoid using it in update() repeatedly, but rather store its result in init() or start()
Warning: This method will currently return at most 341 components.

.addComponent (typeOrClass, [params]) ⇒ Component | CollisionComponent | TextComponent | ViewComponent | MeshComponent | InputComponent | LightComponent | AnimationComponent | PhysXComponent 

Add component of given type to the object

You can use this function to clone components, see the example below.

Kind: instance method of Object
Returns: Component | CollisionComponent | TextComponent | ViewComponent | MeshComponent | InputComponent | LightComponent | AnimationComponent | PhysXComponent - The component or null if the type was not found

Example

1
2
3
4
5
6
7
8

// Clone existing component (since 0.8.10)
 let original = this.object.getComponent('mesh');
 otherObject.addComponent('mesh', original);
 // Create component from parameters
 this.object.addComponent('mesh', {
     mesh: someMesh,
     material: someMaterial,
 });

.equals (otherObject) ⇒ boolean 

Checks equality by comparing whether the wrapped native component ids and component manager types are equal.

Kind: instance method of Object
Returns: boolean - Whether this object equals the given object