Skeleton3D

Inherits: Node3D < Node < Object

Skeleton for characters and animated objects.

Description

Skeleton3D 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.

To setup different types of inverse kinematics, consider using SkeletonIK3D, or add a custom IK implementation in Node._process as a child node.

Tutorials

Properties

bool

animate_physical_bones

true

float

motion_scale

1.0

bool

show_rest_only

false

Methods

void

add_bone ( String name )

void

clear_bones ( )

void

clear_bones_global_pose_override ( )

Skin

create_skin_from_rest_transforms ( )

int

find_bone ( String name ) const

void

force_update_all_bone_transforms ( )

void

force_update_bone_child_transform ( int bone_idx )

PackedInt32Array

get_bone_children ( int bone_idx ) const

int

get_bone_count ( ) const

Transform3D

get_bone_global_pose ( int bone_idx ) const

Transform3D

get_bone_global_pose_no_override ( int bone_idx ) const

Transform3D

get_bone_global_pose_override ( int bone_idx ) const

Transform3D

get_bone_global_rest ( int bone_idx ) const

String

get_bone_name ( int bone_idx ) const

int

get_bone_parent ( int bone_idx ) const

Transform3D

get_bone_pose ( int bone_idx ) const

Vector3

get_bone_pose_position ( int bone_idx ) const

Quaternion

get_bone_pose_rotation ( int bone_idx ) const

Vector3

get_bone_pose_scale ( int bone_idx ) const

Transform3D

get_bone_rest ( int bone_idx ) const

PackedInt32Array

get_parentless_bones ( ) const

int

get_version ( ) const

bool

is_bone_enabled ( int bone_idx ) const

void

localize_rests ( )

void

physical_bones_add_collision_exception ( RID exception )

void

physical_bones_remove_collision_exception ( RID exception )

void

physical_bones_start_simulation ( StringName[] bones=[] )

void

physical_bones_stop_simulation ( )

SkinReference

register_skin ( Skin skin )

void

reset_bone_pose ( int bone_idx )

void

reset_bone_poses ( )

void

set_bone_enabled ( int bone_idx, bool enabled=true )

void

set_bone_global_pose_override ( int bone_idx, Transform3D pose, float amount, bool persistent=false )

void

set_bone_name ( int bone_idx, String name )

void

set_bone_parent ( int bone_idx, int parent_idx )

void

set_bone_pose_position ( int bone_idx, Vector3 position )

void

set_bone_pose_rotation ( int bone_idx, Quaternion rotation )

void

set_bone_pose_scale ( int bone_idx, Vector3 scale )

void

set_bone_rest ( int bone_idx, Transform3D rest )

void

unparent_bone_and_rest ( int bone_idx )


Signals

bone_enabled_changed ( int bone_idx )

There is currently no description for this signal. Please help us by contributing one!


bone_pose_changed ( int bone_idx )

This signal is emitted when one of the bones in the Skeleton3D node have changed their pose. This is used to inform nodes that rely on bone positions that one of the bones in the Skeleton3D have changed their transform/pose.


pose_updated ( )

There is currently no description for this signal. Please help us by contributing one!


show_rest_only_changed ( )

There is currently no description for this signal. Please help us by contributing one!


Constants

NOTIFICATION_UPDATE_SKELETON = 50


Property Descriptions

bool animate_physical_bones = true

  • void set_animate_physical_bones ( bool value )

  • bool get_animate_physical_bones ( )

There is currently no description for this property. Please help us by contributing one!


float motion_scale = 1.0

  • void set_motion_scale ( float value )

  • float get_motion_scale ( )

Multiplies the position 3D track animation.

Note: Unless this value is 1.0, the key value in animation will not match the actual position value.


bool show_rest_only = false

  • void set_show_rest_only ( bool value )

  • bool is_show_rest_only ( )

There is currently no description for this property. Please help us by contributing one!


Method Descriptions

void add_bone ( String name )

Adds a bone, with name name. get_bone_count will become the bone index.


void clear_bones ( )

Clear all the bones in this skeleton.


void clear_bones_global_pose_override ( )

Removes the global pose override on all bones in the skeleton.


Skin create_skin_from_rest_transforms ( )

There is currently no description for this method. Please help us by contributing one!


int find_bone ( String name ) const

Returns the bone index that matches name as its name.


void force_update_all_bone_transforms ( )

Force updates the bone transforms/poses for all bones in the skeleton.


void force_update_bone_child_transform ( int bone_idx )

