AnimationNodeBlendSpace2D

package
v0.0.0-...-c858641 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 14, 2025 License: MIT Imports: 26 Imported by: 0

Documentation

Overview

A resource used by graphics.gd/classdb/AnimationNodeBlendTree.

graphics.gd/classdb/AnimationNodeBlendSpace2D represents a virtual 2D space on which [graphics.gd/classdb/AnimationRootNode]s are placed. Outputs the linear blend of the three adjacent animations using a [Vector2.XY] weight. Adjacent in this context means the three [graphics.gd/classdb/AnimationRootNode]s making up the triangle that contains the current value.

You can add vertices to the blend space with Instance.AddBlendPoint and automatically triangulate it by setting Instance.AutoTriangles to true. Otherwise, use Instance.AddTriangle and Instance.RemoveTriangle to triangulate the blend space by hand.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsAnimationNodeBlendSpace2D() Instance
}

type BlendMode

type BlendMode int //gd:AnimationNodeBlendSpace2D.BlendMode
const (
	// The interpolation between animations is linear.
	BlendModeInterpolated BlendMode = 0
	// The blend space plays the animation of the animation node which blending position is closest to. Useful for frame-by-frame 2D animations.
	BlendModeDiscrete BlendMode = 1
	// Similar to [BlendModeDiscrete], but starts the new animation at the last animation's playback position.
	BlendModeDiscreteCarry BlendMode = 2
)

type Expanded

func (Expanded) AddBlendPoint

func (self Expanded) AddBlendPoint(node AnimationRootNode.Instance, pos Vector2.XY, at_index int)

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.

func (Expanded) AddTriangle

func (self Expanded) AddTriangle(x int, y int, z int, at_index int)

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.

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsAnimationNode

func (self *Extension[T]) AsAnimationNode() AnimationNode.Instance

func (*Extension[T]) AsAnimationNodeBlendSpace2D

func (self *Extension[T]) AsAnimationNodeBlendSpace2D() Instance

func (*Extension[T]) AsAnimationRootNode

func (self *Extension[T]) AsAnimationRootNode() AnimationRootNode.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AddBlendPoint

func (self Instance) AddBlendPoint(node AnimationRootNode.Instance, pos Vector2.XY)

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.

func (Instance) AddTriangle

func (self Instance) AddTriangle(x int, y int, z int)

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.

func (Instance) AsAnimationNode

func (self Instance) AsAnimationNode() AnimationNode.Instance

func (Instance) AsAnimationNodeBlendSpace2D

func (self Instance) AsAnimationNodeBlendSpace2D() Instance

func (Instance) AsAnimationRootNode

func (self Instance) AsAnimationRootNode() AnimationRootNode.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) AutoTriangles

func (self Instance) AutoTriangles() bool

func (Instance) BlendMode

func (self Instance) BlendMode() BlendMode

func (Instance) GetBlendPointCount

func (self Instance) GetBlendPointCount() int

Returns the number of points in the blend space.

func (Instance) GetBlendPointNode

func (self Instance) GetBlendPointNode(point int) AnimationRootNode.Instance

Returns the graphics.gd/classdb/AnimationRootNode referenced by the point at index 'point'.

func (Instance) GetBlendPointPosition

func (self Instance) GetBlendPointPosition(point int) Vector2.XY

Returns the position of the point at index 'point'.

func (Instance) GetTriangleCount

func (self Instance) GetTriangleCount() int

Returns the number of triangles in the blend space.

func (Instance) GetTrianglePoint

func (self Instance) GetTrianglePoint(triangle int, point int) int

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

func (Instance) ID

func (self Instance) ID() ID

func (Instance) MaxSpace

func (self Instance) MaxSpace() Vector2.XY

func (Instance) MinSpace

func (self Instance) MinSpace() Vector2.XY

func (Instance) OnTrianglesUpdated

func (self Instance) OnTrianglesUpdated(cb func(), flags ...Signal.Flags)

func (Instance) RemoveBlendPoint

func (self Instance) RemoveBlendPoint(point int)

Removes the point at index 'point' from the blend space.

func (Instance) RemoveTriangle

func (self Instance) RemoveTriangle(triangle int)

Removes the triangle at index 'triangle' from the blend space.

func (Instance) SetAutoTriangles

func (self Instance) SetAutoTriangles(value bool)

func (Instance) SetBlendMode

func (self Instance) SetBlendMode(value BlendMode)

func (Instance) SetBlendPointNode

func (self Instance) SetBlendPointNode(point int, node AnimationRootNode.Instance)

Changes the graphics.gd/classdb/AnimationNode referenced by the point at index 'point'.

func (Instance) SetBlendPointPosition

func (self Instance) SetBlendPointPosition(point int, pos Vector2.XY)

Updates the position of the point at index 'point' in the blend space.

func (Instance) SetMaxSpace

func (self Instance) SetMaxSpace(value Vector2.XY)

func (Instance) SetMinSpace

func (self Instance) SetMinSpace(value Vector2.XY)

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetSnap

func (self Instance) SetSnap(value Vector2.XY)

func (Instance) SetSync

func (self Instance) SetSync(value bool)

func (Instance) SetXLabel

func (self Instance) SetXLabel(value string)

func (Instance) SetYLabel

func (self Instance) SetYLabel(value string)

func (Instance) Snap

func (self Instance) Snap() Vector2.XY

func (Instance) Sync

func (self Instance) Sync() bool

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

func (Instance) XLabel

func (self Instance) XLabel() string

func (Instance) YLabel

func (self Instance) YLabel() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL