Object3D

java.lang.Object
- thothbot.parallax.core.shared.core.Object3D

Direct Known Subclasses:

ArrowHelper, AxisHelper, Bone, Camera, CubeCamera, GeometryObject, Group, Gyroscope, LensFlare, Light, LOD, Scene
```
public class Object3D
extends java.lang.Object
```
Base class for scene objects.

Author:

thothbot

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Object3D.ObjectHandler

static interface Object3D.Traverse

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Object3D.ObjectHandler`
`static interface`	`Object3D.Traverse`

Field Summary

Fields
Modifier and Type Field and Description

boolean __webglActive

boolean __webglInit

Matrix4 _modelViewMatrix

Matrix3 _normalMatrix

static Vector3 DefaultUp

Fields
Modifier and Type	Field and Description
`boolean`	`__webglActive`
`boolean`	`__webglInit`
`Matrix4`	`_modelViewMatrix`
`Matrix3`	`_normalMatrix`
`static Vector3`	`DefaultUp`

Constructor Summary

Constructors
Constructor and Description

Object3D()

Constructors
Constructor and Description
`Object3D()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object3D`	`add(java.util.List<? extends Object3D> objects)`
`Object3D`	`add(Object3D object)` Adds object as child of this object.
`void`	`applyMatrix(Matrix4 matrix)` This updates the position, rotation and scale with the matrix.
`Object3D`	`clone()` Creates a new clone of this object and all descendants.
`Object3D`	`clone(Object3D object)`
`Object3D`	`clone(Object3D object, boolean recursive)`
`java.util.List<Object3D>`	`getChildren()` Array with object's children.
`java.util.List<? extends Object3D>`	`getChildrenByClass(java.lang.Class<?> clazz, boolean recursive)`
`int`	`getId()` Unique number for this object instance.
`Matrix4`	`getMatrix()` Local transform.
`Matrix4`	`getMatrixWorld()` The global transform of the object.
`java.lang.String`	`getName()` Optional name of the object (doesn't need to be unique).
`Object3D`	`getObjectById(int id, boolean recursive)` Searches through the object's children and returns the first with a matching id, optionally recursive.
`Object3D`	`getObjectByName(java.lang.String name, boolean recursive)` Searches through the object's children and returns the first with a matching name, optionally recursive.
`Object3D`	`getParent()` Object's parent in the scene graph.
`Vector3`	`getPosition()` Object's local position.
`Quaternion`	`getQuaternion()` Object's local rotation as `Quaternion`.
`double`	`getRenderDepth()`
`Euler`	`getRotation()` Object's local rotation (`Euler` angles), in radians.
`Vector3`	`getScale()` Object's local scale.
`Vector3`	`getUp()` Up direction.
`Vector3`	`getWorldDirection()`
`Vector3`	`getWorldDirection(Vector3 optionalTarget)`
`Vector3`	`getWorldPosition()`
`Vector3`	`getWorldPosition(Vector3 optionalTarget)`
`Quaternion`	`getWorldQuaternion(Quaternion optionalTarget)`
`Quaternion`	`getWorldQuaternion(Vector3 optionalTarget)`
`Euler`	`getWorldRotation()`
`Euler`	`getWorldRotation(Euler optionalTarget)`
`Vector3`	`getWorldScale()`
`Vector3`	`getWorldScale(Vector3 optionalTarget)`
`boolean`	`isCastShadow()` If set to true light will cast dynamic shadows.
`boolean`	`isFrustumCulled()` When this is set, it checks every frame if the object is in the frustum of the camera.
`boolean`	`isMatrixAutoUpdate()` When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property. default – true
`boolean`	`isMatrixWorldNeedsUpdate()` When this is set, it calculates the matrixWorld in that frame and resets this property to false. default – false
`boolean`	`isReceiveShadow()` Material gets baked in shadow receiving. default – false
`boolean`	`isRotationAutoUpdate()` When this is set, then the rotationMatrix gets calculated every frame. default – true
`boolean`	`isVisible()` Object gets rendered if true. default – true
`Vector3`	`localToWorld(Vector3 vector)`
`void`	`lookAt(Vector3 vector)` Rotates object to face point in space.
`void`	`remove(java.util.List<? extends Object3D> objects)`
`void`	`remove(Object3D object)` Removes object as child of this object.
`Object3D`	`rotateOnAxis(Vector3 axis, double angle)` Rotate an object along an axis in object space.
`Object3D`	`rotateX(double angle)`
`Object3D`	`rotateY(double angle)`
`Object3D`	`rotateZ(double angle)`
`void`	`setCastShadow(boolean isCastShadow)`
`void`	`setChildren(java.util.Collection<? extends Object3D> children)`
`void`	`setFrustumCulled(boolean isFrustumCulled)`
`void`	`setHandler(Object3D.ObjectHandler handler)`
`void`	`setMatrix(Matrix4 matrix)`
`void`	`setMatrixAutoUpdate(boolean autoUpdate)`
`void`	`setMatrixWorld(Matrix4 matrixWorld)`
`void`	`setMatrixWorldNeedsUpdate(boolean needsUpdate)`
`void`	`setName(java.lang.String name)`
`void`	`setParent(Object3D parent)`
`void`	`setPosition(Vector3 position)`
`void`	`setQuaternion(Quaternion quaternion)`
`void`	`setReceiveShadow(boolean isReceiveShadow)`
`void`	`setRenderDepth(double renderDepth)`
`void`	`setRotation(Euler rotation)`
`void`	`setRotationAutoUpdate(boolean rotationAutoUpdate)`
`void`	`setRotationFromAxisAngle(Vector3 axis, double angle)`
`void`	`setRotationFromEuler(Euler euler)`
`void`	`setRotationFromMatrix(Matrix4 m)`
`void`	`setRotationFromQuaternion(Quaternion q)`
`void`	`setScale(Vector3 scale)`
`void`	`setUp(Vector3 up)`
`void`	`setVisible(boolean visible)`
`java.lang.String`	`toString()`
`Object3D`	`translateOnAxis(Vector3 axis, double distance)` Translate an object by distance along an axis in object space.
`Object3D`	`translateX(double distance)` Translates object along x axis by distance.
`Object3D`	`translateY(double distance)` Translates object along y axis by distance.
`Object3D`	`translateZ(double distance)` Translates object along z axis by distance.
`void`	`traverse(Object3D.Traverse traverse)` Executes the callback on this object and all descendants
`void`	`traverseVisible(Object3D.Traverse traverse)` Like `traverse(Traverse)`, but the `Object3D.Traverse` will only be executed for visible objects.
`void`	`updateMatrix()` Updates local transform.
`void`	`updateMatrixWorld(boolean force)` Updates global transform of the object and its children.
`Vector3`	`worldToLocal(Vector3 vector)` Updates the vector from world space to local space.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DefaultUp
```
public static final Vector3 DefaultUp
```
  - _normalMatrix
```
public Matrix3 _normalMatrix
```
  - _modelViewMatrix
```
public Matrix4 _modelViewMatrix
```
  - __webglActive
```
public boolean __webglActive
```
  - __webglInit
```
public boolean __webglInit
```
- Constructor Detail
  - Object3D
```
public Object3D()
```
- Method Detail
  - setHandler
```
public void setHandler(Object3D.ObjectHandler handler)
```
  - getId
```
public int getId()
```
    Unique number for this object instance.
    
    Returns:
  - getParent
```
public Object3D getParent()
```
    Object's parent in the scene graph.
    
    Returns:
  - setParent
```
public void setParent(Object3D parent)
```
  - getChildren
```
public java.util.List<Object3D> getChildren()
```
    Array with object's children.
    
    Returns:
  - setChildren
```
public void setChildren(java.util.Collection<? extends Object3D> children)
```
  - getChildrenByClass
```
public java.util.List<? extends Object3D> getChildrenByClass(java.lang.Class<?> clazz,
                                                             boolean recursive)
