Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Bone

Class used to store bone information

see

https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

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 hierarchy

    Returns Bone

Properties

animationsSearch playground for animations

animations: Animation[]

Gets the animations associated with this bone

childrenSearch playground for children

children: Bone[]

Gets the list of child bones

idSearch playground for id

id: string

Gets or sets the id of the node

inspectableCustomPropertiesSearch playground for inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

see

https://doc.babylonjs.com/how_to/debug_layer#extensibility

lengthSearch playground for length

length: number

Gets or sets bone length

metadataSearch playground for metadata

metadata: any

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

nameSearch playground for name

name: string

defines the bone name

onDisposeObservableSearch playground for onDisposeObservable

onDisposeObservable: Observable<Node>

An event triggered when the mesh is disposed

onReadySearch playground for onReady

onReady: Nullable<(node: Node) => void>

Callback raised when the node is ready to be used

reservedDataStoreSearch playground for reservedDataStore

reservedDataStore: any

For internal use only. Please do not use.

stateSearch playground for state

state: string

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

uniqueIdSearch playground for uniqueId

uniqueId: number

Gets or sets the unique id of the node

Accessors

animationPropertiesOverride

behaviors

doNotSerialize

  • get doNotSerialize(): boolean
  • set doNotSerialize(value: boolean): any
  • Gets or sets a boolean used to define if the node must be serialized

    Returns boolean

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

    Parameters

    • value: boolean

    Returns any

onDispose

  • set onDispose(callback: () => void): any
  • Sets a callback that will be raised when the node will be disposed

    Parameters

    • callback: () => void
        • (): void
        • Returns void

    Returns any

parent

position

  • Gets or sets current position (in local space)

    Returns Vector3

  • Gets or sets current position (in local space)

    Parameters

    Returns any

rotation

  • Gets or sets current rotation (in local space)

    Returns Vector3

  • Gets or sets current rotation (in local space)

    Parameters

    Returns any

rotationQuaternion

  • Gets or sets current rotation quaternion (in local space)

    Returns Quaternion

  • Gets or sets current rotation quaternion (in local space)

    Parameters

    Returns any

scaling

  • Gets or sets current scaling (in local space)

    Returns Vector3

  • Gets or sets current scaling (in local space)

    Parameters

    Returns any

worldMatrixFromCache

  • get worldMatrixFromCache(): Matrix
  • Returns directly the latest state of the mesh World matrix. A Matrix is returned.

    Returns Matrix

Methods

addBehaviorSearch playground for addBehavior

beginAnimationSearch playground for beginAnimation

  • beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>
  • 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: () => void

      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

computeAbsoluteTransformsSearch playground for computeAbsoluteTransforms

  • computeAbsoluteTransforms(): void
  • Compute the absolute transforms of this bone and its children

    Returns void

computeWorldMatrixSearch playground for computeWorldMatrix

  • computeWorldMatrix(force?: boolean): Matrix
  • 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

copyAnimationRangeSearch playground for 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

    • rescaleAsRequired: boolean

      defines if rescaling must be applied if required

    • skelDimensionsRatio: Nullable<Vector3>

      defines the scaling ratio

    Returns boolean

    true if operation was successful

createAnimationRangeSearch playground for createAnimationRange

  • createAnimationRange(name: string, from: number, to: number): void
  • 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

deleteAnimationRangeSearch playground for deleteAnimationRange

  • deleteAnimationRange(name: string, deleteFrames?: boolean): void
  • 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

disposeSearch playground for dispose

  • dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void
  • 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

getAbsolutePositionSearch playground for getAbsolutePosition

  • Get the absolute position of the bone (world space)

    Parameters

    Returns Vector3

    The absolute position of the bone

getAbsolutePositionFromLocalSearch playground for getAbsolutePositionFromLocal

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

    Parameters

    Returns Vector3

    The world position

getAbsolutePositionFromLocalToRefSearch playground for getAbsolutePositionFromLocalToRef

  • 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: Nullable<AbstractMesh> | undefined

      The mesh that this bone is attached to

    • result: Vector3

      The vector3 that the world position should be copied to

    Returns void

