AnimationNodeExtension
Base class for extending AnimationRootNodes from C#, C#, or C++.
Base class for extending AnimationRootNodes from C#, C#, or C++.
AnimationNodeExtension exposes the APIs of AnimationRootNode to allow users to extend it from C#, C#, or C++. This class is not meant to be used directly, but to be extended by other classes. It is used to create custom nodes for the AnimationTree system.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
AnimationNodeExtensionConstructor
public AnimationNodeExtension();Methods5
GetRemainingTime2 overloads
public static double GetRemainingTime(ReadOnlySpan<float> nodeInfo, bool breakLoop);Returns the animation's remaining time for the given node info. For looping animations, it will only return the remaining time if break_loop is true, a large integer value will be returned otherwise.
| Name | Type | Default |
|---|---|---|
nodeInfo | ReadOnlySpan<float> | — |
breakLoop | bool | — |
doublepublic static double GetRemainingTime(float[] nodeInfo, bool breakLoop);Returns the animation's remaining time for the given node info. For looping animations, it will only return the remaining time if break_loop is true, a large integer value will be returned otherwise.
| Name | Type | Default |
|---|---|---|
nodeInfo | float[] | — |
breakLoop | bool | — |
doubleIsLooping2 overloads
public static bool IsLooping(ReadOnlySpan<float> nodeInfo);Returns true if the animation for the given node_info is looping.
| Name | Type | Default |
|---|---|---|
nodeInfo | ReadOnlySpan<float> | — |
boolpublic static bool IsLooping(float[] nodeInfo);Returns true if the animation for the given node_info is looping.
| Name | Type | Default |
|---|---|---|
nodeInfo | float[] | — |
bool_ProcessAnimationNodefloat[]
public virtual float[] _ProcessAnimationNode(double[] playbackInfo, bool testOnly);A version of the AnimationNode._Process method that is meant to be overridden by custom nodes. It returns a float[] with the processed animation data.
The double[] parameter contains the playback information, containing the following values encoded as floating point numbers (in order): playback time and delta, start and end times, whether a seek was requested (encoded as a float greater than 0), whether the seek request was externally requested (encoded as a float greater than 0), the current Animation.LoopedFlag (encoded as a float), and the current blend weight.
The function must return a float[] of the node's time info, containing the following values (in order): animation length, time position, delta, Animation.LoopModeEnum (encoded as a float), whether the animation is about to end (encoded as a float greater than 0) and whether the animation is infinite (encoded as a float greater than 0). All values must be included in the returned array.
| Name | Type | Default |
|---|---|---|
playbackInfo | double[] | — |
testOnly | bool | — |
float[]