Private _binds[]
Whether the object gets rendered into shadow map.
false
Array with object's children.
THREE.Object3DGroup | Group for info on manually grouping objects.
[]
Optional customCustom depth material to be used when rendering to the depth map.
Can only be used in context of meshes. When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight, if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.
undefined
Optional customSame as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.
undefined
Name of this expression.
Distinguished with name since name will be conflicted with Object3D.
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.
true
Readonly idUnique number for this Object3D instance.
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
Expects a Integer
Interpret values greater than 0.5 as 1.0, ortherwise 0.0.
Readonly isFlag to check if a given object is of type Object3D.
This is a constant value
true
The layer membership of the object.
The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use. This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.
new THREE.Layers()
The local transform matrix.
new THREE.Matrix4()
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 THREE.Object3D.matrix | .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.
false
Readonly modelnew THREE.Matrix4()
Optional name of the object
(doesn't need to be unique).
""
Readonly normalnew THREE.Matrix3()
Specify how the expression overrides blink expressions.
Specify how the expression overrides lookAt expressions.
Specify how the expression overrides mouth expressions.
Object's parent in the scene graph.
An object can have at most one parent.
null
Readonly positionObject's local position.
new THREE.Vector3() - that is (0, 0, 0).
Readonly quaternionObject's local rotation as a THREE.Quaternion | Quaternion.
new THREE.Quaternion() - that is (0, 0, 0, 1).
Whether the material receives shadows.
false
This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently.
When this property is set for an instance of Group | Group, all descendants objects will be sorted and rendered together. Sorting is from lowest to highest renderOrder.
0
Readonly rotationObject's local rotation (Euler angles), in radians.
new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).
Readonly scaleThe object's local scale.
new THREE.Vector3( 1, 1, 1 )
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.
It should not hold references to functions as these will not be cloned.
{}
UUID of this object instance.
This gets automatically assigned and shouldn't be edited.
Object gets rendered if true.
true
The current weight of the expression.
Static DEFAULT_The default setting for matrixAutoUpdate for newly created Object3Ds.
true
Static DEFAULT_The default setting for matrixWorldAutoUpdate for newly created Object3Ds.
true
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).
new THREE.Vector3( 0, 1, 0)
A value represents how much it should override blink expressions.
0.0 == no override at all, 1.0 == completely block the expressions.
A value represents how much it should override lookAt expressions.
0.0 == no override at all, 1.0 == completely block the expressions.
A value represents how much it should override mouth expressions.
0.0 == no override at all, 1.0 == completely block the expressions.
Adds another Object3D as child of this Object3D.
Rest ...object: Object3D<Object3DEventMap>[]An arbitrary number of objects may be added Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.
Adds a listener to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Apply weight to every assigned blend shapes. Should be called every frame.
Optional options: { Optional multiplier?: numberMultiplies a value to its weight to apply. Intended to be used for overriding an expression weight by another expression. See also: overrideBlink, overrideLookAt, overrideMouth
Copies the given object into this object.
Optional recursive: booleanIf set to true, descendants of the object are copied next to the existing ones. If set to
false, descendants are left unchanged. Default is true.
Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Fire an event type.
Searches through an object and its children, starting with the object itself, and returns the first with a matching id.
Unique number of the object instance. Expects a Integer
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
id
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.
Note that for most objects the name is an empty string by default You will have to set it manually to make use of this method.
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.
Optional optionalTarget: Object3D<Object3DEventMap>[]target to set the result. Otherwise a new Array is instantiated. If set, you must clear this array prior to each call (i.e., array.length = 0;).
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.
This method does not support objects having non-uniformly-scaled parent(s).
Rotates the object to face a point in world space.
Expects a Float
Expects a Float
Expects a Float
This method does not support objects having non-uniformly-scaled parent(s).
An optional callback that is executed immediately after a 3D object is rendered.
This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
define their visual appearance with geometries and materials like instances of Mesh, Line,
Points or Sprite. Instances of Object3D, Group or Bone are not renderable
and thus this callback is not executed for such objects.
An optional callback that is executed immediately after a 3D object is rendered to a shadow map.
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
depthMaterial, group.
Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
define their visual appearance with geometries and materials like instances of Mesh, Line,
Points or Sprite. Instances of Object3D, Group or Bone are not renderable
and thus this callback is not executed for such objects.
An optional callback that is executed immediately before a 3D object is rendered.
This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
define their visual appearance with geometries and materials like instances of Mesh, Line,
Points or Sprite. Instances of Object3D, Group or Bone are not renderable
and thus this callback is not executed for such objects.
An optional callback that is executed immediately before a 3D object is rendered to a shadow map.
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
depthMaterial, group.
Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
define their visual appearance with geometries and materials like instances of Mesh, Line,
Points or Sprite. Instances of Object3D, Group or Bone are not renderable
and thus this callback is not executed for such objects.
Abstract (empty) method to get intersections between a casted ray and this object
Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.
THREE.Raycaster | Raycaster
() => {}
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.
Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
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.
Executes the callback on this object and all descendants.
A function with as first argument an Object3D object.
Note: Modifying the scene graph inside the callback is discouraged.
Executes the callback on all ancestors.
A function with as first argument an Object3D object.
Note: Modifying the scene graph inside the callback is discouraged.
Like traverse, but the callback will only be executed for visible objects
A function with as first argument an Object3D object.
Descendants of invisible objects are not traversed. Note: Modifying the scene graph inside the callback is discouraged.
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.
Array with object's animation clips.