class_skeleton

Skeleton

Inherits: Spatial\n\n

Brief Description

Skeleton for characters and animated objects.

Member Functions

void add_bone ( String name )
int find_bone ( String name ) const
String get_bone_name ( int bone_idx ) const
int get_bone_parent ( int bone_idx ) const
void set_bone_parent ( int bone_idx, int parent_idx )
int get_bone_count ( ) const
Transform get_bone_rest ( int bone_idx ) const
void set_bone_rest ( int bone_idx, Transform rest )
void bind_child_node_to_bone ( int bone_idx, Node node )
void unbind_child_node_from_bone ( int bone_idx, Node node )
Array get_bound_child_nodes_to_bone ( int bone_idx ) const
void clear_bones ( )
Transform get_bone_pose ( int bone_idx ) const
void set_bone_pose ( int bone_idx, Transform pose )
Transform get_bone_custom_pose ( int bone_idx ) const
void set_bone_custom_pose ( int bone_idx, Transform custom_pose )
Transform get_bone_transform ( int bone_idx ) const

Numeric Constants

NOTIFICATION_UPDATE_SKELETON = 50

Description

Skeleton provides a hierachial interface for managing bones, including pose, rest and animation (see animation). Skeleton will support rag doll dynamics in the future.

Member Function Description

add_bone

void add_bone ( String name ) \ Add a bone, with name "name". #get_bone_count will become the bone index.

find_bone

int find_bone ( String name ) const \ Return the bone index that matches "name" as its name.

get_bone_name

String get_bone_name ( int bone_idx ) const \ Return the name of the bone at index "index"

get_bone_parent

int get_bone_parent ( int bone_idx ) const \ Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx".

set_bone_parent

void set_bone_parent ( int bone_idx, int parent_idx ) \ Set 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".