implement bone renamer in importer

5 files changed, 185 insertions, 1 deletions

diff --git a/doc/classes/BoneMap.xml b/doc/classes/BoneMap.xml
new file mode 100644
index 0000000000..371cb4fa93
--- /dev/null
+++ b/doc/classes/BoneMap.xml
@@ -0,0 +1,56 @@
+<?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>
diff --git a/doc/classes/EditorScenePostImportPlugin.xml b/doc/classes/EditorScenePostImportPlugin.xml
index 0fdbd5db1e..93fd5e46ba 100644
--- a/doc/classes/EditorScenePostImportPlugin.xml
+++ b/doc/classes/EditorScenePostImportPlugin.xml
@@ -114,7 +114,9 @@
 		</constant>
 		<constant name="INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE" value="5" enum="InternalImportCategory">
 		</constant>
-		<constant name="INTERNAL_IMPORT_CATEGORY_MAX" value="6" enum="InternalImportCategory">
+		<constant name="INTERNAL_IMPORT_CATEGORY_SKELETON_3D_NODE" value="6" enum="InternalImportCategory">
+		</constant>
+		<constant name="INTERNAL_IMPORT_CATEGORY_MAX" value="7" enum="InternalImportCategory">
 		</constant>
 	</constants>
 </class>
diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml
index 00c5dcaa3d..d9e0680a38 100644
--- a/doc/classes/NodePath.xml
+++ b/doc/classes/NodePath.xml
@@ -87,6 +87,12 @@
 				[/codeblocks]
 			</description>
 		</method>
+		<method name="get_concatenated_names" qualifiers="const">
+			<return type="StringName" />
+			<description>
+				Returns all paths concatenated with a slash character ([code]/[/code]) as separator without subnames.
+			</description>
+		</method>
 		<method name="get_concatenated_subnames" qualifiers="const">
 			<return type="StringName" />
 			<description>
diff --git a/doc/classes/SkeletonProfile.xml b/doc/classes/SkeletonProfile.xml
new file mode 100644
index 0000000000..55a2ea6759
--- /dev/null
+++ b/doc/classes/SkeletonProfile.xml
@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="SkeletonProfile" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+	<brief_description>
+		Profile of a virtual skeleton used as a target for retargeting.
+	</brief_description>
+	<description>
+		This resource is used in [EditorScenePostImport]. Some parameters are referring to bones in [Skeleton3D], [Skin], [Animation], and some other nodes are rewritten based on the parameters of [SkeletonProfile].
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+		<method name="get_bone_name" qualifiers="const">
+			<return type="StringName" />
+			<argument index="0" name="bone_idx" type="int" />
+			<description>
+				Returns the name of the bone at [code]bone_idx[/code] that will be the key name in the [BoneMap].
+				In the retargeting process, the returned bone name is the bone name of the target skeleton.
+			</description>
+		</method>
+		<method name="get_group" qualifiers="const">
+			<return type="StringName" />
+			<argument index="0" name="bone_idx" type="int" />
+			<description>
+				Returns the group of the bone at [code]bone_idx[/code].
+			</description>
+		</method>
+		<method name="get_group_name" qualifiers="const">
+			<return type="StringName" />
+			<argument index="0" name="group_idx" type="int" />
+			<description>
+				Returns the name of the group at [code]group_idx[/code] that will be the drawing group in the [BoneMap] editor.
+			</description>
+		</method>
+		<method name="get_handle_offset" qualifiers="const">
+			<return type="Vector2" />
+			<argument index="0" name="bone_idx" type="int" />
+			<description>
+				Returns the offset of the bone at [code]bone_idx[/code] that will be the button position in the [BoneMap] editor.
+				This is the offset with origin at the top left corner of the square.
+			</description>
+		</method>
+		<method name="get_texture" qualifiers="const">
+			<return type="Texture2D" />
+			<argument index="0" name="group_idx" type="int" />
+			<description>
+				Returns the texture of the group at [code]group_idx[/code] that will be the drawing group background image in the [BoneMap] editor.
+			</description>
+		</method>
+		<method name="set_bone_name">
+			<return type="void" />
+			<argument index="0" name="bone_idx" type="int" />
+			<argument index="1" name="bone_name" type="StringName" />
+			<description>
+				Sets the name of the bone at [code]bone_idx[/code] that will be the key name in the [BoneMap].
+				In the retargeting process, the setting bone name is the bone name of the target skeleton.
+			</description>
+		</method>
+		<method name="set_group">
+			<return type="void" />
+			<argument index="0" name="bone_idx" type="int" />
+			<argument index="1" name="group" type="StringName" />
+			<description>
+				Sets the group of the bone at [code]bone_idx[/code].
+			</description>
+		</method>
+		<method name="set_group_name">
+			<return type="void" />
+			<argument index="0" name="group_idx" type="int" />
+			<argument index="1" name="group_name" type="StringName" />
+			<description>
+				Sets the name of the group at [code]group_idx[/code] that will be the drawing group in the [BoneMap] editor.
+			</description>
+		</method>
+		<method name="set_handle_offset">
+			<return type="void" />
+			<argument index="0" name="bone_idx" type="int" />
+			<argument index="1" name="handle_offset" type="Vector2" />
+			<description>
+				Sets the offset of the bone at [code]bone_idx[/code] that will be the button position in the [BoneMap] editor.
+				This is the offset with origin at the top left corner of the square.
+			</description>
+		</method>
+		<method name="set_texture">
+			<return type="void" />
+			<argument index="0" name="group_idx" type="int" />
+			<argument index="1" name="texture" type="Texture2D" />
+			<description>
+				Sets the texture of the group at [code]group_idx[/code] that will be the drawing group background image in the [BoneMap] editor.
+			</description>
+		</method>
+	</methods>
+	<members>
+		<member name="bone_size" type="int" setter="set_bone_size" getter="get_bone_size" default="0">
+		</member>
+		<member name="group_size" type="int" setter="set_group_size" getter="get_group_size" default="0">
+		</member>
+	</members>
+	<signals>
+		<signal name="profile_updated">
+			<description>
+				This signal is emitted when change the value in profile. This is used to update key name in the [BoneMap] and to redraw the [BoneMap] editor.
+				[b]Note[/b]: This signal is not connected directly to editor to simplify the reference, instead it is passed on to editor through the [BoneMap].
+			</description>
+		</signal>
+	</signals>
+</class>
diff --git a/doc/classes/SkeletonProfileHumanoid.xml b/doc/classes/SkeletonProfileHumanoid.xml
new file mode 100644
index 0000000000..065184244e
--- /dev/null
+++ b/doc/classes/SkeletonProfileHumanoid.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="SkeletonProfileHumanoid" inherits="SkeletonProfile" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+	<brief_description>
+	</brief_description>
+	<description>
+		A [SkeletonProfile] as a preset that is optimized for the human form. This exists for standardization, so all parameters are read-only.
+	</description>
+	<tutorials>
+	</tutorials>
+	<members>
+		<member name="bone_size" type="int" setter="set_bone_size" getter="get_bone_size" overrides="SkeletonProfile" default="56" />
+		<member name="group_size" type="int" setter="set_group_size" getter="get_group_size" overrides="SkeletonProfile" default="4" />
+	</members>
+</class>