:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoneMap.xml. .. _class_BoneMap: BoneMap ======= **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Describes a mapping of bone names for retargeting :ref:`Skeleton3D` into common names defined by a :ref:`SkeletonProfile`. .. rst-class:: classref-introduction-group Description ----------- This class contains a dictionary that uses a list of bone names in :ref:`SkeletonProfile` as key names. By assigning the actual :ref:`Skeleton3D` bone name as the key value, it maps the :ref:`Skeleton3D` to the :ref:`SkeletonProfile`. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Retargeting 3D Skeletons <../tutorials/assets_pipeline/retargeting_3d_skeletons>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------+------------------------------------------------+ | :ref:`SkeletonProfile` | :ref:`profile` | +-----------------------------------------------+------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`find_profile_bone_name`\ (\ skeleton_bone_name\: :ref:`StringName`\ ) |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_skeleton_bone_name`\ (\ profile_bone_name\: :ref:`StringName`\ ) |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_skeleton_bone_name`\ (\ profile_bone_name\: :ref:`StringName`, skeleton_bone_name\: :ref:`StringName`\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_BoneMap_signal_bone_map_updated: .. rst-class:: classref-signal **bone_map_updated**\ (\ ) :ref:`🔗` This signal is emitted when change the key value in the **BoneMap**. This is used to validate mapping and to update **BoneMap** editor. .. rst-class:: classref-item-separator ---- .. _class_BoneMap_signal_profile_updated: .. rst-class:: classref-signal **profile_updated**\ (\ ) :ref:`🔗` 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. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_BoneMap_property_profile: .. rst-class:: classref-property :ref:`SkeletonProfile` **profile** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_profile**\ (\ value\: :ref:`SkeletonProfile`\ ) - :ref:`SkeletonProfile` **get_profile**\ (\ ) A :ref:`SkeletonProfile` of the mapping target. Key names in the **BoneMap** are synchronized with it. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_BoneMap_method_find_profile_bone_name: .. rst-class:: classref-method :ref:`StringName` **find_profile_bone_name**\ (\ skeleton_bone_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns a profile bone name having ``skeleton_bone_name``. If not found, an empty :ref:`StringName` will be returned. In the retargeting process, the returned bone name is the bone name of the target skeleton. .. rst-class:: classref-item-separator ---- .. _class_BoneMap_method_get_skeleton_bone_name: .. rst-class:: classref-method :ref:`StringName` **get_skeleton_bone_name**\ (\ profile_bone_name\: :ref:`StringName`\ ) |const| :ref:`🔗` 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. .. rst-class:: classref-item-separator ---- .. _class_BoneMap_method_set_skeleton_bone_name: .. rst-class:: classref-method |void| **set_skeleton_bone_name**\ (\ profile_bone_name\: :ref:`StringName`, skeleton_bone_name\: :ref:`StringName`\ ) :ref:`🔗` 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. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`