Sync classref with current source

This commit is contained in:
Rémi Verschelde
2019-06-16 11:23:24 +02:00
parent 5c4340d30c
commit eef7baf24c
19 changed files with 501 additions and 18 deletions

View File

@@ -14,7 +14,7 @@ AnimationNodeBlendSpace1D
Brief Description
-----------------
Blends linearly between two of any number of :ref:`AnimationNode<class_AnimationNode>` of any type placed on a virtual axis.
Properties
----------
@@ -48,6 +48,17 @@ Methods
| void | :ref:`set_blend_point_position<class_AnimationNodeBlendSpace1D_method_set_blend_point_position>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
This is a virtual axis on which you can add any type of :ref:`AnimationNode<class_AnimationNode>` using :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
Outputs the linear blend of the two ``AnimationNode`` closest to the node's current ``value``.
You can set the extents of the axis using the :ref:`min_space<class_AnimationNodeBlendSpace1D_property_min_space>` and :ref:`max_space<class_AnimationNodeBlendSpace1D_property_max_space>`.
Property Descriptions
---------------------
@@ -61,6 +72,8 @@ Property Descriptions
| *Getter* | get_max_space() |
+----------+----------------------+
The blend space's axis's upper limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
.. _class_AnimationNodeBlendSpace1D_property_min_space:
- :ref:`float<class_float>` **min_space**
@@ -71,6 +84,8 @@ Property Descriptions
| *Getter* | get_min_space() |
+----------+----------------------+
The blend space's axis's lower limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
.. _class_AnimationNodeBlendSpace1D_property_snap:
- :ref:`float<class_float>` **snap**
@@ -81,6 +96,8 @@ Property Descriptions
| *Getter* | get_snap() |
+----------+-----------------+
Position increment to snap to when moving a point on the axis.
.. _class_AnimationNodeBlendSpace1D_property_value_label:
- :ref:`String<class_String>` **value_label**
@@ -91,6 +108,8 @@ Property Descriptions
| *Getter* | get_value_label() |
+----------+------------------------+
Label of the virtual axis of the blend space.
Method Descriptions
-------------------
@@ -98,27 +117,41 @@ Method Descriptions
- void **add_blend_point** **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`float<class_float>` pos, :ref:`int<class_int>` at_index=-1 **)**
Add a new point that represents a ``node`` on the virtual axis at a given position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array.
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_count:
- :ref:`int<class_int>` **get_blend_point_count** **(** **)** const
Returns the number of points on the blend axis.
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_node:
- :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** const
Returns the ``AnimationNode`` referenced by the point at index ``point``.
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_position:
- :ref:`float<class_float>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** const
Returns the position of the point at index ``point``.
.. _class_AnimationNodeBlendSpace1D_method_remove_blend_point:
- void **remove_blend_point** **(** :ref:`int<class_int>` point **)**
Removes the point at index ``point`` from the blend axis.
.. _class_AnimationNodeBlendSpace1D_method_set_blend_point_node:
- void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)**
Changes the AnimationNode referenced by the point at index ``point``.
.. _class_AnimationNodeBlendSpace1D_method_set_blend_point_position:
- void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)**
Updates the position of the point at index ``point`` on the blend axis.