Babylon.js Documentation

Class used to store bone information

see: http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons

Hierarchy

Node
- Bone

Implements

IBehaviorAware<Node>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Bone(name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>): Bone

Overrides Node.constructor

Create a new bone

Parameters
- name: string
  
  defines the bone name
- skeleton: Skeleton
  
  defines the parent skeleton
- Optional parentBone: Nullable<Bone>
  
  defines the parent (can be null if the bone is the root)
- Optional localMatrix: Nullable<Matrix>
  
  defines the local matrix
- Optional restPose: Nullable<Matrix>
  
  defines the rest pose matrix
- Optional baseMatrix: Nullable<Matrix>
  
  defines the base matrix
- Optional index: Nullable<number>
  
  defines index of the bone in the hiearchy
Returns Bone

Properties

animationPropertiesOverride

animationPropertiesOverride: Nullable<AnimationPropertiesOverride>

Gets the animation properties override

animations

animations: Animation[]

Gets the animations associated with this bone

behaviors

behaviors: Behavior<Node>[]

Gets the list of attached behaviors

see: http://doc.babylonjs.com/features/behaviour

children

children: Bone[]

Gets the list of child bones

doNotSerialize

doNotSerialize: boolean

Gets or sets a boolean used to define if the node must be serialized

id

id: string

Gets or sets the id of the node

length

length: number

Gets or sets bone length

metadata

metadata: any

Gets or sets an object used to store user defined information for the node

name

name: string

defines the bone name

onDispose

onDispose: function

Sets a callback that will be raised when the node will be disposed

Type declaration

- (): void
- Returns void

onDisposeObservable

onDisposeObservable: Observable<Node>

An event triggered when the mesh is disposed

onReady

onReady: function

Callback raised when the node is ready to be used

Type declaration

- (node: Node): void
- Parameters
  - node: Node
  Returns void

parent

parent: Nullable<Node>

Gets or sets the parent of the node

position

position: Vector3

Gets or sets current position (in local space)

rotation

rotation: Vector3

Gets or sets current rotation (in local space)

rotationQuaternion

rotationQuaternion: Quaternion

Gets or sets current rotation quaternion (in local space)

scaling

scaling: Vector3

Gets or sets current scaling (in local space)

state

state: string

Gets or sets a string used to store user defined state for the node

uniqueId

uniqueId: number

Gets or sets the unique id of the node

Methods

addBehavior

addBehavior(behavior: Behavior<Node>): Node

Implementation of IBehaviorAware.addBehavior

Inherited from Node.addBehavior

Attach a behavior to the node

see

http://doc.babylonjs.com/features/behaviour

Parameters
- behavior: Behavior<Node>
  
  defines the behavior to attach
Returns Node

the current Node

beginAnimation

beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: function): Nullable<Animatable>

Inherited from Node.beginAnimation

Will start the animation sequence

Parameters
- name: string
  
  defines the range frames for animation sequence
- Optional loop: boolean
  
  defines if the animation should loop (false by default)
- Optional speedRatio: number
  
  defines the speed factor in which to run the animation (1 by default)
- Optional onAnimationEnd: function
  
  defines a function to be executed when the animation ended (undefined by default)
  - - (): void
    - Returns void
Returns Nullable<Animatable>

the object created for this animation. If range does not exist, it will return null

computeAbsoluteTransforms

computeAbsoluteTransforms(): void

Compute the absolute transforms of this bone and its children

Returns void

computeWorldMatrix

computeWorldMatrix(force?: boolean): Matrix

Inherited from Node.computeWorldMatrix

Computes the world matrix of the node

Parameters
- Optional force: boolean
  
  defines if the cache version should be invalidated forcing the world matrix to be created from scratch
Returns Matrix

the world matrix

copyAnimationRange

copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired?: boolean, skelDimensionsRatio?: Nullable<Vector3>): boolean

Copy an animation range from another bone

Parameters
- source: Bone
  
  defines the source bone
- rangeName: string
  
  defines the range name to copy
- frameOffset: number
  
  defines the frame offset
- Optional rescaleAsRequired: boolean
  
  defines if rescaling must be applied if required
- Optional skelDimensionsRatio: Nullable<Vector3>
  
  defines the scaling ratio
Returns boolean

true if operation was successful

createAnimationRange

createAnimationRange(name: string, from: number, to: number): void

Inherited from Node.createAnimationRange

Creates an animation range for this node

Parameters
- name: string
  
  defines the name of the range
