: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/ConvertTransformModifier3D.xml. .. _class_ConvertTransformModifier3D: ConvertTransformModifier3D ========================== **Inherits:** :ref:`BoneConstraint3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A :ref:`SkeletonModifier3D` that apply transform to the bone which converted from reference. .. rst-class:: classref-introduction-group Description ----------- Apply the copied transform of the bone set by :ref:`BoneConstraint3D.set_reference_bone()` to the bone set by :ref:`BoneConstraint3D.set_apply_bone()` about the specific axis with remapping it with some options. There are 4 ways to apply the transform, depending on the combination of :ref:`set_relative()` and :ref:`set_additive()`. \ **Relative + Additive:**\ - Extract reference pose relative to the rest and add it to the apply bone's pose. \ **Relative + Not Additive:**\ - Extract reference pose relative to the rest and add it to the apply bone's rest. \ **Not Relative + Additive:**\ - Extract reference pose absolutely and add it to the apply bone's pose. \ **Not Relative + Not Additive:**\ - Extract reference pose absolutely and the apply bone's pose is replaced with it. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------+-------------------------------------------------------------------------------+-------+ | :ref:`int` | :ref:`setting_count` | ``0`` | +-----------------------+-------------------------------------------------------------------------------+-------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Axis` | :ref:`get_apply_axis`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_apply_range_max`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_apply_range_min`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TransformMode` | :ref:`get_apply_transform_mode`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Axis` | :ref:`get_reference_axis`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_reference_range_max`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_reference_range_min`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TransformMode` | :ref:`get_reference_transform_mode`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_additive`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_relative`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_additive`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_apply_axis`\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_apply_range_max`\ (\ index\: :ref:`int`, range_max\: :ref:`float`\ ) | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_apply_range_min`\ (\ index\: :ref:`int`, range_min\: :ref:`float`\ ) | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_apply_transform_mode`\ (\ index\: :ref:`int`, transform_mode\: :ref:`TransformMode`\ ) | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_reference_axis`\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_reference_range_max`\ (\ index\: :ref:`int`, range_max\: :ref:`float`\ ) | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_reference_range_min`\ (\ index\: :ref:`int`, range_min\: :ref:`float`\ ) | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_reference_transform_mode`\ (\ index\: :ref:`int`, transform_mode\: :ref:`TransformMode`\ ) | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_relative`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_ConvertTransformModifier3D_TransformMode: .. rst-class:: classref-enumeration enum **TransformMode**: :ref:`🔗` .. _class_ConvertTransformModifier3D_constant_TRANSFORM_MODE_POSITION: .. rst-class:: classref-enumeration-constant :ref:`TransformMode` **TRANSFORM_MODE_POSITION** = ``0`` Convert with position. Transfer the difference. .. _class_ConvertTransformModifier3D_constant_TRANSFORM_MODE_ROTATION: .. rst-class:: classref-enumeration-constant :ref:`TransformMode` **TRANSFORM_MODE_ROTATION** = ``1`` Convert with rotation. The angle is the roll for the specified axis. .. _class_ConvertTransformModifier3D_constant_TRANSFORM_MODE_SCALE: .. rst-class:: classref-enumeration-constant :ref:`TransformMode` **TRANSFORM_MODE_SCALE** = ``2`` Convert with scale. Transfers the ratio, not the difference. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ConvertTransformModifier3D_property_setting_count: .. rst-class:: classref-property :ref:`int` **setting_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_setting_count**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_setting_count**\ (\ ) The number of settings in the modifier. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ConvertTransformModifier3D_method_get_apply_axis: .. rst-class:: classref-method :ref:`Axis` **get_apply_axis**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the axis of the remapping destination transform. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_get_apply_range_max: .. rst-class:: classref-method :ref:`float` **get_apply_range_max**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the maximum value of the remapping destination range. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_get_apply_range_min: .. rst-class:: classref-method :ref:`float` **get_apply_range_min**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the minimum value of the remapping destination range. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_get_apply_transform_mode: .. rst-class:: classref-method :ref:`TransformMode` **get_apply_transform_mode**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the operation of the remapping destination transform. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_get_reference_axis: .. rst-class:: classref-method :ref:`Axis` **get_reference_axis**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the axis of the remapping source transform. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_get_reference_range_max: .. rst-class:: classref-method :ref:`float` **get_reference_range_max**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the maximum value of the remapping source range. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_get_reference_range_min: .. rst-class:: classref-method :ref:`float` **get_reference_range_min**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the minimum value of the remapping source range. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_get_reference_transform_mode: .. rst-class:: classref-method :ref:`TransformMode` **get_reference_transform_mode**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the operation of the remapping source transform. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_is_additive: .. rst-class:: classref-method :ref:`bool` **is_additive**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the additive option is enabled in the setting at ``index``. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_is_relative: .. rst-class:: classref-method :ref:`bool` **is_relative**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the relative option is enabled in the setting at ``index``. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_set_additive: .. rst-class:: classref-method |void| **set_additive**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets additive option in the setting at ``index`` to ``enabled``. This mainly affects the process of applying transform to the :ref:`BoneConstraint3D.set_apply_bone()`. If sets ``enabled`` to ``true``, the processed transform is added to the pose of the current apply bone. If sets ``enabled`` to ``false``, the pose of the current apply bone is replaced with the processed transform. However, if set :ref:`set_relative()` to ``true``, the transform is relative to rest. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_set_apply_axis: .. rst-class:: classref-method |void| **set_apply_axis**\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) :ref:`🔗` Sets the axis of the remapping destination transform. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_set_apply_range_max: .. rst-class:: classref-method |void| **set_apply_range_max**\ (\ index\: :ref:`int`, range_max\: :ref:`float`\ ) :ref:`🔗` Sets the maximum value of the remapping destination range. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_set_apply_range_min: .. rst-class:: classref-method |void| **set_apply_range_min**\ (\ index\: :ref:`int`, range_min\: :ref:`float`\ ) :ref:`🔗` Sets the minimum value of the remapping destination range. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_set_apply_transform_mode: .. rst-class:: classref-method |void| **set_apply_transform_mode**\ (\ index\: :ref:`int`, transform_mode\: :ref:`TransformMode`\ ) :ref:`🔗` Sets the operation of the remapping destination transform. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_set_reference_axis: .. rst-class:: classref-method |void| **set_reference_axis**\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) :ref:`🔗` Sets the axis of the remapping source transform. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_set_reference_range_max: .. rst-class:: classref-method |void| **set_reference_range_max**\ (\ index\: :ref:`int`, range_max\: :ref:`float`\ ) :ref:`🔗` Sets the maximum value of the remapping source range. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_set_reference_range_min: .. rst-class:: classref-method |void| **set_reference_range_min**\ (\ index\: :ref:`int`, range_min\: :ref:`float`\ ) :ref:`🔗` Sets the minimum value of the remapping source range. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_set_reference_transform_mode: .. rst-class:: classref-method |void| **set_reference_transform_mode**\ (\ index\: :ref:`int`, transform_mode\: :ref:`TransformMode`\ ) :ref:`🔗` Sets the operation of the remapping source transform. .. rst-class:: classref-item-separator ---- .. _class_ConvertTransformModifier3D_method_set_relative: .. rst-class:: classref-method |void| **set_relative**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets relative option in the setting at ``index`` to ``enabled``. If sets ``enabled`` to ``true``, the extracted and applying transform is relative to the rest. If sets ``enabled`` to ``false``, the extracted transform is absolute. .. |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.)`