API

Interface ISkeletonViewerDisplayOptions

Defines how to display the various bone meshes for the viewer.

interface ISkeletonViewerDisplayOptions {
    localAxesSize?: number;
    midStep?: number;
    midStepFactor?: number;
    showLocalAxes?: boolean;
    sphereBaseSize?: number;
    sphereFactor?: number;
    sphereScaleUnit?: number;
    spurFollowsChild?: boolean;
}
Index
localAxesSize?: number

Length of each local axis

midStep?: number

How far down to start tapering the bone spurs

midStepFactor?: number

How big is the midStep?

showLocalAxes?: boolean

Whether to show local axes or not

sphereBaseSize?: number

Base for the Sphere Size

sphereFactor?: number

Ratio for the Sphere Size

sphereScaleUnit?: number

The ratio of the sphere to the longest bone in units

spurFollowsChild?: boolean

Whether a spur should attach its far end to the child bone position