BoneMap

Inherits: Resource < RefCounted < Object

Bone map for retargeting.

Description

This class contains a hashmap that uses a list of bone names in SkeletonProfile as key names.

By assigning the actual Skeleton3D bone name as the key value, it maps the Skeleton3D to the SkeletonProfile.

Properties

SkeletonProfile

profile

Methods

StringName

find_profile_bone_name ( StringName skeleton_bone_name ) const

StringName

get_skeleton_bone_name ( StringName profile_bone_name ) const

void

set_skeleton_bone_name ( StringName profile_bone_name, StringName skeleton_bone_name )

Signals

  • bone_map_updated ( )

This signal is emitted when change the key value in the BoneMap. This is used to validate mapping and to update BoneMap editor.


  • profile_updated ( )

This signal is emitted when change the value in profile or change the reference of profile. This is used to update key names in the BoneMap and to redraw the BoneMap editor.

Property Descriptions

Setter

set_profile(value)

Getter

get_profile()

A SkeletonProfile of the mapping target. Key names in the BoneMap are synchronized with it.

Method Descriptions

Returns a profile bone name having skeleton_bone_name. If not found, an empty StringName will be returned.

In the retargeting process, the returned bone name is the bone name of the target skeleton.


Returns a skeleton bone name is mapped to profile_bone_name.

In the retargeting process, the returned bone name is the bone name of the source skeleton.


Maps a skeleton bone name to profile_bone_name.

In the retargeting process, the setting bone name is the bone name of the source skeleton.