```
  - getPosition
```
public Vector3 getPosition()
```
    Object's local position.
    
    Returns:
  - setPosition
```
public void setPosition(Vector3 position)
```
  - getRotation
```
public Euler getRotation()
```
    Object's local rotation (Euler angles), in radians.
    
    Returns:
  - setRotation
```
public void setRotation(Euler rotation)
```
  - isCastShadow
```
public boolean isCastShadow()
```
    If set to true light will cast dynamic shadows.
    Default � false.
  - setCastShadow
```
public void setCastShadow(boolean isCastShadow)
```
  - isReceiveShadow
```
public boolean isReceiveShadow()
```
    Material gets baked in shadow receiving. default – false
    
    Returns:
  - setReceiveShadow
```
public void setReceiveShadow(boolean isReceiveShadow)
```
  - isFrustumCulled
```
public boolean isFrustumCulled()
```
    When this is set, it checks every frame if the object is in the frustum of the camera. Otherwise the object gets drawn every frame even if it isn't visible. default – true
    
    Returns:
  - setFrustumCulled
```
public void setFrustumCulled(boolean isFrustumCulled)
```
  - setRotationAutoUpdate
```
public void setRotationAutoUpdate(boolean rotationAutoUpdate)
```
  - isRotationAutoUpdate
```
public boolean isRotationAutoUpdate()
```
    When this is set, then the rotationMatrix gets calculated every frame. default – true
    
    Returns:
  - setName
```
public void setName(java.lang.String name)
```
  - getName
```
public java.lang.String getName()
```
    Optional name of the object (doesn't need to be unique).
    
    Returns:
  - getScale
```
public Vector3 getScale()
```
    Object's local scale.
    
    Returns:
  - setScale
```
public void setScale(Vector3 scale)
```
  - getRenderDepth
```
public double getRenderDepth()
```
    Returns:
    
    the renderDepth
  - setRenderDepth
```
public void setRenderDepth(double renderDepth)
```
    Parameters:
    
    renderDepth - the renderDepth to set
  - getUp
```
public Vector3 getUp()
```
    Up direction.
    
    Returns:
  - setUp
```
public void setUp(Vector3 up)
```
  - getMatrix
```
public Matrix4 getMatrix()
```
    Local transform.
    
    Returns:
  - setMatrix
```
public void setMatrix(Matrix4 matrix)
```
  - getMatrixWorld
```
public Matrix4 getMatrixWorld()
```
    The global transform of the object. If the Object3d has no parent, then it's identical to the local transform.
    
    Returns:
  - setMatrixWorld
```
public void setMatrixWorld(Matrix4 matrixWorld)
```
  - isMatrixWorldNeedsUpdate
```
public boolean isMatrixWorldNeedsUpdate()
```
    When this is set, it calculates the matrixWorld in that frame and resets this property to false. default – false
    
    Returns:
  - setMatrixWorldNeedsUpdate
```
public void setMatrixWorldNeedsUpdate(boolean needsUpdate)
```
  - isMatrixAutoUpdate
```
public boolean isMatrixAutoUpdate()
```
    When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property. default – true
    
    Returns:
  - setMatrixAutoUpdate
```
public void setMatrixAutoUpdate(boolean autoUpdate)
```
  - getQuaternion
```
public Quaternion getQuaternion()
```
    Object's local rotation as Quaternion.
    
    Returns:
  - setQuaternion
```
public void setQuaternion(Quaternion quaternion)
```
  - isVisible
```
public boolean isVisible()
```
    Object gets rendered if true. default – true
    
    Returns:
  - setVisible
```
public void setVisible(boolean visible)
```
  - applyMatrix
```
public void applyMatrix(Matrix4 matrix)
```
    This updates the position, rotation and scale with the matrix.
    
    Parameters:
    
    matrix -
  - setRotationFromAxisAngle
```
public void setRotationFromAxisAngle(Vector3 axis,
                                     double angle)
