| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212 |
- :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/AnimationNodeBlendSpace1D.xml.
- .. _class_AnimationNodeBlendSpace1D:
- AnimationNodeBlendSpace1D
- =========================
- **Inherits:** :ref:`AnimationRootNode<class_AnimationRootNode>` **<** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Blends linearly between two of any number of :ref:`AnimationNode<class_AnimationNode>` of any type placed on a virtual axis.
- 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 :ref:`AnimationNode<class_AnimationNode>`\ s 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>`.
- Tutorials
- ---------
- - :doc:`AnimationTree <../tutorials/animation/animation_tree>`
- Properties
- ----------
- +-----------------------------+--------------------------------------------------------------------------+-------------+
- | :ref:`float<class_float>` | :ref:`max_space<class_AnimationNodeBlendSpace1D_property_max_space>` | ``1.0`` |
- +-----------------------------+--------------------------------------------------------------------------+-------------+
- | :ref:`float<class_float>` | :ref:`min_space<class_AnimationNodeBlendSpace1D_property_min_space>` | ``-1.0`` |
- +-----------------------------+--------------------------------------------------------------------------+-------------+
- | :ref:`float<class_float>` | :ref:`snap<class_AnimationNodeBlendSpace1D_property_snap>` | ``0.1`` |
- +-----------------------------+--------------------------------------------------------------------------+-------------+
- | :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlendSpace1D_property_sync>` | ``false`` |
- +-----------------------------+--------------------------------------------------------------------------+-------------+
- | :ref:`String<class_String>` | :ref:`value_label<class_AnimationNodeBlendSpace1D_property_value_label>` | ``"value"`` |
- +-----------------------------+--------------------------------------------------------------------------+-------------+
- Methods
- -------
- +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>` **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`float<class_float>` pos, :ref:`int<class_int>` at_index=-1 **)** |
- +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_blend_point_count<class_AnimationNodeBlendSpace1D_method_get_blend_point_count>` **(** **)** |const| |
- +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`AnimationRootNode<class_AnimationRootNode>` | :ref:`get_blend_point_node<class_AnimationNodeBlendSpace1D_method_get_blend_point_node>` **(** :ref:`int<class_int>` point **)** |const| |
- +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_blend_point_position<class_AnimationNodeBlendSpace1D_method_get_blend_point_position>` **(** :ref:`int<class_int>` point **)** |const| |
- +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_blend_point<class_AnimationNodeBlendSpace1D_method_remove_blend_point>` **(** :ref:`int<class_int>` point **)** |
- +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_blend_point_node<class_AnimationNodeBlendSpace1D_method_set_blend_point_node>` **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)** |
- +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_blend_point_position<class_AnimationNodeBlendSpace1D_method_set_blend_point_position>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)** |
- +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_AnimationNodeBlendSpace1D_property_max_space:
- - :ref:`float<class_float>` **max_space**
- +-----------+----------------------+
- | *Default* | ``1.0`` |
- +-----------+----------------------+
- | *Setter* | set_max_space(value) |
- +-----------+----------------------+
- | *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**
- +-----------+----------------------+
- | *Default* | ``-1.0`` |
- +-----------+----------------------+
- | *Setter* | set_min_space(value) |
- +-----------+----------------------+
- | *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**
- +-----------+-----------------+
- | *Default* | ``0.1`` |
- +-----------+-----------------+
- | *Setter* | set_snap(value) |
- +-----------+-----------------+
- | *Getter* | get_snap() |
- +-----------+-----------------+
- Position increment to snap to when moving a point on the axis.
- ----
- .. _class_AnimationNodeBlendSpace1D_property_sync:
- - :ref:`bool<class_bool>` **sync**
- +-----------+---------------------+
- | *Default* | ``false`` |
- +-----------+---------------------+
- | *Setter* | set_use_sync(value) |
- +-----------+---------------------+
- | *Getter* | is_using_sync() |
- +-----------+---------------------+
- If ``false``, the blended animations' frame are stopped when the blend value is ``0``.
- If ``true``, forcing the blended animations to advance frame.
- ----
- .. _class_AnimationNodeBlendSpace1D_property_value_label:
- - :ref:`String<class_String>` **value_label**
- +-----------+------------------------+
- | *Default* | ``"value"`` |
- +-----------+------------------------+
- | *Setter* | set_value_label(value) |
- +-----------+------------------------+
- | *Getter* | get_value_label() |
- +-----------+------------------------+
- Label of the virtual axis of the blend space.
- Method Descriptions
- -------------------
- .. _class_AnimationNodeBlendSpace1D_method_add_blend_point:
- - void **add_blend_point** **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`float<class_float>` pos, :ref:`int<class_int>` at_index=-1 **)**
- Adds 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 :ref:`AnimationNode<class_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 :ref:`AnimationNode<class_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.
- .. |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.)`
|
