SkeletonViewer | Babylon.js API documentation

Class SkeletonViewer

Class used to render a debug view of a given skeleton

See

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

Index

Constructors

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
- OptionalautoUpdateBonesMatrices: boolean
  defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
- OptionalrenderingGroupId: number
  defines the rendering group id to use with the viewer
- Optionaloptions: Partial<ISkeletonViewerOptions>
  All of the extra constructor options for the SkeletonViewer
Returns SkeletonViewer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123890

Properties

autoUpdateBonesMatrices

autoUpdateBonesMatrices: boolean

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

color

color: Color3

Gets or sets the color used to render the skeleton

mesh

mesh: Nullable<AbstractMesh>

defines the mesh attached to the skeleton

options

options: Partial<ISkeletonViewerOptions>

[Object] is the options for the viewer

renderingGroupId

renderingGroupId: number

[3] defines the rendering group id to use with the viewer

skeleton

skeleton: Skeleton

defines the skeleton to render

`Static` `Readonly`DISPLAY_LINES

DISPLAY_LINES: 0

public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES

`Static` `Readonly`DISPLAY_SPHERE_AND_SPURS

DISPLAY_SPHERE_AND_SPURS: 2

public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS

`Static` `Readonly`DISPLAY_SPHERES

DISPLAY_SPHERES: 1

public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES

Accessors

debugMesh

get debugMesh(): null | AbstractMesh | LinesMesh
Gets the debugMesh

Returns null | AbstractMesh | LinesMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123874
set debugMesh(value: null | AbstractMesh | LinesMesh): void
Sets the debugMesh
Parameters
- value: null | AbstractMesh | LinesMesh
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123876

displayMode

get displayMode(): number
Gets the displayMode

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123878
set displayMode(value: number): void
Sets the displayMode
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123880

isEnabled

get isEnabled(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123909
set isEnabled(value: boolean): void
Gets or sets a boolean indicating if the viewer is enabled
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123908

isReady

get isReady(): boolean
Checks Ready Status.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123870

ready

set ready(value: boolean): void
Sets Ready Status.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123872

scene

get scene(): Scene
Gets the Scene.

Returns Scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123866

utilityLayer

get utilityLayer(): Nullable<UtilityLayerRenderer>
Gets the utilityLayer.

Returns Nullable<UtilityLayerRenderer>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123868

Methods

changeDisplayMode

changeDisplayMode(mode: number): void
Changes the displayMode of the skeleton viewer
Parameters
- mode: number
  The displayMode numerical value
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123937

changeDisplayOptions

changeDisplayOptions(option: string, value: number): 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
The numerical option value

Returns void

dispose

dispose(): void
Release associated resources

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123955

update

update(): void
Update the viewer to sync with current skeleton state, only used to manually update.

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123906

`Static`CreateBoneWeightShader

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123832

`Static`CreateSkeletonMapShader

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123838

Class SkeletonViewer

See

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SkeletonViewer

Properties

autoUpdateBonesMatrices

color

mesh

options

renderingGroupId

skeleton

Static ReadonlyDISPLAY_LINES

Static ReadonlyDISPLAY_SPHERE_AND_SPURS

Static ReadonlyDISPLAY_SPHERES

Accessors

debugMesh

Returns null | AbstractMesh | LinesMesh

Parameters

Returns void

displayMode

Returns number

Parameters

Returns void

isEnabled

Returns boolean

Parameters

Returns void

isReady

Returns boolean

ready

Parameters

Returns void

scene

Returns Scene

utilityLayer

Returns Nullable<UtilityLayerRenderer>

Methods

changeDisplayMode

Parameters

Returns void

changeDisplayOptions

Parameters

Returns void

dispose

Returns void

update

Returns void

StaticCreateBoneWeightShader

Parameters

Returns ShaderMaterial

See

StaticCreateSkeletonMapShader

Parameters

Returns ShaderMaterial

Settings

On This Page

`Static` `Readonly`DISPLAY_LINES

`Static` `Readonly`DISPLAY_SPHERE_AND_SPURS

`Static` `Readonly`DISPLAY_SPHERES

`Static`CreateBoneWeightShader

`Static`CreateSkeletonMapShader