: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/SplineIK3D.xml. .. _class_SplineIK3D: SplineIK3D ========== **Inherits:** :ref:`ChainIK3D` **<** :ref:`IKModifier3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A :ref:`SkeletonModifier3D` for aligning bones along a :ref:`Path3D`. .. rst-class:: classref-introduction-group Description ----------- A :ref:`SkeletonModifier3D` for aligning bones along a :ref:`Path3D`. The smoothness of the fitting depends on the :ref:`Curve3D.bake_interval`. If you want the :ref:`Path3D` to attach to a specific bone, it is recommended to place a :ref:`ModifierBoneTarget3D` before the **SplineIK3D** in the :ref:`SkeletonModifier3D` list (children of the :ref:`Skeleton3D`), and then place a :ref:`Path3D` as the :ref:`ModifierBoneTarget3D`'s child. Bone twist is determined based on the :ref:`Curve3D.get_point_tilt()`. If the root bone joint and the start point of the :ref:`Curve3D` are separated, it assumes that there is a linear line segment between them. This means that the vector pointing toward the start point of the :ref:`Curve3D` takes precedence over the shortest intersection point along the :ref:`Curve3D`. If the end bone joint exceeds the path length, it is bent as close as possible to the end point of the :ref:`Curve3D`. .. 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:`NodePath` | :ref:`get_path_3d`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tilt_fade_in`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tilt_fade_out`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_tilt_enabled`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_path_3d`\ (\ index\: :ref:`int`, path_3d\: :ref:`NodePath`\ ) | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_tilt_enabled`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_tilt_fade_in`\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_tilt_fade_out`\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) | +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SplineIK3D_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. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SplineIK3D_method_get_path_3d: .. rst-class:: classref-method :ref:`NodePath` **get_path_3d**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the node path of the :ref:`Path3D` which is describing the path. .. rst-class:: classref-item-separator ---- .. _class_SplineIK3D_method_get_tilt_fade_in: .. rst-class:: classref-method :ref:`int` **get_tilt_fade_in**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tilt interpolation method used between the root bone and the start point of the :ref:`Curve3D` when they are apart. See also :ref:`set_tilt_fade_in()`. .. rst-class:: classref-item-separator ---- .. _class_SplineIK3D_method_get_tilt_fade_out: .. rst-class:: classref-method :ref:`int` **get_tilt_fade_out**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the tilt interpolation method used between the end bone and the end point of the :ref:`Curve3D` when they are apart. See also :ref:`set_tilt_fade_out()`. .. rst-class:: classref-item-separator ---- .. _class_SplineIK3D_method_is_tilt_enabled: .. rst-class:: classref-method :ref:`bool` **is_tilt_enabled**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns if the tilt property of the :ref:`Curve3D` affects the bone twist. .. rst-class:: classref-item-separator ---- .. _class_SplineIK3D_method_set_path_3d: .. rst-class:: classref-method |void| **set_path_3d**\ (\ index\: :ref:`int`, path_3d\: :ref:`NodePath`\ ) :ref:`🔗` Sets the node path of the :ref:`Path3D` which is describing the path. .. rst-class:: classref-item-separator ---- .. _class_SplineIK3D_method_set_tilt_enabled: .. rst-class:: classref-method |void| **set_tilt_enabled**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` Sets if the tilt property of the :ref:`Curve3D` should affect the bone twist. .. rst-class:: classref-item-separator ---- .. _class_SplineIK3D_method_set_tilt_fade_in: .. rst-class:: classref-method |void| **set_tilt_fade_in**\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) :ref:`🔗` If ``size`` is greater than ``0``, the tilt is interpolated between ``size`` start bones from the start point of the :ref:`Curve3D` when they are apart. If ``size`` is equal ``0``, the tilts between the root bone head and the start point of the :ref:`Curve3D` are unified with a tilt of the start point of the :ref:`Curve3D`. If ``size`` is less than ``0``, the tilts between the root bone and the start point of the :ref:`Curve3D` are ``0.0``. .. rst-class:: classref-item-separator ---- .. _class_SplineIK3D_method_set_tilt_fade_out: .. rst-class:: classref-method |void| **set_tilt_fade_out**\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) :ref:`🔗` If ``size`` is greater than ``0``, the tilt is interpolated between ``size`` end bones from the end point of the :ref:`Curve3D` when they are apart. If ``size`` is equal ``0``, the tilts between the end bone tail and the end point of the :ref:`Curve3D` are unified with a tilt of the end point of the :ref:`Curve3D`. If ``size`` is less than ``0``, the tilts between the end bone and the end point of the :ref:`Curve3D` are ``0.0``. .. |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.)`