- from: number
  
  defines the starting key
- to: number
  
  defines the end key
Returns void

deleteAnimationRange

deleteAnimationRange(name: string, deleteFrames?: boolean): void

Inherited from Node.deleteAnimationRange

Delete a specific animation range

Parameters
- name: string
  
  defines the name of the range to delete
- Optional deleteFrames: boolean
  
  defines if animation frames from the range must be deleted as well
Returns void

dispose

dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void

Inherited from Node.dispose

Releases resources associated with this node.

Parameters
- Optional doNotRecurse: boolean
  
  Set to true to not recurse into each children (recurse into each children by default)
- Optional disposeMaterialAndTextures: boolean
  
  Set to true to also dispose referenced materials and textures (false by default)
Returns void

getAbsolutePosition

getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3

Get the absolute position of the bone (world space)

Parameters
- Optional mesh: Nullable<AbstractMesh>
  
  The mesh that this bone is attached to
Returns Vector3

The absolute position of the bone

getAbsolutePositionFromLocal

getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3

Get the world position of a point that is in the local space of the bone

Parameters
- position: Vector3
  
  The local position
- Optional mesh: Nullable<AbstractMesh>
  
  The mesh that this bone is attached to
Returns Vector3

The world position

getAbsolutePositionFromLocalToRef

getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void

Get the world position of a point that is in the local space of the bone and copy it to the result param

Parameters
- position: Vector3
  
  The local position
- mesh: AbstractMesh | null | undefined
  
  The mesh that this bone is attached to
- result: Vector3
  
  The vector3 that the world position should be copied to
Returns void

getAbsolutePositionToRef

getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void

Copy the absolute position of the bone (world space) to the result param

Parameters
- mesh: AbstractMesh
  
  The mesh that this bone is attached to
- result: Vector3
  
  The vector3 to copy the absolute position to
Returns void

getAbsoluteTransform

getAbsoluteTransform(): Matrix

Gets the absolute transform matrix (ie base matrix * parent world matrix)

Returns Matrix

a matrix

getAnimationByName

getAnimationByName(name: string): Nullable<Animation>

Inherited from Node.getAnimationByName

Get an animation by name

Parameters
- name: string
  
  defines the name of the animation to look for
Returns Nullable<Animation>

null if not found else the requested animation

getAnimationRange

getAnimationRange(name: string): Nullable<AnimationRange>

Inherited from Node.getAnimationRange

Get an animation range by name

Parameters
- name: string
  
  defines the name of the animation range to look for
Returns Nullable<AnimationRange>

null if not found else the requested animation range

getBaseMatrix

getBaseMatrix(): Matrix

Gets the base matrix (initial matrix which remains unchanged)

Returns Matrix

a matrix

getBehaviorByName

getBehaviorByName(name: string): Nullable<Behavior<Node>>

Implementation of IBehaviorAware.getBehaviorByName

Inherited from Node.getBehaviorByName

Gets an attached behavior by name

see

http://doc.babylonjs.com/features/behaviour

Parameters
- name: string
  
  defines the name of the behavior to look for
Returns Nullable<Behavior<Node>>

null if behavior was not found else the requested behavior

getChildMeshes

getChildMeshes(directDescendantsOnly?: boolean, predicate?: function): AbstractMesh[]

Inherited from Node.getChildMeshes

Get all child-meshes of this node

Parameters
- Optional directDescendantsOnly: boolean
  
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optional predicate: function
  
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  - - (node: Node): boolean
    - Parameters
      - node: Node
      Returns boolean
Returns AbstractMesh[]

an array of {BABYLON.AbstractMesh}

getChildTransformNodes

getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: function): TransformNode[]

Inherited from Node.getChildTransformNodes

Get all child-transformNodes of this node

Parameters
- Optional directDescendantsOnly: boolean
  
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optional predicate: function
  
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  - - (node: Node): boolean
    - Parameters
      - node: Node
      Returns boolean
Returns TransformNode[]

an array of {BABYLON.TransformNode}

getChildren

getChildren(predicate?: function): Node[]

Inherited from Node.getChildren

Get all direct children of this node

Parameters
- Optional predicate: function
  
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  - - (node: Node): boolean
    - Parameters
      - node: Node
      Returns boolean
Returns Node[]

an array of {BABYLON.Node}

getClassName

getClassName(): string

Inherited from Node.getClassName

Gets a string idenfifying the name of the class

Returns string

"Node" string

getDescendants

