Rest
...object: Object3D<Event>[]An arbitrary number of objects may be added
Adds a listener to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Copy the given object into this object
Optional
recursive: booleanIf true, descendants of the object are also copied. Default true
Note: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Searches through an object and its children, starting with the object itself, and returns the first with a matching name.
String to match to the children's Object3D.name property.
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
the property name to search for.
value of the given property.
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
The property name to search for.
Value of the given property.
Checks if listener is added to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Rotates the object to face a point in world space.
A vector representing a position in world space to look at.
Rotates the object to face a point in world space.
Expects a Float
Expects a Float
Expects a Float
Removes a listener from an event type.
The type of the listener that gets removed.
The listener function that gets removed.
Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.
A normalized vector in object space.
Angle in radians. Expects a Float
Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.
Euler angle specifying rotation amount.
Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.
Rotate the quaternion by the rotation component of the matrix.
Copy the given THREE.Quaternion | Quaternion into .quaternion.
Normalized Quaternion.
Convert the object to three.js JSON Object/Scene format.
Optional
meta: { Object containing metadata such as materials, textures or images for the object.
Updates the global transform of the object.
And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true
.
Optional
force: booleanA boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true
.
Updates the morphTargets to have no influence on the object
Resets the morphTargetInfluences and morphTargetDictionary properties.
Array with object's animation clips.
Whether the object gets rendered into shadow map.
Array with object's children.
Optional
customCustom depth material to be used when rendering to the depth map.
Optional
customSame as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.
When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
If set to false
the object gets rendered every frame even if it is not in the frustum of the camera.
An instance of THREE.BufferGeometry | BufferGeometry (or derived classes), defining the object's structure.
Readonly
idUnique number for this Object3D instance.
Readonly
isRead-only flag to check if a given object is of type Mesh.
Readonly
isFlag to check if a given object is of type Object3D.
The layer membership of the object.
An instance of material derived from the THREE.Material | Material base class or an array of materials, defining the object's appearance.
The local transform matrix.
When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.
DEFAULT_MATRIX_AUTO_UPDATE - that is (true)
.
The global transform of the object.
If the Object3D has no parent, then it's identical to the local transform .matrix.
new THREE.Matrix4()
If set, then the renderer checks every frame if the object and its children need matrix updates. When it isn't, then you have to maintain all matrices in the object and its children yourself.
DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true)
.
When this is set, it calculates the matrixWorld in that frame and resets this property to false.
Readonly
modelOptional
morphA dictionary of morphTargets based on the morphTarget.name
property.
undefined
, but rebuilt by .updateMorphTargets().
Optional
morphAn array of weights typically from 0-1
that specify how much of the morph is applied.
undefined
, but reset to a blank array by .updateMorphTargets().
Optional name of the object
Readonly
normalAn optional callback that is executed immediately after a 3D object is rendered.
An optional callback that is executed immediately before a 3D object is rendered.
Object's parent in the scene graph.
Readonly
positionObject's local position.
Readonly
quaternionObject's local rotation as a THREE.Quaternion | Quaternion.
Whether the material receives shadows.
This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently.
Readonly
rotationObject's local rotation (Euler angles), in radians.
Readonly
scaleThe object's local scale.
Readonly
typeThis is used by the lookAt method, for example, to determine the orientation of the result.
Object3D.DEFAULT_UP - that is (0, 1, 0)
.
An object that can be used to store custom data about the Object3D.
UUID of this object instance.
Object gets rendered if true
.
Static
DEFAULT_The default setting for matrixAutoUpdate for newly created Object3Ds.
Static
DEFAULT_The default setting for matrixWorldAutoUpdate for newly created Object3Ds.
Static
DEFAULT_The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight, THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).
Adds another Object3D as child of this Object3D.