Optionalopt: { createLights?: boolean; lightIntensity?: number; scale?: number }Gets rendered into shadow map.
Array with object's children.
Custom depth material to be used when rendering to the depth map. Can only be used in context of meshes. When shadow-casting with a DirectionalLight or SpotLight, if you are (a) modifying vertex positions in the vertex shader, (b) using a displacement map, (c) using an alpha map with alphaTest, or (d) using a transparent texture with alphaTest, you must specify a customDepthMaterial for proper shadows.
Same as customDepthMaterial, but used with 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.
Unique number of this object instance.
ReadonlyisUsed to check whether this or derived classes are Object3Ds. Default is true. You should not change this, as it is used internally for optimisation.
Local transform.
When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.
The global transform of the object. If the Object3d has no parent, then it's identical to the local transform.
When this is set, the renderer checks every frame if the object and its children need matrix updates. Otherwise, you have to maintain all matrices in the object and its children yourself.
When this is set, it calculates the matrixWorld in that frame and resets this property to false.
ReadonlymodelOptional name of the object (doesn't need to be unique).
ReadonlynormalCalls after rendering object
Calls before rendering object
Object's parent in the scene graph.
ReadonlypositionObject's local position.
ReadonlyquaternionObject's local rotation as a Quaternion.
Material gets baked in shadow receiving.
Overrides the default rendering order of scene graph objects, from lowest to highest renderOrder. Opaque and transparent objects remain sorted independently though. When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
ReadonlyrotationObject's local rotation (Euler angles), in radians.
ReadonlyscaleObject's local scale.
Up direction.
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.
Object gets rendered if true.
StaticDefaultStaticDefaultStaticDefaultAdds object as child of this object.
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.
Adds object as a child of this, while maintaining the object's world transform.
Removes all child objects.
Optionalrecursive: booleanOptionalrecursive: booleanFire an event type.
Searches through the object's children and returns the first with a matching id.
Unique number of the object instance
Searches through the object's children and returns the first with a matching name.
String to match to the children's Object3d.name property.
Updates the vector from local space to world space.
A local vector.
Optionally, the x, y and z components of the world space position. Rotates the object to face a point in world space. This method does not support objects having non-uniformly-scaled parent(s).
A world vector to look at.
Optionally, the x, y and z components of the world space position. Rotates the object to face a point in world space. This method does not support objects having non-uniformly-scaled parent(s).
Removes object as child of this object.
Removes this object from its current parent.
Rotate an object along an axis in object space. The axis is assumed to be normalized.
A normalized vector in object space.
The angle in radians.
Rotate an object along an axis in world space. The axis is assumed to be normalized. Method Assumes no rotated parent.
A normalized vector in object space.
The angle in radians.
Rotates the object around x axis in local space.
the angle to rotate in radians.
Rotates the object around y axis in local space.
the angle to rotate in radians.
Rotates the object around z axis in local space.
the angle to rotate in radians.
axis -- A normalized vector in object space. angle -- angle in radians
A normalized vector in object space.
angle in radians
Calls setRotationFromEuler(euler) on the .quaternion.
Euler angle specifying rotation amount.
Calls setFromRotationMatrix(m) on the .quaternion.
Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
rotate the quaternion by the rotation component of the matrix.
Copy the given quaternion into .quaternion.
normalized Quaternion
Optionalmeta: { geometries: any; images: any; materials: any; textures: any }Translate an object by distance along an axis in object space. The axis is assumed to be normalized.
A normalized vector in object space.
The distance to translate.
Translates object along x axis by distance.
Distance.
Translates object along y axis by distance.
Distance.
Translates object along z axis by distance.
Distance.
Updates local transform.
Updates global transform of the object and its children.
Optionalforce: booleanUpdates the global transform of the object.
recursively updates global transform of ancestors.
recursively updates global transform of descendants.
Updates the vector from world space to local space.
A world vector.
Array with animation clips.