57 lines
2.5 KiB
XML
57 lines
2.5 KiB
XML
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||
|
|
<class name="BoneMap" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||
|
|
<brief_description>
|
||
|
|
Bone map for retargeting.
|
||
|
|
</brief_description>
|
||
|
|
<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].
|
||
|
|
</description>
|
||
|
|
<tutorials>
|
||
|
|
</tutorials>
|
||
|
|
<methods>
|
||
|
|
<method name="find_profile_bone_name" qualifiers="const">
|
||
|
|
<return type="StringName" />
|
||
|
|
<argument index="0" name="skeleton_bone_name" type="StringName" />
|
||
|
|
<description>
|
||
|
|
Returns a profile bone name having [code]skeleton_bone_name[/code]. 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.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_skeleton_bone_name" qualifiers="const">
|
||
|
|
<return type="StringName" />
|
||
|
|
<argument index="0" name="profile_bone_name" type="StringName" />
|
||
|
|
<description>
|
||
|
|
Returns a skeleton bone name is mapped to [code]profile_bone_name[/code].
|
||
|
|
In the retargeting process, the returned bone name is the bone name of the source skeleton.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_skeleton_bone_name">
|
||
|
|
<return type="void" />
|
||
|
|
<argument index="0" name="profile_bone_name" type="StringName" />
|
||
|
|
<argument index="1" name="skeleton_bone_name" type="StringName" />
|
||
|
|
<description>
|
||
|
|
Maps a skeleton bone name to [code]profile_bone_name[/code].
|
||
|
|
In the retargeting process, the setting bone name is the bone name of the source skeleton.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
</methods>
|
||
|
|
<members>
|
||
|
|
<member name="profile" type="SkeletonProfile" setter="set_profile" getter="get_profile">
|
||
|
|
A [SkeletonProfile] of the mapping target. Key names in the [BoneMap] are synchronized with it.
|
||
|
|
</member>
|
||
|
|
</members>
|
||
|
|
<signals>
|
||
|
|
<signal name="bone_map_updated">
|
||
|
|
<description>
|
||
|
|
This signal is emitted when change the key value in the [BoneMap]. This is used to validate mapping and to update [BoneMap] editor.
|
||
|
|
</description>
|
||
|
|
</signal>
|
||
|
|
<signal name="profile_updated">
|
||
|
|
<description>
|
||
|
|
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.
|
||
|
|
</description>
|
||
|
|
</signal>
|
||
|
|
</signals>
|
||
|
|
</class>
|