getDescendants(directDescendantsOnly?: boolean, predicate?: function): Node[]

Inherited from Node.getDescendants

Will return all nodes that have this node as ascendant

Parameters
- Optional directDescendantsOnly: boolean
  
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optional predicate: function
  
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  - - (node: Node): boolean
    - Parameters
      - node: Node
      Returns boolean
Returns Node[]

all children nodes of all types

getDirection

getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3

Get the world direction from an axis that is in the local space of the bone

Parameters
- localAxis: Vector3
  
  The local direction that is used to compute the world direction
- Optional mesh: Nullable<AbstractMesh>
  
  The mesh that this bone is attached to
Returns Vector3

The world direction

getDirectionToRef

getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void

Copy the world direction to a vector3 from an axis that is in the local space of the bone

Parameters
- localAxis: Vector3
  
  The local direction that is used to compute the world direction
- mesh: AbstractMesh | null | undefined
  
  The mesh that this bone is attached to
- result: Vector3
  
  The vector3 that the world direction will be copied to
Returns void

getEngine

getEngine(): Engine

Inherited from Node.getEngine

Gets the engine of the node

Returns Engine

a {BABYLON.Engine}

getInvertedAbsoluteTransform

getInvertedAbsoluteTransform(): Matrix

Gets the inverse of the absolute transform matrix. This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)

Returns Matrix

a matrix

getLocalMatrix

getLocalMatrix(): Matrix

Gets the local matrix

Returns Matrix

a matrix

getLocalPositionFromAbsolute

getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3

Get the local position of a point that is in world space

Parameters
- position: Vector3
  
  The world position
- Optional mesh: Nullable<AbstractMesh>
  
  The mesh that this bone is attached to
Returns Vector3

The local position

getLocalPositionFromAbsoluteToRef

getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void

Get the local position of a point that is in world space and copy it to the result param

Parameters
- position: Vector3
  
  The world position
- mesh: AbstractMesh | null | undefined
  
  The mesh that this bone is attached to
- result: Vector3
  
  The vector3 that the local position should be copied to
Returns void

getParent

getParent(): Nullable<Bone>

Gets parent bone

Returns Nullable<Bone>

a bone or null if the bone is the root of the bone hierarchy

getPosition

getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3

Get the position of the bone in local or world space

Parameters
- Optional space: Space
  
  The space that the returned position is in
- Optional mesh: Nullable<AbstractMesh>
  
  The mesh that this bone is attached to. This is only used in world space
Returns Vector3

The position of the bone

getPositionToRef

getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void

Copy the position of the bone to a vector3 in local or world space

Parameters
- space: Space | undefined
  
  The space that the returned position is in
- mesh: Nullable<AbstractMesh>
  
  The mesh that this bone is attached to. This is only used in world space
- result: Vector3
  
  The vector3 to copy the position to
Returns void

getRestPose

getRestPose(): Matrix

Gets the rest pose matrix

Returns Matrix

a matrix

getRotation

getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3

Get the euler rotation of the bone in local or world space

Parameters
- Optional space: Space
  
  The space that the rotation should be in
- Optional mesh: Nullable<AbstractMesh>
  
  The mesh that this bone is attached to. This is only used in world space
Returns Vector3

The euler rotation

getRotationMatrix

getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix

Get the rotation matrix of the bone in local or world space

Parameters
- space: Space | undefined
  
  The space that the rotation should be in
- mesh: AbstractMesh
  
  The mesh that this bone is attached to. This is only used in world space
Returns Matrix

The rotation matrix

getRotationMatrixToRef

getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void

Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space

Parameters
- space: Space | undefined
  
  The space that the rotation should be in
- mesh: AbstractMesh
  
  The mesh that this bone is attached to. This is only used in world space
- result: Matrix
  
  The quaternion that the rotation should be copied to
Returns void

getRotationQuaternion

getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion

Get the quaternion rotation of the bone in either local or world space

Parameters
- Optional space: Space
  
  The space that the rotation should be in
- Optional mesh: Nullable<AbstractMesh>
  
  The mesh that this bone is attached to. This is only used in world space
Returns Quaternion

The quaternion rotation

getRotationQuaternionToRef

getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void

Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space

Parameters
- space: Space | undefined
  
  The space that the rotation should be in
- mesh: AbstractMesh | null | undefined
  
  The mesh that this bone is attached to. This is only used in world space
- result: Quaternion
  
  The quaternion that the rotation should be copied to
Returns void

getRotationToRef

getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void

Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space

