reckfellENGINE

AnimationNodeBlendSpace1D

A set of AnimationRootNodes placed on a virtual axis, crossfading between the two adjacent ones. Used by AnimationTree.

On this page
class AnimationNodeBlendSpace1DReckfellSharpInherits AnimationRootNode

A set of AnimationRootNodes placed on a virtual axis, crossfading between the two adjacent ones. Used by AnimationTree.

A resource used by AnimationNodeBlendTree. AnimationNodeBlendSpace1D represents a virtual axis on which any type of AnimationRootNodes can be added using AnimationNodeBlendSpace1D.AddBlendPoint. Outputs the linear blend of the two AnimationRootNodes adjacent to the current value. You can set the extents of the axis with AnimationNodeBlendSpace1D.MinSpace and AnimationNodeBlendSpace1D.MaxSpace.

Optionally, signals can be used by setting an AnimationNodeObserverBlendSpace through AnimationTree.

C#
var observer = animationTree.Get("parameters/BlendSpace/observer").As<AnimationNodeObserverBlendSpace>();
observer.ClosestPointChanged += OnClosestPointChanged;

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AnimationNodeBlendSpace1DConstructor
# AnimationNodeBlendSpace1D
C#
public AnimationNodeBlendSpace1D();

Properties8

BlendModeProperty
# BlendMode
C#
public AnimationNodeBlendSpace1D.BlendModeEnum BlendMode { get; set; }

Controls the interpolation between animations.

CyclicLengthProperty
# CyclicLength
C#
public double CyclicLength { get; set; }

Common cycle duration in seconds for SyncMode.CyclicConstant. Set a positive value; it is not a blend weight or each source Animation duration. CyclicMutable computes duration from active clips.

MaxSpaceProperty
# MaxSpace
C#
public float MaxSpace { get; set; }

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

MinSpaceProperty
# MinSpace
C#
public float MinSpace { get; set; }

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

SnapProperty
# Snap
C#
public float Snap { get; set; }

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

SyncProperty · Deprecated
# Sync
C#
public bool Sync { get; set; }

If true, sync mode is enabled (equivalent to AnimationNodeBlendSpace1D.SyncModeEnum.Independent). This property is kept for backward compatibility.

SyncModeProperty
# SyncMode
C#
public AnimationNodeBlendSpace1D.SyncModeEnum SyncMode { get; set; }

Controls point timing: None advances active points; Independent advances all regardless of weight. CyclicMutable synchronizes using weighted active clip lengths; CyclicConstant uses CyclicLength. Cyclic modes require direct AnimationNodeAnimation points.

ValueLabelProperty
# ValueLabel
C#
public string ValueLabel { get; set; }

Label of the virtual axis of the blend space.

Methods28

AddBlendPoint2 overloads
# AddBlendPoint · 1/2
C#
public void AddBlendPoint(AnimationRootNode node, float pos, int atIndex);

Adds a new point with name 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. Note: If no name is provided, safe index is used as reference. In the future, empty names will be deprecated, so explicitly passing a name is recommended.

Parameters
NameTypeDefault
nodeAnimationRootNode—
posfloat—
atIndexint—
# AddBlendPoint · 2/2
C#
public void AddBlendPoint(AnimationRootNode node, float pos, int atIndex = -1, StringName name = null);

Adds a new point with name 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. Note: If no name is provided, safe index is used as reference. In the future, empty names will be deprecated, so explicitly passing a name is recommended.

Parameters
NameTypeDefault
nodeAnimationRootNode—
posfloat—
atIndexint-1
nameStringNamenull
FindBlendPointByNameint
# FindBlendPointByName
C#
public int FindBlendPointByName(StringName name);

Returns the index of the blend point with the given name. Returns -1 if no blend point with that name is found.

Parameters
NameTypeDefault
nameStringName—
Returns int
GetBlendModeAnimationNodeBlendSpace1D.BlendModeEnum
# GetBlendMode
C#
public AnimationNodeBlendSpace1D.BlendModeEnum GetBlendMode();
Returns AnimationNodeBlendSpace1D.BlendModeEnum
GetBlendPointCountint
# GetBlendPointCount
C#
public int GetBlendPointCount();

Returns the number of points on the blend axis.

Returns int
GetBlendPointNameStringName
# GetBlendPointName
C#
public StringName GetBlendPointName(int point);

Returns the name of the blend point at index point.

Parameters
NameTypeDefault
pointint—
Returns StringName
GetBlendPointNodeAnimationRootNode
# GetBlendPointNode
C#
public AnimationRootNode GetBlendPointNode(int point);

Returns the AnimationNode referenced by the point at index point.

Parameters
NameTypeDefault
pointint—
Returns AnimationRootNode
GetBlendPointPositionfloat
# GetBlendPointPosition
C#
public float GetBlendPointPosition(int point);

Returns the position of the point at index point.

