AnimationNodeBlendSpace1D

Inherits: AnimationRootNode < AnimationNode < Resource < RefCounted < Object

Blends linearly between two of any number of AnimationNode of any type placed on a virtual axis.

Description

A resource to add to an AnimationNodeBlendTree.

This is a virtual axis on which you can add any type of AnimationNode using add_blend_point.

Outputs the linear blend of the two AnimationNodes closest to the node's current value.

You can set the extents of the axis using the min_space and max_space.

Tutorials

Properties

float

max_space

1.0

float

min_space

-1.0

float

snap

0.1

bool

sync

false

String

value_label

"value"

Methods

void

add_blend_point ( AnimationRootNode node, float pos, int at_index=-1 )

int

get_blend_point_count ( ) const

AnimationRootNode

get_blend_point_node ( int point ) const

float

get_blend_point_position ( int point ) const

void

remove_blend_point ( int point )

void

set_blend_point_node ( int point, AnimationRootNode node )

void

set_blend_point_position ( int point, float pos )


Property Descriptions

float max_space = 1.0

  • void set_max_space ( float value )

  • float get_max_space ( )

The blend space's axis's upper limit for the points' position. See add_blend_point.


float min_space = -1.0

  • void set_min_space ( float value )

  • float get_min_space ( )

The blend space's axis's lower limit for the points' position. See add_blend_point.


float snap = 0.1

  • void set_snap ( float value )

  • float get_snap ( )

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


bool sync = false

  • void set_use_sync ( bool value )

  • bool 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.


String value_label = "value"

  • void set_value_label ( String value )

  • String get_value_label ( )

Label of the virtual axis of the blend space.


Method Descriptions

void add_blend_point ( 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

Returns the number of points on the blend axis.


AnimationRootNode get_blend_point_node ( int point ) const

Returns the AnimationNode referenced by the point at index point.


float get_blend_point_position ( int point ) const

Returns the position of the point at index point.


void remove_blend_point ( int point )

Removes the point at index point from the blend axis.


void set_blend_point_node ( int point, AnimationRootNode node )

Changes the AnimationNode referenced by the point at index point.


void set_blend_point_position ( int point, float pos )

Updates the position of the point at index point on the blend axis.