Parameters
- space: Space | undefined
  
  The space that the rotation should be in
- mesh: AbstractMesh | null | undefined
  
  The mesh that this bone is attached to. This is only used in world space
- result: Vector3
  
  The vector3 that the rotation should be copied to
Returns void

getScale

getScale(): Vector3

Gets the current scaling in local space

Returns Vector3

the current scaling vector

getScaleToRef

getScaleToRef(result: Vector3): void

Gets the current scaling in local space and stores it in a target vector

Parameters
- result: Vector3
  
  defines the target vector
Returns void

getScene

getScene(): Scene

Inherited from Node.getScene

Gets the scene of the node

Returns Scene

a {BABYLON.Scene}

getSkeleton

getSkeleton(): Skeleton

Gets the parent skeleton

Returns Skeleton

a skeleton

getWorldMatrix

getWorldMatrix(): Matrix

Overrides Node.getWorldMatrix

Gets a matrix used to store world matrix (ie. the matrix sent to shaders)

Returns Matrix

isDescendantOf

isDescendantOf(ancestor: Node): boolean

Inherited from Node.isDescendantOf

Is this node a descendant of the given node? The function will iterate up the hierarchy until the ancestor was found or no more parents defined

Parameters
- ancestor: Node
  
  defines the parent node to inspect
Returns boolean

a boolean indicating if this node is a descendant of the given node

isDisposed

isDisposed(): boolean

Inherited from Node.isDisposed

Gets a boolean indicating if the node has been disposed

Returns boolean

true if the node was disposed

isEnabled

isEnabled(checkAncestors?: boolean): boolean

Inherited from Node.isEnabled

Is this node enabled? If the node has a parent, all ancestors will be checked and false will be returned if any are false (not enabled), otherwise will return true

Parameters
- Optional checkAncestors: boolean
  
  indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
Returns boolean

whether this node (and its parent) is enabled

isReady

isReady(completeCheck?: boolean): boolean

Inherited from Node.isReady

Is this node ready to be used/rendered

Parameters
- Optional completeCheck: boolean
  
  defines if a complete check (including materials and lights) has to be done (false by default)
Returns boolean

true if the node is ready

markAsDirty

markAsDirty(): void

Flag the bone as dirty (Forcing it to update everything)

Returns void

removeBehavior

removeBehavior(behavior: Behavior<Node>): Node

Implementation of IBehaviorAware.removeBehavior

Inherited from Node.removeBehavior

Remove an attached behavior

see

http://doc.babylonjs.com/features/behaviour

Parameters
- behavior: Behavior<Node>
  
  defines the behavior to attach
Returns Node

the current Node

returnToRest

returnToRest(): void

Sets the local matrix to rest pose matrix

Returns void

rotate

rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void

Add a rotation to the bone on an axis in local or world space

Parameters
- axis: Vector3
  
  The axis to rotate the bone on
- amount: number
  
  The amount to rotate the bone
- Optional space: Space
  
  The space that the axis is in
- Optional mesh: AbstractMesh
  
  The mesh that this bone is attached to. This is only used in world space
Returns void

scale

scale(x: number, y: number, z: number, scaleChildren?: boolean): void

Scale the bone on the x, y and z axes (in local space)

Parameters
- x: number
  
  The amount to scale the bone on the x axis
- y: number
  
  The amount to scale the bone on the y axis
- z: number
  
  The amount to scale the bone on the z axis
- Optional scaleChildren: boolean
  
  sets this to true if children of the bone should be scaled as well (false by default)
Returns void

serializeAnimationRanges

serializeAnimationRanges(): any

Inherited from Node.serializeAnimationRanges

Serialize animation ranges into a JSON compatible object

Returns any

serialization object

setAbsolutePosition

setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void

Set the absolute position of the bone (world space)

Parameters
- position: Vector3
  
  The position to set the bone
- Optional mesh: AbstractMesh
  
  The mesh that this bone is attached to
Returns void

setAxisAngle

setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void

Set the rotation of the bone to a particular axis angle in local or world space

Parameters
- axis: Vector3
  
  The axis to rotate the bone on
- angle: number
  
  The angle that the bone should be rotated to
- Optional space: Space
  
  The space that the axis is in
- Optional mesh: AbstractMesh
  
  The mesh that this bone is attached to. This is only used in world space
Returns void

setEnabled

setEnabled(value: boolean): void

Inherited from Node.setEnabled

Set the enabled state of this node

