:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeBlendSpace1D.xml. .. _class_AnimationNodeBlendSpace1D: AnimationNodeBlendSpace1D ========================= **Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Blends linearly between two of any number of :ref:`AnimationNode` of any type placed on a virtual axis. .. rst-class:: classref-introduction-group Description ----------- A resource to add to an :ref:`AnimationNodeBlendTree`. This is a virtual axis on which you can add any type of :ref:`AnimationNode` using :ref:`add_blend_point`. Outputs the linear blend of the two :ref:`AnimationNode`\ s closest to the node's current value. You can set the extents of the axis using the :ref:`min_space` and :ref:`max_space`. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`../tutorials/animation/animation_tree` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+--------------------------------------------------------------------------+-------------+ | :ref:`float` | :ref:`max_space` | ``1.0`` | +-----------------------------+--------------------------------------------------------------------------+-------------+ | :ref:`float` | :ref:`min_space` | ``-1.0`` | +-----------------------------+--------------------------------------------------------------------------+-------------+ | :ref:`float` | :ref:`snap` | ``0.1`` | +-----------------------------+--------------------------------------------------------------------------+-------------+ | :ref:`String` | :ref:`value_label` | ``"value"`` | +-----------------------------+--------------------------------------------------------------------------+-------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_blend_point_count` **(** **)** |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`float` pos **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AnimationNodeBlendSpace1D_property_max_space: .. rst-class:: classref-property :ref:`float` **max_space** = ``1.0`` .. rst-class:: classref-property-setget - void **set_max_space** **(** :ref:`float` value **)** - :ref:`float` **get_max_space** **(** **)** The blend space's axis's upper limit for the points' position. See :ref:`add_blend_point`. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendSpace1D_property_min_space: .. rst-class:: classref-property :ref:`float` **min_space** = ``-1.0`` .. rst-class:: classref-property-setget - void **set_min_space** **(** :ref:`float` value **)** - :ref:`float` **get_min_space** **(** **)** The blend space's axis's lower limit for the points' position. See :ref:`add_blend_point`. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendSpace1D_property_snap: .. rst-class:: classref-property :ref:`float` **snap** = ``0.1`` .. rst-class:: classref-property-setget - void **set_snap** **(** :ref:`float` value **)** - :ref:`float` **get_snap** **(** **)** Position increment to snap to when moving a point on the axis. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendSpace1D_property_value_label: .. rst-class:: classref-property :ref:`String` **value_label** = ``"value"`` .. rst-class:: classref-property-setget - void **set_value_label** **(** :ref:`String` value **)** - :ref:`String` **get_value_label** **(** **)** Label of the virtual axis of the blend space. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AnimationNodeBlendSpace1D_method_add_blend_point: .. rst-class:: classref-method void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_count: .. rst-class:: classref-method :ref:`int` **get_blend_point_count** **(** **)** |const| Returns the number of points on the blend axis. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_node: .. rst-class:: classref-method :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** |const| Returns the :ref:`AnimationNode` referenced by the point at index ``point``. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_position: .. rst-class:: classref-method :ref:`float` **get_blend_point_position** **(** :ref:`int` point **)** |const| Returns the position of the point at index ``point``. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendSpace1D_method_remove_blend_point: .. rst-class:: classref-method void **remove_blend_point** **(** :ref:`int` point **)** Removes the point at index ``point`` from the blend axis. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendSpace1D_method_set_blend_point_node: .. rst-class:: classref-method void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** Changes the :ref:`AnimationNode` referenced by the point at index ``point``. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeBlendSpace1D_method_set_blend_point_position: .. rst-class:: classref-method void **set_blend_point_position** **(** :ref:`int` point, :ref:`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.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`