WiggleRigHelper Reference

WiggleRigHelper

Utility class that visualizes bones and their hierarchy.

Example

import { WiggleRigHelper } from "wiggle/helper";

const helper = new WiggleRigHelper({
  skeleton: skinnedMesh.skeleton,
});
scene.add(helper);

Constructor

WiggleRigHelper(options : Object)

Options:

  • skeleton (required) – reference to a skeleton that will be visualized
  • dotSize (optional, default 0.33) – dots diameter in world coordinates.
  • lineWidth (optional, default 0.25) – links line width in world coordinates.
  • colorStatic (optional, default #006CFF) – color style for static bones.
  • colorDynamic (optional, default #FC7229) – color style for wiggle bones.

Methods

.dispose()

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

Supported by