AnimationNodeBlendSpace2D

Refreshing Cache...

Inherits: AnimationRootNode < AnimationNode < Resource < Reference < Object

Blends linearly between three AnimationNode of any type placed in a 2D space.

Description

A resource to add to an AnimationNodeBlendTree.

This node allows you to blend linearly between three animations using a Vector2 weight.

You can add vertices to the blend space with add_blend_point and automatically triangulate it by setting auto_triangles to true. Otherwise, use add_triangle and remove_triangle to create up the blend space by hand.

Tutorials

Properties

boolauto_trianglestrue
BlendModeblend_mode0
Vector2max_spaceVector2( 1, 1 )
Vector2min_spaceVector2( -1, -1 )
Vector2snapVector2( 0.1, 0.1 )
Stringx_label"x"
Stringy_label"y"

Methods

voidadd_blend_point ( AnimationRootNode node, Vector2 pos, int at_index=-1 )
voidadd_triangle ( int x, int y, int z, int at_index=-1 )
intget_blend_point_count ( ) const
AnimationRootNodeget_blend_point_node ( int point ) const
Vector2get_blend_point_position ( int point ) const
intget_triangle_count ( ) const
intget_triangle_point ( int triangle, int point )
voidremove_blend_point ( int point )
voidremove_triangle ( int triangle )
voidset_blend_point_node ( int point, AnimationRootNode node )
voidset_blend_point_position ( int point, Vector2 pos )

Signals

  • triangles_updated ( )

Emitted every time the blend space’s triangles are created, removed, or when one of their vertices changes position.

Enumerations

enum BlendMode:

  • BLEND_MODE_INTERPOLATED = 0 — The interpolation between animations is linear.
  • BLEND_MODE_DISCRETE = 1 — The blend space plays the animation of the node the 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.

Property Descriptions

Defaulttrue
Setterset_auto_triangles(value)
Getterget_auto_triangles()

If true, the blend space is triangulated automatically. The mesh updates every time you add or remove points with add_blend_point and remove_blend_point.


Default0
Setterset_blend_mode(value)
Getterget_blend_mode()

Controls the interpolation between animations. See BlendMode constants.


DefaultVector2( 1, 1 )
Setterset_max_space(value)
Getterget_max_space()

The blend space’s X and Y axes’ upper limit for the points’ position. See add_blend_point.


DefaultVector2( -1, -1 )
Setterset_min_space(value)
Getterget_min_space()

The blend space’s X and Y axes’ lower limit for the points’ position. See add_blend_point.


DefaultVector2( 0.1, 0.1 )
Setterset_snap(value)
Getterget_snap()

Position increment to snap to when moving a point.


Default"x"
Setterset_x_label(value)
Getterget_x_label()

Name of the blend space’s X axis.


Default"y"
Setterset_y_label(value)
Getterget_y_label()

Name of the blend space’s Y axis.

Method Descriptions

Adds a new point that represents a node at the 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.


Creates a new triangle using three points x, y, and z. Triangles can overlap. You can insert the triangle 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 in the blend space.


Returns the AnimationRootNode referenced by the point at index point.


  • Vector2 get_blend_point_position ( int point ) const

Returns the position of the point at index point.


  • int get_triangle_count ( ) const

Returns the number of triangles in the blend space.


  • int get_triangle_point ( int triangle, int point )

Returns the position of the point at index point in the triangle of index triangle.


  • void remove_blend_point ( int point )

Removes the point at index point from the blend space.


  • void remove_triangle ( int triangle )

Removes the triangle at index triangle from the blend space.


Changes the AnimationNode referenced by the point at index point.


  • void set_blend_point_position ( int point, Vector2 pos )

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

doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:28:19. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.