Skeleton3D

Inherits: Node3D < Node < Object

A node containing a bone hierarchy, used to create a 3D skeletal animation.

Description

Skeleton3D provides an interface for managing a hierarchy of 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 bone pose. Bone rest defines the initial transform of the bone pose.

Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it is 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

• 3D Inverse Kinematics Demo

• Third Person Shooter Demo

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