<?xml version="1.0" encoding="UTF-8" ?>
<class name="RetargetModifier3D" inherits="SkeletonModifier3D" api_type="core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A modifier to transfer parent skeleton poses (or global poses) to child skeletons in model space with different rests.
	</brief_description>
	<description>
		Retrieves the pose (or global pose) relative to the parent Skeleton's rest in model space and transfers it to the child Skeleton.
		This modifier rewrites the pose of the child skeleton directly in the parent skeleton's update process. This means that it overwrites the mapped bone pose set in the normal process on the target skeleton. If you want to set the target skeleton bone pose after retargeting, you will need to add a [SkeletonModifier3D] child to the target skeleton and thereby modify the pose.
		[b]Note:[/b] When the [member use_global_pose] is enabled, even if it is an unmapped bone, it can cause visual problems because the global pose is applied ignoring the parent bone's pose [b]if it has mapped bone children[/b]. See also [member use_global_pose].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="is_position_enabled" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if [member enable] has [constant TRANSFORM_FLAG_POSITION].
			</description>
		</method>
		<method name="is_rotation_enabled" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if [member enable] has [constant TRANSFORM_FLAG_ROTATION].
			</description>
		</method>
		<method name="is_scale_enabled" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if [member enable] has [constant TRANSFORM_FLAG_SCALE].
			</description>
		</method>
		<method name="set_position_enabled">
			<return type="void" />
			<param index="0" name="enabled" type="bool" />
			<description>
				Sets [constant TRANSFORM_FLAG_POSITION] into [member enable].
			</description>
		</method>
		<method name="set_rotation_enabled">
			<return type="void" />
			<param index="0" name="enabled" type="bool" />
			<description>
				Sets [constant TRANSFORM_FLAG_ROTATION] into [member enable].
			</description>
		</method>
		<method name="set_scale_enabled">
			<return type="void" />
			<param index="0" name="enabled" type="bool" />
			<description>
				Sets [constant TRANSFORM_FLAG_SCALE] into [member enable].
			</description>
		</method>
	</methods>
	<members>
		<member name="enable" type="int" setter="set_enable_flags" getter="get_enable_flags" enum="RetargetModifier3D.TransformFlag" is_bitfield="true" default="7">
			Flags to control the process of the transform elements individually when [member use_global_pose] is disabled.
		</member>
		<member name="profile" type="SkeletonProfile" setter="set_profile" getter="get_profile">
			[SkeletonProfile] for retargeting bones with names matching the bone list.
		</member>
		<member name="use_global_pose" type="bool" setter="set_use_global_pose" getter="is_using_global_pose" default="false">
			If [code]false[/code], in case the target skeleton has fewer bones than the source skeleton, the source bone parent's transform will be ignored.
			Instead, it is possible to retarget between models with different body shapes, and position, rotation, and scale can be retargeted separately.
			If [code]true[/code], retargeting is performed taking into account global pose.
			In case the target skeleton has fewer bones than the source skeleton, the source bone parent's transform is taken into account. However, bone length between skeletons must match exactly, if not, the bones will be forced to expand or shrink.
			This is useful for using dummy bone with length [code]0[/code] to match postures when retargeting between models with different number of bones.
		</member>
	</members>
	<constants>
		<constant name="TRANSFORM_FLAG_POSITION" value="1" enum="TransformFlag" is_bitfield="true">
			If set, allows to retarget the position.
		</constant>
		<constant name="TRANSFORM_FLAG_ROTATION" value="2" enum="TransformFlag" is_bitfield="true">
			If set, allows to retarget the rotation.
		</constant>
		<constant name="TRANSFORM_FLAG_SCALE" value="4" enum="TransformFlag" is_bitfield="true">
			If set, allows to retarget the scale.
		</constant>
		<constant name="TRANSFORM_FLAG_ALL" value="7" enum="TransformFlag" is_bitfield="true">
			If set, allows to retarget the position/rotation/scale.
		</constant>
	</constants>
</class>
