2018-07-26 17:56:21 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 16:08:05 +08:00
<class name= "AnimationNodeBlendSpace1D" inherits= "AnimationRootNode" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2018-07-26 17:56:21 +08:00
<brief_description >
2023-04-28 23:16:44 +08:00
A set of [AnimationRootNode]s placed on a virtual axis, crossfading between the two adjacent ones. Used by [AnimationTree].
2018-07-26 17:56:21 +08:00
</brief_description>
<description >
2023-04-28 23:16:44 +08:00
A resource used by [AnimationNodeBlendTree].
[AnimationNodeBlendSpace1D] represents a virtual axis on which any type of [AnimationRootNode]s can be added using [method add_blend_point]. Outputs the linear blend of the two [AnimationRootNode]s adjacent to the current value.
You can set the extents of the axis with [member min_space] and [member max_space].
2018-07-26 17:56:21 +08:00
</description>
<tutorials >
2023-04-28 23:16:44 +08:00
<link title= "Using AnimationTree" > $DOCS_URL/tutorials/animation/animation_tree.html</link>
2018-07-26 17:56:21 +08:00
</tutorials>
<methods >
<method name= "add_blend_point" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "node" type= "AnimationRootNode" />
<param index= "1" name= "pos" type= "float" />
<param index= "2" name= "at_index" type= "int" default= "-1" />
2018-07-26 17:56:21 +08:00
<description >
2022-08-13 01:51:01 +08:00
Adds a new point that represents a [param node] on the virtual axis at a given position set by [param pos]. You can insert it at a specific index using the [param at_index] argument. If you use the default value for [param at_index], the point is inserted at the end of the blend points array.
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "get_blend_point_count" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
2018-07-26 17:56:21 +08:00
<description >
2019-06-04 08:01:24 +08:00
Returns the number of points on the blend axis.
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "get_blend_point_node" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "AnimationRootNode" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "point" type= "int" />
2018-07-26 17:56:21 +08:00
<description >
2022-08-13 01:51:01 +08:00
Returns the [AnimationNode] referenced by the point at index [param point].
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "get_blend_point_position" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "float" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "point" type= "int" />
2018-07-26 17:56:21 +08:00
<description >
2022-08-13 01:51:01 +08:00
Returns the position of the point at index [param point].
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "remove_blend_point" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "point" type= "int" />
2018-07-26 17:56:21 +08:00
<description >
2022-08-13 01:51:01 +08:00
Removes the point at index [param point] from the blend axis.
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "set_blend_point_node" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "point" type= "int" />
<param index= "1" name= "node" type= "AnimationRootNode" />
2018-07-26 17:56:21 +08:00
<description >
2022-08-13 01:51:01 +08:00
Changes the [AnimationNode] referenced by the point at index [param point].
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "set_blend_point_position" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "point" type= "int" />
<param index= "1" name= "pos" type= "float" />
2018-07-26 17:56:21 +08:00
<description >
2022-08-13 01:51:01 +08:00
Updates the position of the point at index [param point] on the blend axis.
2018-07-26 17:56:21 +08:00
</description>
</method>
</methods>
<members >
2023-01-31 01:12:31 +08:00
<member name= "blend_mode" type= "int" setter= "set_blend_mode" getter= "get_blend_mode" enum= "AnimationNodeBlendSpace1D.BlendMode" default= "0" >
Controls the interpolation between animations. See [enum BlendMode] constants.
</member>
2019-06-29 18:38:01 +08:00
<member name= "max_space" type= "float" setter= "set_max_space" getter= "get_max_space" default= "1.0" >
2019-06-04 08:01:24 +08:00
The blend space's axis's upper limit for the points' position. See [method add_blend_point].
2018-07-26 17:56:21 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "min_space" type= "float" setter= "set_min_space" getter= "get_min_space" default= "-1.0" >
2019-06-04 08:01:24 +08:00
The blend space's axis's lower limit for the points' position. See [method add_blend_point].
2018-07-26 17:56:21 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "snap" type= "float" setter= "set_snap" getter= "get_snap" default= "0.1" >
2019-06-04 08:01:24 +08:00
Position increment to snap to when moving a point on the axis.
2018-07-26 17:56:21 +08:00
</member>
2022-06-29 14:35:29 +08:00
<member name= "sync" type= "bool" setter= "set_use_sync" getter= "is_using_sync" default= "false" >
If [code]false[/code], the blended animations' frame are stopped when the blend value is [code]0[/code].
If [code]true[/code], forcing the blended animations to advance frame.
</member>
2019-06-29 18:38:01 +08:00
<member name= "value_label" type= "String" setter= "set_value_label" getter= "get_value_label" default= ""value"" >
2019-06-04 08:01:24 +08:00
Label of the virtual axis of the blend space.
2018-07-26 17:56:21 +08:00
</member>
</members>
2023-01-31 01:12:31 +08:00
<constants >
<constant name= "BLEND_MODE_INTERPOLATED" value= "0" enum= "BlendMode" >
The interpolation between animations is linear.
</constant>
<constant name= "BLEND_MODE_DISCRETE" value= "1" enum= "BlendMode" >
2023-04-30 22:32:18 +08:00
The blend space plays the animation of the animation node which blending position is closest to. Useful for frame-by-frame 2D animations.
2023-01-31 01:12:31 +08:00
</constant>
<constant name= "BLEND_MODE_DISCRETE_CARRY" value= "2" enum= "BlendMode" >
Similar to [constant BLEND_MODE_DISCRETE], but starts the new animation at the last animation's playback position.
</constant>
</constants>
2018-07-26 17:56:21 +08:00
</class>