Class Skeleton

Use an array of bones to create a Skeleton that can be used by a THREE.SkinnedMesh | SkinnedMesh.

Example

// Create a simple "arm"
const bones = [];
const shoulder = new THREE.Bone();
const elbow = new THREE.Bone();
const hand = new THREE.Bone();
shoulder.add(elbow);
elbow.add(hand);
bones.push(shoulder);
bones.push(elbow);
bones.push(hand);
shoulder.position.y = -5;
elbow.position.y = 0;
hand.position.y = 5;
const armSkeleton = new THREE.Skeleton(bones);
See the[page: SkinnedMesh] page
for an example of usage with standard[page: BufferGeometry].

See

Constructors

constructor

Properties

boneInverses boneMatrices bones boneTexture frame uuid

Methods

calculateInverses clone computeBoneTexture dispose fromJSON getBoneByName init pose toJSON update

Constructors

constructor

  • new Skeleton(bones?, boneInverses?): Skeleton

  • Creates a new Skeleton.

    Parameters

    • Optionalbones: Bone<Object3DEventMap>[]

      The array of THREE.Bone | bones. Default [].

    • OptionalboneInverses: Matrix4[]

      An array of THREE.Matrix4 | Matrix4s. Default [].

    Returns Skeleton

Properties

boneInverses

boneInverses: Matrix4[]

An array of Matrix4s that represent the inverse of the THREE.Matrix4 | matrixWorld of the individual bones.

boneMatrices

boneMatrices: Float32Array

The array buffer holding the bone data when using a vertex texture.

bones

bones: Bone<Object3DEventMap>[]

The array of THREE.Bone | Bones.

Remarks

Note this is a copy of the original array, not a reference, so you can modify the original array without effecting this one.

boneTexture

boneTexture: null | DataTexture

The THREE.DataTexture | DataTexture holding the bone data when using a vertex texture.

frame

frame: number

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

Methods

calculateInverses

  • calculateInverses(): void

  • Generates the boneInverses array if not provided in the constructor.

    Returns void

clone

  • clone(): Skeleton

  • Returns a clone of this Skeleton object.

    Returns Skeleton

computeBoneTexture

  • computeBoneTexture(): this

  • Computes an instance of THREE.DataTexture | DataTexture in order to pass the bone data more efficiently to the shader

    Returns this

    Remarks

    The texture is assigned to boneTexture.

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

fromJSON

  • fromJSON(json, bones): void

  • Parameters

    Returns void

getBoneByName

  • getBoneByName(name): undefined | Bone<Object3DEventMap>

  • Searches through the skeleton's bone array and returns the first with a matching name.

    Parameters

    • name: string

      String to match to the Bone's THREE.Bone.name | .name property.

    Returns undefined | Bone<Object3DEventMap>

init

  • init(): void

  • Returns void

pose

  • pose(): void

  • Returns the skeleton to the base pose.

    Returns void

toJSON

update

  • update(): void

  • Updates the boneMatrices and boneTexture after changing the bones

    Returns void

    Remarks

    This is called automatically by the THREE.WebGLRenderer | WebGLRenderer if the Skeleton is used with a THREE.SkinnedMesh | SkinnedMesh.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods