Optionalgeometry: BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>
Geometry with skin indices and weights.
Optionalmaterial: TMaterial
Material, patched for dual quaternions by its builder.
The skin's blend; omitted it is linear, as Object3D.clone constructs before copy.
Array with object's animation clips.
The base matrix that is used for the bound bone transforms.
The base matrix that is used for resetting the bound bone transforms.
Either AttachedBindMode or DetachedBindMode. AttachedBindMode means the skinned mesh shares the same world space as the skeleton. This is not true when using DetachedBindMode which is useful when sharing a skeleton across multiple skinned meshes.
The bounding box of the SkinnedMesh. Can be calculated with .computeBoundingBox().
The bounding box of the SkinnedMesh. Can be calculated with .computeBoundingSphere().
Whether the object gets rendered into shadow map.
Array with object's children.
The number of instances of this mesh. Can only be used with WebGPURenderer.
OptionalcustomCustom 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.
An instance of THREE.BufferGeometry | BufferGeometry (or derived classes), defining the object's structure.
ReadonlyidUnique number for this Object3D instance.
ReadonlyisRead-only flag to check if a given object is of type Mesh.
ReadonlyisFlag to check if a given object is of type Object3D.
ReadonlyisRead-only flag to check if a given object is of type SkinnedMesh.
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 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.
Blend the shader draws this skin with; linear is Three's own.
ReadonlymodelOptionalmorphA dictionary of morphTargets based on the morphTarget.name property.
undefined, but rebuilt by .updateMorphTargets().
OptionalmorphAn 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
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.
ReadonlyrotationObject's local rotation (Euler angles), in radians.
ReadonlyscaleThe object's local scale.
THREE.Skeleton | Skeleton representing the bone hierarchy of the skinned mesh.
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.
Readonly OverridetypeThis 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 another Object3D as child of this Object3D.
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 this skin's blend to an already morphed point or direction.
Apply this skin's blend to an already morphed point or direction.
Apply this skin's blend to an already morphed point or direction.
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.
Bind a skeleton to the skinned mesh
THREE.Skeleton | Skeleton created from a Bone | Bones tree.
OptionalbindMatrix: Matrix4
THREE.Matrix4 | Matrix4 that represents the base transform of the skeleton.
Removes all child objects.
Returns a clone of this object and optionally all descendants.
Optionalrecursive: boolean
If true, descendants of the object are also cloned. Default true
Exact posed local box of the current key, grown by tolerance.
Safe posed local sphere: the joint-only bound of the class comment, or the exact sphere about the posed box's centre when that bound does not hold; either is grown by the float32 rounding bound.
Copy Three's skinned state and the blend method; the cache recomputes.
Optionalrecursive: booleanSearches 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;).
Posed local vertex position: morphs, then this skin's method.
Returns a vector representing the direction of object's positive z-axis in world space.
The result will be copied into this Vector3.
Returns a vector representing the position of the object in world space.
The result will be copied into this Vector3.
Returns a quaternion representing the rotation of the object in world space.
The result will be copied into this Quaternion.
Returns a vector of the scaling factors applied to the object for each axis in world space.
The result will be copied into this Vector3.
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.
Returns true if this mesh intersects the given frustum.
The frustum to test.
Whether this mesh intersects the given frustum or not.
Mark the pose possibly changed: the next query checks the key and both bounds recompute. Call it after writing bones or morph influences.
Converts the vector from this object's local space to world space.
A vector representing a position in this object's local space.
Normalizes the skin weights.
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.
This method sets the skinned mesh in the rest pose (resets the pose).
Raycast the posed surface of the current key.
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.
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.
Optionalmeta: JSONMetaLargest distance by which the GPU's float32 skin may differ from this mesh's CPU result, metres in the mesh frame: 2^-18 of the largest absolute posed coordinate, from about sixty float32 roundings per vertex. Zero for an empty mesh.
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
A function with as first argument an Object3D object.
Updates local transform.
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.
Optionalforce: boolean
A 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.
An alternative version of Object3D#updateMatrixWorld with more control over the update of ancestor and descendant nodes.
OptionalupdateParents: boolean
Whether ancestor nodes should be updated or not.
OptionalupdateChildren: boolean
Whether descendant nodes should be updated or not.
Optionalforce: boolean
When set to true, a recomputation of world matrices is forced even
when Object3D#matrixWorldNeedsUpdate is false.
Converts the vector from world space to this object's local space.
A vector representing a position in world space.
StaticclearClear a skinned mesh's object-level bounds, so every Three consumer
recomputes them on next read. Three's runtime documents both as nullable
(@default null, recomputed when null by Frustum, Raycaster and Box3),
while @types/three declares them non-null; the widened write states
that runtime contract rather than hiding a type error.
Any skinned mesh, including a foreign THREE.SkinnedMesh.
A skinned mesh whose CPU queries read the deformation its shaders draw.
Three's THREE.SkinnedMesh evaluates
applyBoneTransformby linear blending, and its bounds,getVertexPositionand raycast all go through it, while a dual-quaternion skin draws with the patched vertex shader. This mesh keeps one selected result for every CPU consumer: morph targets first (Three'sMesh.getVertexPosition, relative or absolute as the geometry declares), then the skin's own method over the joint transformsK_j = bindMatrixInverse * boneWorld_j * boneInverse_j * bindMatrixthat the shader blends, giving a point in the mesh's own frame. The world placement cancels insideK_j, so moving the model root changes no local result.The posed positions are cached, three floats per vertex, under a key of everything they depend on: the geometry object and the versions of its position and skin attributes, the morph influences, and
K_jof each joint that weighs on some vertex. A writer that changes bones or morph influences calls AutoMovieSkinnedMesh.invalidatePose, the duty Three places on any animated skinned mesh's bounds; the next query then rebuilds only the key, and evaluates the vertices again only when the key changed, so a pose that leaves this mesh's joints alone costs it O(joints).Bounds come in two tiers. The box is the exact CPU extent of the cache. The sphere, which frustum culling, shadow culling and Three's raycast prefilter read every frame, is derived from the joints alone: dual quaternion blending commutes with a rigid change of frame on either side (Kavan et al. 2008), so with the rest sphere
(c, r)of the vertices, every posed vertex lies withinr + max_k |K_k c - K_a c| / mof the anchor joint's imageK_a c, wherem, the least|q_k . q_l|over the weighted joints, bounds the blended rotation's norm from below because the aligned weights sum to one; a linear blend is a convex combination of rigid images and needs nom. Whenmfalls to 0.25 or below, or a morph is live, the sphere is the exact one instead. Both tiers grow by AutoMovieSkinnedMesh.tolerance's float32 bound, so culling and framing never cut a vertex the GPU draws.Precision: the CPU blend runs in double precision and agrees with the engine's
skinAutoMovieMeshto double rounding; the cache stores float32, which adds at most 2^-24 of a coordinate. The GPU evaluates the same blend in float32 over float32 matrices, about sixty roundings per vertex, so its result lies within 2^-18 of the largest local coordinate of the CPU one.