Class reference
AnimationNodeBlendSpace1D
Inherits AnimationRootNode
A set of AnimationRootNodes placed on a virtual axis, crossfading between the two adjacent ones. Used by AnimationTree.
Description
A resource used by AnimationNodeBlendTree. AnimationNodeBlendSpace1D represents a virtual axis on which any type of AnimationRootNodes can be added using add_blend_point(). Outputs the linear blend of the two AnimationRootNodes adjacent to the current value. You can set the extents of the axis with min_space and max_space.
Properties
int blend_mode = 0
int blend_mode = 0Controls the interpolation between animations.
float max_space = 1.0
float max_space = 1.0The blend space's axis's upper limit for the points' position. See add_blend_point().
float min_space = -1.0
float min_space = -1.0The blend space's axis's lower limit for the points' position. See add_blend_point().
float snap = 0.1
float snap = 0.1Position increment to snap to when moving a point on the axis.
bool sync = false
bool sync = falseIf false, the blended animations' frame are stopped when the blend value is 0. If true, forcing the blended animations to advance frame.
String value_label = "value"
String value_label = "value"Label of the virtual axis of the blend space.
Methods
void add_blend_point(AnimationRootNode node, float pos, int at_index = -1)
AnimationRootNode node, float pos, 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.
int get_blend_point_count() const
int get_blend_point_count() constReturns the number of points on the blend axis.
AnimationRootNode get_blend_point_node(int point) const
AnimationRootNode get_blend_point_node(int point) constReturns the AnimationNode referenced by the point at index point.
float get_blend_point_position(int point) const
float get_blend_point_position(int point) constReturns the position of the point at index point.
void remove_blend_point(int point)
int point)Removes the point at index point from the blend axis.
void set_blend_point_node(int point, AnimationRootNode node)
int point, AnimationRootNode node)Changes the AnimationNode referenced by the point at index point.
void set_blend_point_position(int point, float pos)
int point, float pos)Updates the position of the point at index point on the blend axis.
Constants
BLEND_MODE_INTERPOLATED = 0
The interpolation between animations is linear.
BLEND_MODE_DISCRETE = 1
The blend space plays the animation of the animation node which blending position is closest to. Useful for frame-by-frame 2D animations.
BLEND_MODE_DISCRETE_CARRY = 2
Similar to BLEND_MODE_DISCRETE, but starts the new animation at the last animation's playback position.