The planes drawn.
The scene's BoxTree: the bounds the quads cover, followed as they change.
Array with object's animation clips.
Whether the object gets rendered into shadow map.
Array with object's children.
OptionalcountOptionalcustomCustom depth material to be used when rendering to the depth map.
OptionalcustomSame 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.
ReadonlyidUnique number for this Object3D instance.
ReadonlyisRead-only flag to check if a given object is of type Group.
ReadonlyisFlag to check if a given object is of type Object3D.
The layer membership of the object.
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 THREE.Object3D.matrix | .matrix.
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.
ReadonlymodelOptional name of the object
ReadonlynormalOptionalocclusionObject's parent in the scene graph.
The pivot point for rotation and scale transformations. When set, rotation and scale are applied around this point instead of the object's origin.
ReadonlypositionObject's local position.
ReadonlyquaternionObject'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.
When this property is set for an instance of Group, all descendants objects will be sorted and rendered together. Sorting is from lowest to highest renderOrder.
ReadonlyrotationObject's local rotation (Euler angles), in radians.
ReadonlyscaleThe object's local scale.
Whether the 3D object is supposed to be static or not. If set to true, it means
the 3D object is not going to be changed after the initial renderer. This includes
geometry and material settings. A static 3D object can be processed by the renderer
slightly faster since certain state checks can be bypassed.
Only relevant in context of WebGPURenderer.
ReadonlytypeA Read-only string to check this object type.
This 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.
StaticDEFAULT_The default setting for matrixAutoUpdate for newly created Object3Ds.
StaticDEFAULT_The default setting for matrixWorldAutoUpdate for newly created Object3Ds.
StaticDEFAULT_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 a listener to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Applies the matrix transform to the object and updates the object's position, rotation and scale.
Applies the rotation represented by the quaternion to the object.
Removes all child objects.
Returns a clone of this object and optionally all descendants.
Optionalrecursive: booleanIf true, descendants of the object are also cloned. Default true
Copies the given object into this object.
Optionalrecursive: 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.
Fire an event type.
The event that gets fired.
Stops following the tree, frees the geometries, materials and letters.
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
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.
OptionaloptionalTarget: 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;).
Returns a quaternion representing the rotation of the object in world space.
The result will be copied into this Quaternion.
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.
Where ray crosses the quads shown (their planes visible), nearest first: a hit per plane
whose quad it crosses (its front or its back), with the plane's proxy. None while hidden. The
quads are made again first when out of date (see update).
Abstract method to test whether this 3D object intersects the given frustum.
The frustum to test.
Whether this 3D object intersects the given frustum or not.
Rotates the object to face a point in world space.
A vector representing a position in world space to look at.
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
Removes a listener from an event type.
The type of the listener that gets removed.
The listener function that gets removed.
Removes this object from its current parent.
Rotate an object along an axis in object space.
A normalized vector in object space.
The angle in radians. Expects a Float
Rotate an object along an axis in world space.
A normalized vector in world space.
The angle in radians. Expects a Float
Rotates the object around x axis in local space.
Rotates the object around y axis in local space.
Rotates the object around z axis in local space.
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.
Optionalmeta: JSONMetaObject containing metadata such as materials, textures or images for the object.
Translate an object by distance along an axis in object space
A normalized vector in object space.
The distance to translate. Expects a Float
Translates object along x axis in object space by distance units.
Expects a Float
Translates object along y axis in object space by distance units.
Expects a Float
Translates object along z axis in object space by distance units.
Expects a Float
Like traverse, but the callback will only be executed for visible objects
Makes the quads again when shown and out of date: the planes, their visibility or the bounds changed (not every change of the BoxTree: a selection, a hidden object keep them); nothing otherwise.
Updates local transform.
Called by three.js before it culls and lists the objects drawn, in both backends: the quads made then, before their matrices.
Optionalforce: booleanAn alternative version of Object3D#updateMatrixWorld with more control over the update of ancestor and descendant nodes.
OptionalupdateParents: booleanWhether ancestor nodes should be updated or not.
OptionalupdateChildren: booleanWhether descendant nodes should be updated or not.
Optionalforce: booleanWhen set to true, a recomputation of world matrices is forced even
when Object3D#matrixWorldNeedsUpdate is false.
Draws the scene's cutting planes as the viewer does: a transparent quad per plane, coloured by the main axis of its normal (x red, y green, z blue), its border in that colour, its axis's letter in a corner. A quad follows every change of the scene bounds: it is centred on them (projected onto its plane), its side their bounding sphere's diameter. Not cut by the planes. Picked while shown (intersect, for the scene's
Raycaster), behind every object. Shown at first: hidden withvisible; a plane alone withCuttingPlaneProxy.visible.The quads are transparent and depth tested without writing the depth: an object in front hides them, while they tint an object behind. Their borders follow the same depth behavior.
The scene's is
Scene.cuttingPlanesHelper, in its three.js scene. It makes its quads again before a draw (update, fromupdateMatrixWorld) once the planes (theirversion) or the bounds (the BoxTree's) changed, while it is shown.