Parameters
NameTypeDefault
pointint—
Returns float
GetCyclicLengthdouble
# GetCyclicLength
C#
public double GetCyclicLength();
Returns double
GetMaxSpacefloat
# GetMaxSpace
C#
public float GetMaxSpace();
Returns float
GetMinSpacefloat
# GetMinSpace
C#
public float GetMinSpace();
Returns float
GetSnapfloat
# GetSnap
C#
public float GetSnap();
Returns float
GetSyncModeAnimationNodeBlendSpace1D.SyncModeEnum
# GetSyncMode
C#
public AnimationNodeBlendSpace1D.SyncModeEnum GetSyncMode();
Returns AnimationNodeBlendSpace1D.SyncModeEnum
GetValueLabelstring
# GetValueLabel
C#
public string GetValueLabel();
Returns string
IsUsingSyncbool
# IsUsingSync
C#
public bool IsUsingSync();
Returns bool
RemoveBlendPointvoid
# RemoveBlendPoint
C#
public void RemoveBlendPoint(int point);

Removes the point at index point from the blend axis.

Parameters
NameTypeDefault
pointint—
ReorderBlendPointvoid
# ReorderBlendPoint
C#
public void ReorderBlendPoint(int fromIndex, int toIndex);

Swaps the blend points at indices from_index and to_index, exchanging their positions and properties.

Parameters
NameTypeDefault
fromIndexint—
toIndexint—
SetBlendModevoid
# SetBlendMode
C#
public void SetBlendMode(AnimationNodeBlendSpace1D.BlendModeEnum mode);
Parameters
NameTypeDefault
modeAnimationNodeBlendSpace1D.BlendModeEnum—
SetBlendPointNamevoid
# SetBlendPointName
C#
public void SetBlendPointName(int point, StringName name);

Sets the name of the blend point at index point. If the name conflicts with an existing point, a unique name will be generated automatically.

Parameters
NameTypeDefault
pointint—
nameStringName—
SetBlendPointNodevoid
# SetBlendPointNode
C#
public void SetBlendPointNode(int point, AnimationRootNode node);

Changes the AnimationNode referenced by the point at index point.

Parameters
NameTypeDefault
pointint—
nodeAnimationRootNode—
SetBlendPointPositionvoid
# SetBlendPointPosition
C#
public void SetBlendPointPosition(int point, float pos);

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

Parameters
NameTypeDefault
pointint—
posfloat—
SetCyclicLengthvoid
# SetCyclicLength
C#
public void SetCyclicLength(double length);
Parameters
NameTypeDefault
lengthdouble—
SetMaxSpacevoid
# SetMaxSpace
C#
public void SetMaxSpace(float maxSpace);
Parameters
NameTypeDefault
maxSpacefloat—
SetMinSpacevoid
# SetMinSpace
C#
public void SetMinSpace(float minSpace);
Parameters
NameTypeDefault
minSpacefloat—
SetSnapvoid
# SetSnap
C#
public void SetSnap(float snap);
Parameters
NameTypeDefault
snapfloat—
SetSyncModevoid
# SetSyncMode
C#
public void SetSyncMode(AnimationNodeBlendSpace1D.SyncModeEnum syncMode);
Parameters
NameTypeDefault
syncModeAnimationNodeBlendSpace1D.SyncModeEnum—
SetUseSyncvoid
# SetUseSync
C#
public void SetUseSync(bool enable);
Parameters
NameTypeDefault
enablebool—
SetValueLabelvoid
# SetValueLabel
C#
public void SetValueLabel(string text);
Parameters
NameTypeDefault
textstring—

AnimationNodeBlendSpace1D.BlendModeEnum

ValueDescription
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.

DiscreteCarry = 2

Similar to AnimationNodeBlendSpace1D.BlendModeEnum.Discrete, but starts the new animation at the last animation's playback position.

Interpolated = 0

The interpolation between animations is linear.

AnimationNodeBlendSpace1D.SyncModeEnum

ValueDescription
CyclicConstant = 3

All animations are time-scaled so they complete one cycle in AnimationNodeBlendSpace1D.CyclicLength seconds, keeping them in sync regardless of their individual lengths. Note: If you apply AnimationNodeTimeSeek to the result when handling animations of different lengths, synchronization will be broken. In such cases, it is recommended to use AnimationNodeAnimation.UseCustomTimeline to align the animation lengths.

CyclicMutable = 2

All animations are time-scaled so they stay in sync, with the cycle length dynamically computed from active blend weights. This is self-normalizing: a solo animation plays at normal speed. Note: If you apply AnimationNodeTimeSeek to the result when handling animations of different lengths, synchronization will be broken. In such cases, it is recommended to use AnimationNodeAnimation.UseCustomTimeline to align the animation lengths.

Independent = 1

Inactive animations advance with a weight of 0. This is equivalent to the previous sync = true behavior.

None = 0

Inactive animations are frozen and do not advance.

Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.