: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/RootMotionView.xml. .. _class_RootMotionView: RootMotionView ============== **Inherits:** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` Editor-only helper for setting up root motion in :ref:`AnimationMixer`. .. rst-class:: classref-introduction-group Description ----------- *Root motion* refers to an animation technique where a mesh's skeleton is used to give impulse to a character. When working with 3D animations, a popular technique is for animators to use the root skeleton bone to give motion to the rest of the skeleton. This allows animating characters in a way where steps actually match the floor below. It also allows precise interaction with objects during cinematics. See also :ref:`AnimationMixer`. \ **Note:** **RootMotionView** is only visible in the editor. It will be hidden automatically in the running project. .. rst-class:: classref-introduction-group Tutorials --------- - `Using AnimationTree - Root motion <../tutorials/animation/animation_tree.html#root-motion>`__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------+---------------------------------------------------------------------+---------------------------+ | :ref:`NodePath` | :ref:`animation_path` | ``NodePath("")`` | +---------------------------------+---------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`cell_size` | ``1.0`` | +---------------------------------+---------------------------------------------------------------------+---------------------------+ | :ref:`Color` | :ref:`color` | ``Color(0.5, 0.5, 1, 1)`` | +---------------------------------+---------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`radius` | ``10.0`` | +---------------------------------+---------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`zero_y` | ``true`` | +---------------------------------+---------------------------------------------------------------------+---------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_RootMotionView_property_animation_path: .. rst-class:: classref-property :ref:`NodePath` **animation_path** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_animation_path**\ (\ value\: :ref:`NodePath`\ ) - :ref:`NodePath` **get_animation_path**\ (\ ) Path to an :ref:`AnimationMixer` node to use as a basis for root motion. .. rst-class:: classref-item-separator ---- .. _class_RootMotionView_property_cell_size: .. rst-class:: classref-property :ref:`float` **cell_size** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_cell_size**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_cell_size**\ (\ ) The grid's cell size in 3D units. .. rst-class:: classref-item-separator ---- .. _class_RootMotionView_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color(0.5, 0.5, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_color**\ (\ ) The grid's color. .. rst-class:: classref-item-separator ---- .. _class_RootMotionView_property_radius: .. rst-class:: classref-property :ref:`float` **radius** = ``10.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_radius**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_radius**\ (\ ) The grid's radius in 3D units. The grid's opacity will fade gradually as the distance from the origin increases until this :ref:`radius` is reached. .. rst-class:: classref-item-separator ---- .. _class_RootMotionView_property_zero_y: .. rst-class:: classref-property :ref:`bool` **zero_y** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_zero_y**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_zero_y**\ (\ ) If ``true``, the grid's points will all be on the same Y coordinate (*local* Y = 0). If ``false``, the points' original Y coordinate is preserved. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |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.)`