Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 7a86ac6a30
Branches Tags
godot-docs
/
classes
/
class_animationnodeblendspace1d.rst

class_animationnodeblendspace1d.rst 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlendSpace1D.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_AnimationNodeBlendSpace1D:
    8. 

  8. 

  9. AnimationNodeBlendSpace1D
    10. 

  10. =========================
    11. 

  11. 

  12. **Inherits:** :ref:`AnimationRootNode<class_AnimationRootNode>` **<** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Blends linearly between two of any number of :ref:`AnimationNode<class_AnimationNode>` of any type placed on a virtual axis.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
    20. 

  20. 

  21. 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>`.
    22. 

  22. 

  23. Outputs the linear blend of the two :ref:`AnimationNode<class_AnimationNode>`\ s closest to the node's current value.
    24. 

  24. 

  25. 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>`.
    26. 

  26. 

  27. Tutorials
    28. 

  28. ---------
    29. 

  29. 

  30. - :doc:`../tutorials/animation/animation_tree`
    31. 

  31. 

  32. Properties
    33. 

  33. ----------
    34. 

  34. 

  35. +-----------------------------+--------------------------------------------------------------------------+-------------+
    36. 

  36. | :ref:`float<class_float>`   | :ref:`max_space<class_AnimationNodeBlendSpace1D_property_max_space>`     | ``1.0``     |
    37. 

  37. +-----------------------------+--------------------------------------------------------------------------+-------------+
    38. 

  38. | :ref:`float<class_float>`   | :ref:`min_space<class_AnimationNodeBlendSpace1D_property_min_space>`     | ``-1.0``    |
    39. 

  39. +-----------------------------+--------------------------------------------------------------------------+-------------+
    40. 

  40. | :ref:`float<class_float>`   | :ref:`snap<class_AnimationNodeBlendSpace1D_property_snap>`               | ``0.1``     |
    41. 

  41. +-----------------------------+--------------------------------------------------------------------------+-------------+
    42. 

  42. | :ref:`String<class_String>` | :ref:`value_label<class_AnimationNodeBlendSpace1D_property_value_label>` | ``"value"`` |
    43. 

  43. +-----------------------------+--------------------------------------------------------------------------+-------------+
    44. 

  44. 

  45. Methods
    46. 

  46. -------
    47. 

  47. 

  48. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | 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 **)** |
    50. 

  50. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | :ref:`int<class_int>`                             | :ref:`get_blend_point_count<class_AnimationNodeBlendSpace1D_method_get_blend_point_count>` **(** **)** |const|                                                                                                      |
    52. 

  52. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. | :ref:`AnimationRootNode<class_AnimationRootNode>` | :ref:`get_blend_point_node<class_AnimationNodeBlendSpace1D_method_get_blend_point_node>` **(** :ref:`int<class_int>` point **)** |const|                                                                            |
    54. 

  54. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55. | :ref:`float<class_float>`                         | :ref:`get_blend_point_position<class_AnimationNodeBlendSpace1D_method_get_blend_point_position>` **(** :ref:`int<class_int>` point **)** |const|                                                                    |
    56. 

  56. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57. | void                                              | :ref:`remove_blend_point<class_AnimationNodeBlendSpace1D_method_remove_blend_point>` **(** :ref:`int<class_int>` point **)**                                                                                        |
    58. 

  58. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59. | void                                              | :ref:`set_blend_point_node<class_AnimationNodeBlendSpace1D_method_set_blend_point_node>` **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)**                            |
    60. 

  60. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61. | void                                              | :ref:`set_blend_point_position<class_AnimationNodeBlendSpace1D_method_set_blend_point_position>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)**                                             |
    62. 

  62. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    63. 

  63. 

  64. Property Descriptions
    65. 

  65. ---------------------
    66. 

  66. 

  67. .. _class_AnimationNodeBlendSpace1D_property_max_space:
    68. 

  68. 

  69. - :ref:`float<class_float>` **max_space**
    70. 

  70. 

  71. +-----------+----------------------+
    72. 

  72. | *Default* | ``1.0``              |
    73. 

  73. +-----------+----------------------+
    74. 

  74. | *Setter*  | set_max_space(value) |
    75. 

  75. +-----------+----------------------+
    76. 

  76. | *Getter*  | get_max_space()      |
    77. 

  77. +-----------+----------------------+
    78. 

  78. 

  79. The blend space's axis's upper limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
    80. 

  80. 

  81. ----
    82. 

  82. 

  83. .. _class_AnimationNodeBlendSpace1D_property_min_space:
    84. 

  84. 

  85. - :ref:`float<class_float>` **min_space**
    86. 

  86. 

  87. +-----------+----------------------+
    88. 

  88. | *Default* | ``-1.0``             |
    89. 

  89. +-----------+----------------------+
    90. 

  90. | *Setter*  | set_min_space(value) |
    91. 

  91. +-----------+----------------------+
    92. 

  92. | *Getter*  | get_min_space()      |
    93. 

  93. +-----------+----------------------+
    94. 

  94. 

  95. The blend space's axis's lower limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
    96. 

  96. 

  97. ----
    98. 

  98. 

  99. .. _class_AnimationNodeBlendSpace1D_property_snap:
    100. 

  100. 

  101. - :ref:`float<class_float>` **snap**
    102. 

  102. 

  103. +-----------+-----------------+
    104. 

  104. | *Default* | ``0.1``         |
    105. 

  105. +-----------+-----------------+
    106. 

  106. | *Setter*  | set_snap(value) |
    107. 

  107. +-----------+-----------------+
    108. 

  108. | *Getter*  | get_snap()      |
    109. 

  109. +-----------+-----------------+
    110. 

  110. 

  111. Position increment to snap to when moving a point on the axis.
    112. 

  112. 

  113. ----
    114. 

  114. 

  115. .. _class_AnimationNodeBlendSpace1D_property_value_label:
    116. 

  116. 

  117. - :ref:`String<class_String>` **value_label**
    118. 

  118. 

  119. +-----------+------------------------+
    120. 

  120. | *Default* | ``"value"``            |
    121. 

  121. +-----------+------------------------+
    122. 

  122. | *Setter*  | set_value_label(value) |
    123. 

  123. +-----------+------------------------+
    124. 

  124. | *Getter*  | get_value_label()      |
    125. 

  125. +-----------+------------------------+
    126. 

  126. 

  127. Label of the virtual axis of the blend space.
    128. 

  128. 

  129. Method Descriptions
    130. 

  130. -------------------
    131. 

  131. 

  132. .. _class_AnimationNodeBlendSpace1D_method_add_blend_point:
    133. 

  133. 

  134. - void **add_blend_point** **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`float<class_float>` pos, :ref:`int<class_int>` at_index=-1 **)**
    135. 

  135. 

  136. 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.
    137. 

  137. 

  138. ----
    139. 

  139. 

  140. .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_count:
    141. 

  141. 

  142. - :ref:`int<class_int>` **get_blend_point_count** **(** **)** |const|
    143. 

  143. 

  144. Returns the number of points on the blend axis.
    145. 

  145. 

  146. ----
    147. 

  147. 

  148. .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_node:
    149. 

  149. 

  150. - :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** |const|
    151. 

  151. 

  152. Returns the :ref:`AnimationNode<class_AnimationNode>` referenced by the point at index ``point``.
    153. 

  153. 

  154. ----
    155. 

  155. 

  156. .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_position:
    157. 

  157. 

  158. - :ref:`float<class_float>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** |const|
    159. 

  159. 

  160. Returns the position of the point at index ``point``.
    161. 

  161. 

  162. ----
    163. 

  163. 

  164. .. _class_AnimationNodeBlendSpace1D_method_remove_blend_point:
    165. 

  165. 

  166. - void **remove_blend_point** **(** :ref:`int<class_int>` point **)**
    167. 

  167. 

  168. Removes the point at index ``point`` from the blend axis.
    169. 

  169. 

  170. ----
    171. 

  171. 

  172. .. _class_AnimationNodeBlendSpace1D_method_set_blend_point_node:
    173. 

  173. 

  174. - void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)**
    175. 

  175. 

  176. Changes the :ref:`AnimationNode<class_AnimationNode>` referenced by the point at index ``point``.
    177. 

  177. 

  178. ----
    179. 

  179. 

  180. .. _class_AnimationNodeBlendSpace1D_method_set_blend_point_position:
    181. 

  181. 

  182. - void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)**
    183. 

  183. 

  184. Updates the position of the point at index ``point`` on the blend axis.
    185. 

  185. 

  186. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    187. 

  187. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    188. 

  188. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    189. 

  189.