godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with latest 4.0-dev

Browse Source
This commit is contained in:
Rémi Verschelde
2021-10-05 16:09:21 +02:00
parent 6952796767
commit f6f6c1bf19
958 changed files with 113054 additions and 52009 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
classes/class_rootmotionview.rst
View File

@@ -9,9 +9,21 @@
RootMotionView
==============
**Inherits:** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherits:** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Editor-only helper for setting up root motion in :ref:`AnimationTree<class_AnimationTree>`.
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:`AnimationTree<class_AnimationTree>`.
**Note:** ``RootMotionView`` is only visible in the editor. It will be hidden automatically in the running project, and will also be converted to a plain :ref:`Node<class_Node>` in the running project. This means a script attached to a ``RootMotionView`` node *must* have ``extends Node`` instead of ``extends RootMotionView``. Additionally, it must not be a ``@tool`` script.
Tutorials
---------
- `#root-motion <../tutorials/animation/animation_tree.html#root-motion>`_ in :doc:`../tutorials/animation/animation_tree`
Properties
----------
@@ -41,6 +53,8 @@ Property Descriptions
| *Getter* | get_animation_path() |
+----------+---------------------------+
Path to an :ref:`AnimationTree<class_AnimationTree>` node to use as a basis for root motion.
----
.. _class_RootMotionView_property_cell_size:
@@ -53,6 +67,8 @@ Property Descriptions
| *Getter* | get_cell_size() |
+----------+----------------------+
The grid's cell size in 3D units.
----
.. _class_RootMotionView_property_color:
@@ -65,6 +81,8 @@ Property Descriptions
| *Getter* | get_color() |
+----------+------------------+
The grid's color.
----
.. _class_RootMotionView_property_radius:
@@ -77,6 +95,8 @@ Property Descriptions
| *Getter* | 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<class_RootMotionView_property_radius>` is reached.
----
.. _class_RootMotionView_property_zero_y:
@@ -89,3 +109,11 @@ Property Descriptions
| *Getter* | 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.)`