Parameters
- value: boolean
  
  defines the new enabled state
Returns void

setParent

setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void

Sets the parent bone

Parameters
- parent: Nullable<Bone>
  
  defines the parent (can be null if the bone is the root)
- Optional updateDifferenceMatrix: boolean
  
  defines if the difference matrix must be updated
Returns void

setPosition

setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void

Set the postion of the bone in local or world space

Parameters
- position: Vector3
  
  The position to set the bone
- Optional space: Space
  
  The space that the position is in
- Optional mesh: AbstractMesh
  
  The mesh that this bone is attached to. This is only used in world space
Returns void

setRotation

setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void

Set the euler rotation of the bone in local of world space

Parameters
- rotation: Vector3
  
  The euler rotation that the bone should be set to
- Optional space: Space
  
  The space that the rotation is in
- Optional mesh: AbstractMesh
  
  The mesh that this bone is attached to. This is only used in world space
Returns void

setRotationMatrix

setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void

Set the rotation matrix of the bone in local of world space

Parameters
- rotMat: Matrix
  
  The rotation matrix that the bone should be set to
- Optional space: Space
  
  The space that the rotation is in
- Optional mesh: AbstractMesh
  
  The mesh that this bone is attached to. This is only used in world space
Returns void

setRotationQuaternion

setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void

Set the quaternion rotation of the bone in local of world space

Parameters
- quat: Quaternion
  
  The quaternion rotation that the bone should be set to
- Optional space: Space
  
  The space that the rotation is in
- Optional mesh: AbstractMesh
  
  The mesh that this bone is attached to. This is only used in world space
Returns void

setScale

setScale(scale: Vector3): void

Set the bone scaling in local space

Parameters
- scale: Vector3
  
  defines the scaling vector
Returns void

setYawPitchRoll

setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void

Set the yaw, pitch, and roll of the bone in local or world space

Parameters
- yaw: number
  
  The rotation of the bone on the y axis
- pitch: number
  
  The rotation of the bone on the x axis
- roll: number
  
  The rotation of the bone on the z axis
- Optional space: Space
  
  The space that the axes of rotation are in
- Optional mesh: AbstractMesh
  
  The mesh that this bone is attached to. This is only used in world space
Returns void

translate

translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void

Translate the bone in local or world space

Parameters
- vec: Vector3
  
  The amount to translate the bone
- Optional space: Space
  
  The space that the translation is in
- Optional mesh: AbstractMesh
  
  The mesh that this bone is attached to. This is only used in world space
Returns void

updateMatrix

updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void

Update the base and local matrices

Parameters
- matrix: Matrix
  
  defines the new base or local matrix
- Optional updateDifferenceMatrix: boolean
  
  defines if the difference matrix must be updated
- Optional updateLocalMatrix: boolean
  
  defines if the local matrix should be updated
Returns void

Static ParseAnimationRanges

ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void

Inherited from Node.ParseAnimationRanges

Parse animation range data from a serialization object and store them into a given node

Parameters
- node: Node
  
  defines where to store the animation ranges
- parsedNode: any
  
  defines the serialization object to read data from
- scene: Scene
  
  defines the hosting scene
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

skeleton: Skeleton

Optional parentBone: Nullable<Bone>

Optional localMatrix: Nullable<Matrix>

Optional restPose: Nullable<Matrix>

Optional baseMatrix: Nullable<Matrix>

Optional index: Nullable<number>

Returns Bone

Properties

animationPropertiesOverride

animations

behaviors

children

doNotSerialize

id

length

metadata

name

onDispose

Type declaration

Returns void

onDisposeObservable

onReady

Type declaration

Parameters

node: Node

Returns void

parent

position

rotation

rotationQuaternion

scaling

state

uniqueId

Methods

addBehavior

Parameters

behavior: Behavior<Node>

Returns Node

beginAnimation

Parameters

name: string

Optional loop: boolean

Optional speedRatio: number

Optional onAnimationEnd: function

Returns void

Returns Nullable<Animatable>

computeAbsoluteTransforms

Returns void

computeWorldMatrix

Parameters

Optional force: boolean

Returns Matrix

copyAnimationRange

Parameters

source: Bone

rangeName: string

frameOffset: number

Optional rescaleAsRequired: boolean

Optional skelDimensionsRatio: Nullable<Vector3>

Returns boolean

createAnimationRange

Parameters

name: string

from: number

to: number

Returns void

deleteAnimationRange

Parameters

name: string

Optional deleteFrames: boolean