```
  - setRotationFromEuler
```
public void setRotationFromEuler(Euler euler)
```
  - setRotationFromMatrix
```
public void setRotationFromMatrix(Matrix4 m)
```
  - setRotationFromQuaternion
```
public void setRotationFromQuaternion(Quaternion q)
```
  - rotateOnAxis
```
public Object3D rotateOnAxis(Vector3 axis,
                             double angle)
```
    Rotate an object along an axis in object space. The axis is assumed to be normalized.
    
    Parameters:
    
    axis - A normalized vector in object space.
    
    angle - The angle in radians.
    
    Returns:
  - rotateX
```
public Object3D rotateX(double angle)
```
  - rotateY
```
public Object3D rotateY(double angle)
```
  - rotateZ
```
public Object3D rotateZ(double angle)
```
  - translateOnAxis
```
public Object3D translateOnAxis(Vector3 axis,
                                double distance)
```
    Translate an object by distance along an axis in object space. The axis is assumed to be normalized.
    
    Parameters:
    
    axis - A normalized vector in object space.
    
    distance - The distance to translate.
    
    Returns:
  - translateX
```
public Object3D translateX(double distance)
```
    Translates object along x axis by distance.
    
    Parameters:
    
    distance -
    
    Returns:
  - translateY
```
public Object3D translateY(double distance)
```
    Translates object along y axis by distance.
    
    Parameters:
    
    distance -
    
    Returns:
  - translateZ
```
public Object3D translateZ(double distance)
```
    Translates object along z axis by distance.
    
    Parameters:
    
    distance -
    
    Returns:
  - localToWorld
```
public Vector3 localToWorld(Vector3 vector)
```
  - worldToLocal
```
public Vector3 worldToLocal(Vector3 vector)
```
    Updates the vector from world space to local space.
    
    Parameters:
    
    vector - A world vector.
    
    Returns:
  - lookAt
```
public void lookAt(Vector3 vector)
```
    Rotates object to face point in space.
    
    Parameters:
    
    vector - A world vector to look at.
  - add
```
public Object3D add(java.util.List<? extends Object3D> objects)
```
  - add
```
public Object3D add(Object3D object)
```
    Adds object as child of this object.
    
    Parameters:
    
    object - An object
    
    Returns:
  - remove
```
public void remove(java.util.List<? extends Object3D> objects)
```
  - remove
```
public void remove(Object3D object)
```
    Removes object as child of this object.
    
    Parameters:
    
    object - An object.
  - getObjectById
```
public Object3D getObjectById(int id,
                              boolean recursive)
