Skip to main content

Object3D → Line → LineSegments →

SkeletonHelper

A helper object to assist with visualizing a Skeleton. The helper is rendered using a LineBasicMaterial.

Code Example​

const helper = new THREE.SkeletonHelper( skinnedMesh ); scene.add( helper );

Examples​

[example:webgl_animation_skinning_blending WebGL / animation / skinning / blending]
[example:webgl_animation_skinning_morph WebGL / animation / skinning / morph]
[example:webgl_loader_bvh WebGL / loader / bvh ]

Constructor​

SkeletonHelper​

function SkeletonHelper( object: Object3D ): void;

object -- Usually an instance of SkinnedMesh. However, any instance of Object3D can be used if it represents a hierarchy of Bones (via Object3D.children).

Properties​

bones​

bones: Array;

The list of bones that the helper renders as Lines.

isSkeletonHelper​

isSkeletonHelper: Boolean;

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

root​

root: Object3D;

The object passed in the constructor.

Methods​

See the base LineSegments class for common methods.

dispose​

function dispose( ): undefined;

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Source​

src/helpers/SkeletonHelper.js