Skeleton

A rigged skeleton object consisting of a bone structure and an optional skinned mesh.

Category: Stage

Base class: Object

Properties

boundingBoxOffset : Vec (Read-Only)

Offset of the skeleton’s bounding box centre relative to the root joint

boundingBoxScale : Vec (Read-Only)

Scale of the skeleton’s bounding box

colour : Colour

The color of the bones drawn in the skeleton visualisation.

Category: Appearance
UserName: Bone colour

displayJointLabels : bool

Whether to display joint labels in the skeleton visualisation.

Category: Appearance
UserName: Display joint labels

drawBones : bool

Whether to draw bones in the skeleton visualisation.

Category: Appearance
UserName: Draw bones

drawNodes : bool

Whether to draw joint nodes in the skeleton visualisation.

Category: Appearance
UserName: Draw nodes

joints : SkeletonJoints

The mesh joints making up the skeleton’s structure.

mesh : Mesh

The mesh that defines the shape of the object

UserName: Mesh

renderSettings : PropRenderer

Render settings for the skeleton visualisation in the stage.

Category: Appearance

skinnedMesh : SkinnedMesh2

The skinned mesh which deforms with the movement of the skeleton’s bones.

trackingJoints : SkeletonJoints

The skeleton’s tracked joints. These may be different to the mesh joints if tracking data is being retargeted.

Variables

JOINT_ID_INVALID : Final[int] = 18446744073709551615

Methods

clearReferencePoints(self)

Clear all the reference points attached to the joints of this skeleton.

createReferencePoints(self)

Create reference points attached to each joint in the skeleton.

getJointRetargeting(self, trackingId: int) -> int

Returns the retargeting joint for a given mesh joint ID.

Parameters:

meshId: The mesh ID to query.

Returns The corresponding tracking joint ID for the given mesh ID, or JOINT_ID_INVALID if no retargeting is defined.

resetToDefault(self)

Resets to the default humanoid skeleton layout and pose.

setJointRetargeting(self, trackingId: int, meshId: int)

Set the joint retargeting mapping for a specific joint.

This method links a tracking joint to retarget to an equivalent mesh joint.