getAbsolutePositionToRefSearch playground for getAbsolutePositionToRef

  • 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

getAbsoluteTransformSearch playground for getAbsoluteTransform

  • getAbsoluteTransform(): Matrix
  • Gets the absolute transform matrix (ie base matrix * parent world matrix)

    Returns Matrix

    a matrix

getAnimationByNameSearch playground for 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

getAnimationRangeSearch playground for 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

getAnimationRangesSearch playground for getAnimationRanges

getBaseMatrixSearch playground for getBaseMatrix

  • Gets the base matrix (initial matrix which remains unchanged)

    Returns Matrix

    a matrix

getBehaviorByNameSearch playground for getBehaviorByName

getBindPoseSearch playground for getBindPose

  • Gets the bind pose matrix

    Returns Matrix

    the bind pose matrix

getChildMeshesSearch playground for getChildMeshes

  • getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[]
  • 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 (Default: false)

    • Optional predicate: (node: Node) => boolean

      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

          Returns boolean

    Returns AbstractMesh[]

    an array of AbstractMesh

getChildrenSearch playground for getChildren

  • getChildren(): Array<Bone>
  • Returns an array containing the root bones

    Returns Array<Bone>

    an array containing the root bones

getClassNameSearch playground for getClassName

  • getClassName(): string
  • Gets the current object class name.

    Returns string

    the class name

getDescendantsSearch playground for getDescendants

  • getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[]
  • 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: (node: Node) => boolean

      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

          Returns boolean

    Returns Node[]

    all children nodes of all types

getDirectionSearch playground for getDirection

  • 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

getDirectionToRefSearch playground for getDirectionToRef

  • 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: Nullable<AbstractMesh> | undefined

      The mesh that this bone is attached to

    • result: Vector3

      The vector3 that the world direction will be copied to

    Returns void

getEngineSearch playground for getEngine

  • Gets the engine of the node

    Returns Engine

    a Engine

getHierarchyBoundingVectorsSearch playground for getHierarchyBoundingVectors

  • Return the minimum and maximum world vectors of the entire hierarchy under current node

    Parameters

    • Optional includeDescendants: boolean

      Include bounding info from descendants as well (true by default)

    • Optional predicate: Nullable<(abstractMesh: AbstractMesh) => boolean>

      defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors

    Returns { max: Vector3; min: Vector3 }

    the new bounding vectors

getIndexSearch playground for getIndex

  • getIndex(): number
  • Gets the node index in matrix array generated for rendering

    Returns number

    the node index

getInvertedAbsoluteTransformSearch playground for 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

getLocalMatrixSearch playground for getLocalMatrix

  • Gets the local matrix

    Returns Matrix

    a matrix

getLocalPositionFromAbsoluteSearch playground for getLocalPositionFromAbsolute

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

    Parameters

    Returns Vector3

    The local position

getLocalPositionFromAbsoluteToRefSearch playground for getLocalPositionFromAbsoluteToRef

  • 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: Nullable<AbstractMesh> | undefined

      The mesh that this bone is attached to

    • result: Vector3

      The vector3 that the local position should be copied to

    Returns void

getParentSearch playground for getParent

  • Gets parent bone

    Returns Nullable<Bone>

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

getPositionSearch playground for getPosition

  • 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

getPositionToRefSearch playground for getPositionToRef

  • 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

getRestPoseSearch playground for getRestPose

  • Gets the rest pose matrix

    Returns Matrix

    a matrix

getRotationSearch playground for getRotation

  • 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

getRotationMatrixSearch playground for getRotationMatrix

  • 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

getRotationMatrixToRefSearch playground for getRotationMatrixToRef

  • 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

getRotationQuaternionSearch playground for getRotationQuaternion

  • 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

getRotationQuaternionToRefSearch playground for getRotationQuaternionToRef

  • 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: Nullable<AbstractMesh> | 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

getRotationToRefSearch playground for getRotationToRef

  • 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: Nullable<AbstractMesh> | 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

getScaleSearch playground for getScale

  • Gets the current scaling in local space

    Returns Vector3

    the current scaling vector

getScaleToRefSearch playground for 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

