---
title: "Skeleton"
description: "API documentation for Skeleton"
url: https://developer.disguise.one/python-api/docs/skeleton/
---

# Skeleton

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

See also: [Stage Guide](/plugins/guides/stage)

Base class (inherits properties and methods): _[Object](/python-api/docs/object#object)_

## Properties

#### **boundingBoxOffset** : _[Vec](/python-api/docs/vec#vec)_ _(Read-Only)_

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

#### **boundingBoxScale** : _[Vec](/python-api/docs/vec#vec)_ _(Read-Only)_

Scale of the skeleton’s bounding box

#### **colour** : _[Colour](/python-api/docs/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](/python-api/docs/skeletonjoints#skeletonjoints)_

The mesh joints making up the skeleton’s structure.

#### **mesh** : _[Mesh](/python-api/docs/mesh#mesh)_

The mesh that defines the shape of the object

_UserName: Mesh_

#### **renderSettings** : _PropRenderer_

Render settings for the skeleton visualisation in the stage.

#### **skinnedMesh** : _[SkinnedMesh2](/python-api/docs/skinnedmesh2#skinnedmesh2)_

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

#### **trackingJoints** : _[SkeletonJoints](/python-api/docs/skeletonjoints#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, meshId: _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.

**Parameters**:

-   meshId: The ID of the mesh joint which the tracking joint retargets to.
-   trackingId: The ID of the tracking joint which retargets to the mesh joint.

#### **zeroPose**(self)

Zeroes the pose of the skeleton, setting all joints to their default layout position.