Struct Skeleton

Skeleton for characters and animated objects.

struct Skeleton ;

Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see Animation). It can also use ragdoll physics. The overall transform of a bone with respect to the skeleton is determined by the following hierarchical order: rest pose, custom pose and pose. Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it not the actual global/world transform of the bone.

Methods

NameDescription
addBone Adds a bone, with name name. getBoneCount will become the bone index.
bindChildNodeToBone Deprecated soon.
clearBones Clear all the bones in this skeleton.
findBone Returns the bone index that matches name as its name.
getBoneCount Returns the amount of bones in the skeleton.
getBoneCustomPose Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose.
getBoneGlobalPose Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone.
getBoneName Returns the name of the bone at index index.
getBoneParent Returns the bone index which is the parent of the bone at bone_idx. If -1, then bone has no parent. Note: The parent bone returned will always be less than bone_idx.
getBonePose Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose.
getBoneRest Returns the rest transform for a bone bone_idx.
getBoundChildNodesToBone Deprecated soon.
isBoneRestDisabled
localizeRests
physicalBonesAddCollisionException
physicalBonesRemoveCollisionException
physicalBonesStartSimulation
physicalBonesStopSimulation
registerSkin
setBoneCustomPose
setBoneDisableRest
setBoneGlobalPoseOverride
setBoneParent Sets the bone index parent_idx as the parent of the bone at bone_idx. If -1, then bone has no parent. Note: parent_idx must be less than bone_idx.
setBonePose Returns the pose transform for bone bone_idx.
setBoneRest Sets the rest transform for bone bone_idx.
unbindChildNodeFromBone Deprecated soon.
unparentBoneAndRest

Enums

NameDescription
Constants