getSceneSearch playground for getScene

  • Gets the scene of the node

    Returns Scene

    a scene

getSkeletonSearch playground for getSkeleton

  • Gets the parent skeleton

    Returns Skeleton

    a skeleton

getTransformNodeSearch playground for getTransformNode

  • Gets the node used to drive the bone's transformation

    Returns Nullable<TransformNode>

    a transform node or null

getWorldMatrixSearch playground for getWorldMatrix

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

    Returns Matrix

isDescendantOfSearch playground for isDescendantOf

  • isDescendantOf(ancestor: Node): boolean
  • 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

isDisposedSearch playground for isDisposed

  • isDisposed(): boolean
  • Gets a boolean indicating if the node has been disposed

    Returns boolean

    true if the node was disposed

isEnabledSearch playground for isEnabled

  • isEnabled(checkAncestors?: boolean): boolean
  • 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

isReadySearch playground for isReady

  • isReady(completeCheck?: boolean): boolean
  • 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

linkTransformNodeSearch playground for linkTransformNode

  • Links with the given transform node. The local matrix of this bone is copied from the transform node every frame.

    Parameters

    Returns void

markAsDirtySearch playground for markAsDirty

  • markAsDirty(): void
  • Flag the bone as dirty (Forcing it to update everything)

    Returns void

removeBehaviorSearch playground for removeBehavior

returnToRestSearch playground for returnToRest

  • returnToRest(): void
  • Sets the local matrix to rest pose matrix

    Returns void

rotateSearch playground for rotate

  • 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

scaleSearch playground for 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

serializeAnimationRangesSearch playground for serializeAnimationRanges

  • serializeAnimationRanges(): any
  • Serialize animation ranges into a JSON compatible object

    Returns any

    serialization object

setAbsolutePositionSearch playground for setAbsolutePosition

  • 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

setAxisAngleSearch playground for setAxisAngle

  • 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

setBindPoseSearch playground for setBindPose

  • setBindPose(matrix: Matrix): void
  • Sets the bind pose matrix

    Parameters

    • matrix: Matrix

      the local-space bind pose to set for this bone

    Returns void

setCurrentPoseAsRestSearch playground for setCurrentPoseAsRest

  • setCurrentPoseAsRest(): void
  • Set the current local matrix as the restPose for this bone.

    Returns void

setEnabledSearch playground for setEnabled

  • setEnabled(value: boolean): void
  • Set the enabled state of this node

    Parameters

    • value: boolean

      defines the new enabled state

    Returns void

setParentSearch playground for 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

setPositionSearch playground for setPosition

  • Set the position 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

setRestPoseSearch playground for setRestPose

  • setRestPose(matrix: Matrix): void
  • Sets the rest pose matrix

    Parameters

    • matrix: Matrix

      the local-space rest pose to set for this bone

    Returns void

setRotationSearch playground for setRotation

  • Set the euler rotation of the bone in local or 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

setRotationMatrixSearch playground for setRotationMatrix

  • Set the rotation matrix of the bone in local or 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

setRotationQuaternionSearch playground for setRotationQuaternion

  • Set the quaternion rotation of the bone in local or 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

setScaleSearch playground for setScale

  • Set the bone scaling in local space

    Parameters

    • scale: Vector3

      defines the scaling vector

    Returns void

setYawPitchRollSearch playground for 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

translateSearch playground for translate

  • 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

updateMatrixSearch playground for 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 AddNodeConstructorSearch playground for AddNodeConstructor

  • Add a new node constructor

    Parameters

    • type: string

      defines the type name of the node to construct

    • constructorFunc: NodeConstructor

      defines the constructor function

    Returns void

Static ConstructSearch playground for Construct

  • Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>
  • Returns a node constructor based on type name

    Parameters

    • type: string

      defines the type name

    • name: string

      defines the new node name

    • scene: Scene

      defines the hosting scene

    • Optional options: any

      defines optional options to transmit to constructors

    Returns Nullable<() => Node>

    the new constructor or null

Static ParseAnimationRangesSearch playground for ParseAnimationRanges

  • ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void
  • 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

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Static property
  • Static method