```
    Searches through the object's children and returns the first with a matching id, optionally recursive.
    
    Parameters:
    
    id - Unique number of the object instance
    
    recursive - Boolean whether to search through the children's children.
    
    Returns:
  - getObjectByName
```
public Object3D getObjectByName(java.lang.String name,
                                boolean recursive)
```
    Searches through the object's children and returns the first with a matching name, optionally recursive.
    
    Parameters:
    
    name - String to match to the children's Object3d.name property.
    
    recursive - Boolean whether to search through the children's children.
    
    Returns:
  - getWorldPosition
```
public Vector3 getWorldPosition()
```
  - getWorldPosition
```
public Vector3 getWorldPosition(Vector3 optionalTarget)
```
  - getWorldQuaternion
```
public Quaternion getWorldQuaternion(Vector3 optionalTarget)
```
  - getWorldQuaternion
```
public Quaternion getWorldQuaternion(Quaternion optionalTarget)
```
  - getWorldRotation
```
public Euler getWorldRotation()
```
  - getWorldRotation
```
public Euler getWorldRotation(Euler optionalTarget)
```
  - getWorldScale
```
public Vector3 getWorldScale()
```
  - getWorldScale
```
public Vector3 getWorldScale(Vector3 optionalTarget)
```
  - getWorldDirection
```
public Vector3 getWorldDirection()
```
  - getWorldDirection
```
public Vector3 getWorldDirection(Vector3 optionalTarget)
```
  - traverse
```
public void traverse(Object3D.Traverse traverse)
```
    Executes the callback on this object and all descendants
    
    Parameters:
    
    traverse - A Object3D.Traverse interface with as first argument an object3D object.
  - traverseVisible
```
public void traverseVisible(Object3D.Traverse traverse)
```
    Like traverse(Traverse), but the Object3D.Traverse will only be executed for visible objects. Descendants of invisible objects are not traversed.
    
    Parameters:
    
    traverse - A Object3D.Traverse interface with as first argument an object3D object.
  - updateMatrix
```
public void updateMatrix()
```
    Updates local transform.
  - updateMatrixWorld
```
public void updateMatrixWorld(boolean force)
```
    Updates global transform of the object and its children.
    
    Parameters:
    
    force -
  - clone
```
public Object3D clone()
```
    Creates a new clone of this object and all descendants.
    
    Overrides:
    
    clone in class java.lang.Object
  - clone
```
public Object3D clone(Object3D object)
```
  - clone
```
public Object3D clone(Object3D object,
                      boolean recursive)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Object3D

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DefaultUp

_normalMatrix

_modelViewMatrix

__webglActive

__webglInit

Constructor Detail

Object3D

Method Detail

setHandler

getId

getParent

setParent

getChildren

setChildren

getChildrenByClass

getPosition

setPosition

getRotation

setRotation

isCastShadow

setCastShadow

isReceiveShadow

setReceiveShadow

isFrustumCulled

setFrustumCulled

setRotationAutoUpdate

isRotationAutoUpdate

setName

getName

getScale

setScale

getRenderDepth

setRenderDepth

getUp

setUp

getMatrix

setMatrix

getMatrixWorld

setMatrixWorld

isMatrixWorldNeedsUpdate

setMatrixWorldNeedsUpdate

isMatrixAutoUpdate

setMatrixAutoUpdate

getQuaternion

setQuaternion

isVisible

setVisible

applyMatrix

setRotationFromAxisAngle

setRotationFromEuler

setRotationFromMatrix

setRotationFromQuaternion

rotateOnAxis

rotateX

rotateY

rotateZ

translateOnAxis

translateX

translateY

translateZ

localToWorld

worldToLocal

lookAt

add

add

remove

remove

getObjectById

getObjectByName

getWorldPosition

getWorldPosition

getWorldQuaternion

getWorldQuaternion