Class SkeletonViewer

constructor

• new SkeletonViewer(
      skeleton: Skeleton,
      mesh: Nullable<AbstractMesh>,
      scene: Scene,
      autoUpdateBonesMatrices?: boolean,
      renderingGroupId?: number,
      options?: Partial<ISkeletonViewerOptions>,
  ): SkeletonViewer

  Creates a new SkeletonViewer

  Parameters

  • skeleton: Skeleton

    defines the skeleton to render

  • mesh: Nullable<AbstractMesh>

    defines the mesh attached to the skeleton

  • scene: Scene

    defines the hosting scene

  • autoUpdateBonesMatrices: boolean = true

    defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)

  • renderingGroupId: number = 2

    defines the rendering group id to use with the viewer

  • options: Partial<ISkeletonViewerOptions> = {}

    All of the extra constructor options for the SkeletonViewer

  Returns SkeletonViewer

autoUpdateBonesMatrices

color

mesh

options

renderingGroupId

skeleton

Static ReadonlyDISPLAY_LINES

Static ReadonlyDISPLAY_SPHERE_AND_SPURS

Static ReadonlyDISPLAY_SPHERES

debugLocalAxesMesh

• get debugLocalAxesMesh(): Nullable<LinesMesh>

  Gets the local axes mesh

  Returns Nullable<LinesMesh>

debugMesh

• get debugMesh(): AbstractMesh | LinesMesh | null

  Gets the debugMesh

  Returns AbstractMesh | LinesMesh | null

• set debugMesh(value: AbstractMesh | LinesMesh | null): void

  Sets the debugMesh

  Parameters

  • value: AbstractMesh | LinesMesh | null

  Returns void

displayMode

• get displayMode(): number

  Gets the displayMode

  Returns number

• set displayMode(value: number): void

  Sets the displayMode

  Parameters

  • value: number

  Returns void

isEnabled

• get isEnabled(): boolean

  Returns boolean

• set isEnabled(value: boolean): void

  Gets or sets a boolean indicating if the viewer is enabled

  Parameters

  • value: boolean

  Returns void

isReady

• get isReady(): boolean

  Checks Ready Status.

  Returns boolean

ready

• set ready(value: boolean): void

  Sets Ready Status.

  Parameters

  • value: boolean

  Returns void

scene

• get scene(): Scene

  Gets the Scene.

  Returns Scene

utilityLayer

• get utilityLayer(): Nullable<UtilityLayerRenderer>

  Gets the utilityLayer.

  Returns Nullable<UtilityLayerRenderer>

changeDisplayMode

• changeDisplayMode(mode: number): void

  Changes the displayMode of the skeleton viewer

  Parameters

  • mode: number

    The displayMode numerical value

  Returns void

changeDisplayOptions

• changeDisplayOptions(option: string, value: number | boolean): void

  Sets a display option of the skeleton viewer

  Option	Type	Default	Description
  midStep	float	0.235	A percentage between a bone and its child that determines the widest part of a spur. Only used when displayMode is set to DISPLAY_SPHERE_AND_SPURS.
  midStepFactor	float	0.15	Mid step width expressed as a factor of the length. A value of 0.5 makes the spur width half of the spur length. Only used when displayMode is set to DISPLAY_SPHERE_AND_SPURS.
  sphereBaseSize	float	2	Sphere base size. Only used when displayMode is set to DISPLAY_SPHERE_AND_SPURS.
  sphereScaleUnit	float	0.865	Sphere scale factor used to scale spheres in relation to the longest bone. Only used when displayMode is set to DISPLAY_SPHERE_AND_SPURS.
  spurFollowsChild	boolean	false	Whether a spur should attach its far end to the child bone.
  showLocalAxes	boolean	false	Displays local axes on all bones.
  localAxesSize	float	0.075	Determines the length of each local axis.

  Parameters

  • option: string

    String of the option name

  • value: number | boolean

    The numerical option value

  Returns void

dispose

• dispose(): void

  Release associated resources

  Returns void

update

• update(): void

  Update the viewer to sync with current skeleton state, only used to manually update.

  Returns void

StaticCreateBoneWeightShader

• CreateBoneWeightShader(
      options: IBoneWeightShaderOptions,
      scene: Scene,
  ): ShaderMaterial

  public static method to create a BoneWeight Shader

  Parameters

  • options: IBoneWeightShaderOptions

    The constructor options

  • scene: Scene

    The scene that the shader is scoped to

  Returns ShaderMaterial

  The created ShaderMaterial

  See

  http://www.babylonjs-playground.com/#1BZJVJ#395

StaticCreateSkeletonMapShader

• CreateSkeletonMapShader(
      options: ISkeletonMapShaderOptions,
      scene: Scene,
  ): ShaderMaterial

  public static method to create a BoneWeight Shader

  Parameters

  • options: ISkeletonMapShaderOptions

    The constructor options

  • scene: Scene

    The scene that the shader is scoped to

  Returns ShaderMaterial

  The created ShaderMaterial