AutoMovie API
    Preparing search index...

    Class AutoMovieSkinnedMesh<TMaterial>

    A skinned mesh whose CPU queries read the deformation its shaders draw.

    Three's THREE.SkinnedMesh evaluates applyBoneTransform by linear blending, and its bounds, getVertexPosition and 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's Mesh.getVertexPosition, relative or absolute as the geometry declares), then the skin's own method over the joint transforms K_j = bindMatrixInverse * boneWorld_j * boneInverse_j * bindMatrix that the shader blends, giving a point in the mesh's own frame. The world placement cancels inside K_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_j of 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 within r + max_k |K_k c - K_a c| / m of the anchor joint's image K_a c, where m, 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 no m. When m falls 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 skinAutoMovieMesh to 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.

    Type Parameters

    • TMaterial extends THREE.Material | THREE.Material[] = THREE.Material | THREE.Material[]

    Hierarchy

    • SkinnedMesh<THREE.BufferGeometry, TMaterial>
      • AutoMovieSkinnedMesh
    Index
    • Type Parameters

      • TMaterial extends Material<MaterialEventMap> | Material<MaterialEventMap>[] = Material<MaterialEventMap> | Material<MaterialEventMap>[]

      Parameters

      • Optionalgeometry: BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>

        Geometry with skin indices and weights.

      • Optionalmaterial: TMaterial

        Material, patched for dual quaternions by its builder.

      • method: NonNullable<"linear" | "dual-quaternion" | undefined> = "linear"

        The skin's blend; omitted it is linear, as Object3D.clone constructs before copy.

      Returns AutoMovieSkinnedMesh<TMaterial>

    animations: AnimationClip[]

    Array with object's animation clips.

    []

    bindMatrix: Matrix4

    The base matrix that is used for the bound bone transforms.

    bindMatrixInverse: Matrix4

    The base matrix that is used for resetting the bound bone transforms.

    bindMode: BindMode

    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.

    AttachedBindMode

    boundingBox: Box3

    The bounding box of the SkinnedMesh. Can be calculated with .computeBoundingBox().

    null

    boundingSphere: Sphere

    The bounding box of the SkinnedMesh. Can be calculated with .computeBoundingSphere().

    null

    castShadow: boolean

    Whether the object gets rendered into shadow map.

    false

    children: Object3D<Object3DEventMap>[]

    Array with object's children.

    THREE.Object3DGroup | Group for info on manually grouping objects.

    []

    count: number

    The number of instances of this mesh. Can only be used with WebGPURenderer.

    1
    
    customDepthMaterial?: Material<MaterialEventMap>

    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 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

    customDistanceMaterial?: Material<MaterialEventMap>

    Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

    undefined

    frustumCulled: boolean

    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

    geometry: BufferGeometry

    An instance of THREE.BufferGeometry | BufferGeometry (or derived classes), defining the object's structure.

    THREE.BufferGeometry | new THREE.BufferGeometry().

    id: number

    Unique 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

    isMesh: true

    Read-only flag to check if a given object is of type Mesh.

    This is a constant value

    true

    isObject3D: true

    Flag to check if a given object is of type Object3D.

    This is a constant value

    true

    isSkinnedMesh: true

    Read-only flag to check if a given object is of type SkinnedMesh.

    This is a constant value

    true

    layers: Layers

    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()

    material: TMaterial

    An instance of material derived from the THREE.Material | Material base class or an array of materials, defining the object's appearance.

    THREE.MeshBasicMaterial | new THREE.MeshBasicMaterial().

    matrix: Matrix4

    The local transform matrix.

    new THREE.Matrix4()

    matrixAutoUpdate: boolean

    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).

    matrixWorld: Matrix4

    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()

    matrixWorldAutoUpdate: boolean

    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).

    matrixWorldNeedsUpdate: boolean

    When this is set, it calculates the matrixWorld in that frame and resets this property to false.

    false

    method: NonNullable<"linear" | "dual-quaternion" | undefined>

    Blend the shader draws this skin with; linear is Three's own.

    modelViewMatrix: Matrix4

    new THREE.Matrix4()

    morphTargetDictionary?: { [key: string]: number }

    A dictionary of morphTargets based on the morphTarget.name property.

    undefined, but rebuilt by .updateMorphTargets().

    morphTargetInfluences?: number[]

    An 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().

    name: string

    Optional name of the object

    (doesn't need to be unique).

    ""

    normalMatrix: Matrix3

    new THREE.Matrix3()

    occlusionTest?: boolean
    parent: Object3D<Object3DEventMap> | null

    Object's parent in the scene graph.

    An object can have at most one parent.

    null

    pivot: Vector3 | null

    The pivot point for rotation and scale transformations. When set, rotation and scale are applied around this point instead of the object's origin.

    null
    
    position: Vector3

    Object's local position.

    new THREE.Vector3() - that is (0, 0, 0).

    quaternion: Quaternion

    Object's local rotation as a THREE.Quaternion | Quaternion.

    new THREE.Quaternion() - that is (0, 0, 0, 1).

    receiveShadow: boolean

    Whether the material receives shadows.

    false

    renderOrder: number

    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

    rotation: Euler

    Object's local rotation (Euler angles), in radians.

    new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

    scale: Vector3

    The object's local scale.

    new THREE.Vector3( 1, 1, 1 )

    skeleton: Skeleton

    THREE.Skeleton | Skeleton representing the bone hierarchy of the skinned mesh.

    static: boolean

    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.

    false
    
    type: string

    SkinnedMesh

    up: Vector3

    This is used by the lookAt method, for example, to determine the orientation of the result.

    Object3D.DEFAULT_UP - that is (0, 1, 0).

    userData: Record<string, any>

    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: string

    UUID of this object instance.

    This gets automatically assigned and shouldn't be edited.

    visible: boolean

    Object gets rendered if true.

    true

    DEFAULT_MATRIX_AUTO_UPDATE: boolean

    The default setting for matrixAutoUpdate for newly created Object3Ds.

    true

    DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

    The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

    true

    DEFAULT_UP: Vector3

    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)

    • Adds another Object3D as child of this Object3D.

      Parameters

      • ...object: Object3D<Object3DEventMap>[]

      Returns this

      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.

      • attach
      • THREE.Group | Group for info on manually grouping objects.
    • Adds a listener to an event type.

      Type Parameters

      • T extends keyof Object3DEventMap

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<Object3DEventMap[T], T, AutoMovieSkinnedMesh<TMaterial>>

        The function that gets called when the event is fired.

      Returns void

    • Apply this skin's blend to an already morphed point or direction.

      Parameters

      • index: number
      • target: Vector3

      Returns Vector3

    • Apply this skin's blend to an already morphed point or direction.

      Parameters

      • index: number
      • target: Vector4

      Returns Vector4

    • Apply this skin's blend to an already morphed point or direction.

      Parameters

      • index: number
      • target: Vector3 | Vector4

      Returns Vector3 | Vector4

    • Applies the matrix transform to the object and updates the object's position, rotation and scale.

      Parameters

      • matrix: Matrix4

      Returns void

    • Applies the rotation represented by the quaternion to the object.

      Parameters

      • quaternion: Quaternion

      Returns this

    • Adds a Object3D as a child of this, while maintaining the object's world transform.

      Parameters

      • object: Object3D

      Returns this

      Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

      add

    • Bind a skeleton to the skinned mesh

      Parameters

      • skeleton: Skeleton

        THREE.Skeleton | Skeleton created from a Bone | Bones tree.

      • OptionalbindMatrix: Matrix4

        THREE.Matrix4 | Matrix4 that represents the base transform of the skeleton.

      Returns void

      The bindMatrix gets saved to .bindMatrix property and the .bindMatrixInverse gets calculated.

    • Removes all child objects.

      Returns this

    • Returns a clone of this object and optionally all descendants.

      Parameters

      • Optionalrecursive: boolean

        If true, descendants of the object are also cloned. Default true

      Returns this

    • 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.

      Returns void

    • Copy Three's skinned state and the blend method; the cache recomputes.

      Parameters

      • source: this
      • Optionalrecursive: boolean

      Returns this

    • Fire an event type.

      Type Parameters

      • T extends keyof Object3DEventMap

      Parameters

      • event: BaseEvent<T> & Object3DEventMap[T]

        The event that gets fired.

      Returns void

    • Frees the GPU-related resources allocated by this instance.

      Returns void

      Call this method whenever this instance is no longer used in your app. Geometries, materials and textures are potentially shared with other 3D objects and must be disposed of separately.

    • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

      Parameters

      • id: number

        Unique number of the object instance. Expects a Integer

      Returns Object3D<Object3DEventMap> | undefined

      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.

      Parameters

      • name: string

        String to match to the children's Object3D.name property.

      Returns Object3D<Object3DEventMap> | undefined

      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.

      Parameters

      • name: string

        the property name to search for.

      • value: any

        value of the given property.

      Returns Object3D<Object3DEventMap> | undefined

    • Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

      Parameters

      • name: string

        The property name to search for.

      • value: any

        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 Object3D<Object3DEventMap>[]

    • Posed local vertex position: morphs, then this skin's method.

      Parameters

      • index: number
      • target: Vector3

      Returns Vector3

    • Returns a vector representing the direction of object's positive z-axis in world space.

      Parameters

      • target: Vector3

        The result will be copied into this Vector3.

      Returns Vector3

    • Returns a vector representing the position of the object in world space.

      Parameters

      • target: Vector3

        The result will be copied into this Vector3.

      Returns Vector3

    • Returns a quaternion representing the rotation of the object in world space.

      Parameters

      • target: Quaternion

        The result will be copied into this Quaternion.

      Returns Quaternion

    • Returns a vector of the scaling factors applied to the object for each axis in world space.

      Parameters

      • target: Vector3

        The result will be copied into this Vector3.

      Returns Vector3

    • Checks if listener is added to an event type.

      Type Parameters

      • T extends keyof Object3DEventMap

      Parameters

      • type: T

        The type of event to listen to.

      • listener: EventListener<Object3DEventMap[T], T, AutoMovieSkinnedMesh<TMaterial>>

        The function that gets called when the event is fired.

      Returns boolean

    • Returns true if this mesh intersects the given frustum.

      Parameters

      • frustum: Frustum | FrustumArray

        The frustum to test.

      Returns boolean

      Whether this mesh intersects the given frustum or not.

    • Converts the vector from this object's local space to world space.

      Parameters

      • vector: Vector3

        A vector representing a position in this object's local space.

      Returns Vector3

    • Rotates the object to face a point in world space.

      Parameters

      • vector: Vector3

        A vector representing a position in world space to look at.

      Returns void

      This method does not support objects having non-uniformly-scaled parent(s).

    • Rotates the object to face a point in world space.

      Parameters

      • x: number

        Expects a Float

      • y: number

        Expects a Float

      • z: number

        Expects a Float

      Returns void

      This method does not support objects having non-uniformly-scaled parent(s).

    • Normalizes the skin weights.

      Returns void

    • An optional callback that is executed immediately after a 3D object is rendered.

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry
      • material: Material
      • group: Group

      Returns void

      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.

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • shadowCamera: Camera
      • geometry: BufferGeometry
      • depthMaterial: Material
      • group: Group

      Returns void

      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.

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry
      • material: Material
      • group: Group

      Returns void

      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.

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • shadowCamera: Camera
      • geometry: BufferGeometry
      • depthMaterial: Material
      • group: Group

      Returns void

      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).

      Returns void

    • Raycast the posed surface of the current key.

      Parameters

      • raycaster: Raycaster
      • intersects: Intersection<Object3D<Object3DEventMap>>[]

      Returns void

    • Removes a Object3D as child of this Object3D.

      Parameters

      • ...object: Object3D<Object3DEventMap>[]

      Returns this

      An arbitrary number of objects may be removed.

      THREE.Group | Group for info on manually grouping objects.

    • Removes a listener from an event type.

      Type Parameters

      • T extends keyof Object3DEventMap

      Parameters

      • type: T

        The type of the listener that gets removed.

      • listener: EventListener<Object3DEventMap[T], T, AutoMovieSkinnedMesh<TMaterial>>

        The listener function that gets removed.

      Returns void

    • Removes this object from its current parent.

      Returns this

    • Rotate an object along an axis in object space.

      Parameters

      • axis: Vector3

        A normalized vector in object space.

      • angle: number

        The angle in radians. Expects a Float

      Returns this

      The axis is assumed to be normalized.

    • Rotate an object along an axis in world space.

      Parameters

      • axis: Vector3

        A normalized vector in world space.

      • angle: number

        The angle in radians. Expects a Float

      Returns this

      The axis is assumed to be normalized Method Assumes no rotated parent.

    • Rotates the object around x axis in local space.

      Parameters

      • angle: number

      Returns this

    • Rotates the object around y axis in local space.

      Parameters

      • angle: number

      Returns this

    • Rotates the object around z axis in local space.

      Parameters

      • angle: number

      Returns this

    • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

      Parameters

      • axis: Vector3

        A normalized vector in object space.

      • angle: number

        Angle in radians. Expects a Float

      Returns void

    • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

      Parameters

      • euler: Euler

        Euler angle specifying rotation amount.

      Returns void

    • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

      Parameters

      • m: Matrix4

        Rotate the quaternion by the rotation component of the matrix.

      Returns void

      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.

      Parameters

      • q: Quaternion

        Normalized Quaternion.

      Returns void

    • Parameters

      • Optionalmeta: JSONMeta

      Returns SkinnedMeshJSON

    • Largest 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.

      Returns number

    • Translate an object by distance along an axis in object space

      Parameters

      • axis: Vector3

        A normalized vector in object space.

      • distance: number

        The distance to translate. Expects a Float

      Returns this

      The axis is assumed to be normalized.

    • Translates object along x axis in object space by distance units.

      Parameters

      • distance: number

        Expects a Float

      Returns this

    • Translates object along y axis in object space by distance units.

      Parameters

      • distance: number

        Expects a Float

      Returns this

    • Translates object along z axis in object space by distance units.

      Parameters

      • distance: number

        Expects a Float

      Returns this

    • Executes the callback on this object and all descendants.

      Parameters

      • callback: (object: Object3D) => any

        A function with as first argument an Object3D object.

      Returns void

      Note: Modifying the scene graph inside the callback is discouraged.

    • Executes the callback on all ancestors.

      Parameters

      • callback: (object: Object3D) => any

        A function with as first argument an Object3D object.

      Returns void

      Note: Modifying the scene graph inside the callback is discouraged.

    • Like traverse, but the callback will only be executed for visible objects

      Parameters

      • callback: (object: Object3D) => any

        A function with as first argument an Object3D object.

      Returns void

      Descendants of invisible objects are not traversed. Note: Modifying the scene graph inside the callback is discouraged.

    • Updates local transform.

      Returns void

    • 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.

      Parameters

      • 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.

      Returns void

    • Updates the morphTargets to have no influence on the object

      Returns void

      Resets the morphTargetInfluences and morphTargetDictionary properties.

    • An alternative version of Object3D#updateMatrixWorld with more control over the update of ancestor and descendant nodes.

      Parameters

      • 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.

      Returns void

    • Converts the vector from world space to this object's local space.

      Parameters

      • vector: Vector3

        A vector representing a position in world space.

      Returns Vector3

    • Clear 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.

      Parameters

      • mesh: Pick<THREE.SkinnedMesh, "boundingBox" | "boundingSphere">

        Any skinned mesh, including a foreign THREE.SkinnedMesh.

      Returns void