Force updates the bone transform for the bone at bone_idx and all of its children.


PackedInt32Array get_bone_children ( int bone_idx ) const

Returns an array containing the bone indexes of all the children node of the passed in bone, bone_idx.


int get_bone_count ( ) const

Returns the number of bones in the skeleton.


Transform3D get_bone_global_pose ( int bone_idx ) const

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.


Transform3D get_bone_global_pose_no_override ( int bone_idx ) const

Returns the overall transform of the specified bone, with respect to the skeleton, but without any global pose overrides. Being relative to the skeleton frame, this is not the actual "global" transform of the bone.


Transform3D get_bone_global_pose_override ( int bone_idx ) const

Returns the global pose override transform for bone_idx.


Transform3D get_bone_global_rest ( int bone_idx ) const

Returns the global rest transform for bone_idx.


String get_bone_name ( int bone_idx ) const

Returns the name of the bone at index bone_idx.


int get_bone_parent ( int bone_idx ) const

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.


Transform3D get_bone_pose ( int bone_idx ) const

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.


Vector3 get_bone_pose_position ( int bone_idx ) const

There is currently no description for this method. Please help us by contributing one!


Quaternion get_bone_pose_rotation ( int bone_idx ) const

There is currently no description for this method. Please help us by contributing one!


Vector3 get_bone_pose_scale ( int bone_idx ) const

There is currently no description for this method. Please help us by contributing one!


Transform3D get_bone_rest ( int bone_idx ) const

Returns the rest transform for a bone bone_idx.


PackedInt32Array get_parentless_bones ( ) const

Returns an array with all of the bones that are parentless. Another way to look at this is that it returns the indexes of all the bones that are not dependent or modified by other bones in the Skeleton.


int get_version ( ) const

Returns the number of times the bone hierarchy has changed within this skeleton, including renames.

The Skeleton version is not serialized: only use within a single instance of Skeleton3D.

Use for invalidating caches in IK solvers and other nodes which process bones.


bool is_bone_enabled ( int bone_idx ) const

Returns whether the bone pose for the bone at bone_idx is enabled.


void localize_rests ( )

Returns all bones in the skeleton to their rest poses.


void physical_bones_add_collision_exception ( RID exception )

Adds a collision exception to the physical bone.

Works just like the RigidBody3D node.


void physical_bones_remove_collision_exception ( RID exception )

Removes a collision exception to the physical bone.

Works just like the RigidBody3D node.


void physical_bones_start_simulation ( StringName[] bones=[] )

Tells the PhysicalBone3D nodes in the Skeleton to start simulating and reacting to the physics world.

Optionally, a list of bone names can be passed-in, allowing only the passed-in bones to be simulated.


void physical_bones_stop_simulation ( )

Tells the PhysicalBone3D nodes in the Skeleton to stop simulating.


SkinReference register_skin ( Skin skin )

Binds the given Skin to the Skeleton.


void reset_bone_pose ( int bone_idx )

Sets the bone pose to rest for bone_idx.


void reset_bone_poses ( )

Sets all bone poses to rests.


void set_bone_enabled ( int bone_idx, bool enabled=true )

Disables the pose for the bone at bone_idx if false, enables the bone pose if true.


void set_bone_global_pose_override ( int bone_idx, Transform3D pose, float amount, bool persistent=false )

Sets the global pose transform, pose, for the bone at bone_idx.

amount is the interpolation strength that will be used when applying the pose, and persistent determines if the applied pose will remain.

Note: The pose transform needs to be a global pose! To convert a world transform from a Node3D to a global bone pose, multiply the Transform3D.affine_inverse of the node's Node3D.global_transform by the desired world transform


void set_bone_name ( int bone_idx, String name )

There is currently no description for this method. Please help us by contributing one!


void set_bone_parent ( int bone_idx, int parent_idx )

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.


void set_bone_pose_position ( int bone_idx, Vector3 position )

There is currently no description for this method. Please help us by contributing one!


void set_bone_pose_rotation ( int bone_idx, Quaternion rotation )

There is currently no description for this method. Please help us by contributing one!


void set_bone_pose_scale ( int bone_idx, Vector3 scale )

There is currently no description for this method. Please help us by contributing one!


void set_bone_rest ( int bone_idx, Transform3D rest )

Sets the rest transform for bone bone_idx.


void unparent_bone_and_rest ( int bone_idx )

Unparents the bone at bone_idx and sets its rest position to that of its parent prior to being reset.