Class AnimGraphInstanceData

The animation graph instance data storage. Required to update the animation graph.

AnimGraphInstanceData
Assembly: FlaxEngine.dll
File: Engine/Animations/Graph/AnimGraph.h
Syntax
public class AnimGraphInstanceData

Fields

CurrentFrame

The current animation update frame index. Increment on every update.

Declaration
public int64 CurrentFrame = 0
Field Value
int64

EnableTracing

Declaration
public bool EnableTracing = false
Field Value
bool

LastUpdateTime

The last game time when animation was updated.

Declaration
public float LastUpdateTime = -1
Field Value
float

LocalPoseOverride

The custom event called after local pose evaluation and retargetting.

Declaration
public Delegate<AnimGraphImpulse* > LocalPoseOverride
Field Value
Delegate<AnimGraphImpulse >

NodesPose

The per-node final transformations in actor local-space.

Declaration
public Array<Matrix> NodesPose
Field Value
Array<Matrix>

NodesSkeleton

The output nodes pose skeleton asset to use. Allows to remap evaluated animation pose for Base Model of the Anim Graph to the target Animated Model that plays it. Nodes Pose will match its skeleton. Use null if disable retargetting.

Declaration
public SkinnedModel* NodesSkeleton = nullptr
Field Value
SkinnedModel

Object

The object that represents the instance data source (used by Custom Nodes and debug flows).

Declaration
public ScriptingObject* Object
Field Value
ScriptingObject

Parameters

The animation graph parameters collection (instanced, override the default values).

Declaration
public Array<AnimGraphParameter> Parameters
Field Value
Array<AnimGraphParameter>

RootMotion

The current root motion delta to apply on a target object.

Declaration
public Transform RootMotion = Transform::Identity
Field Value
Transform

RootTransform

The root node transformation. Cached after the animation update.

Declaration
public Transform RootTransform = Transform::Identity
Field Value
Transform

Slots

The slots animations.

Declaration
public Array<AnimGraphSlot, InlinedAllocation<4>> Slots
Field Value
Array<AnimGraphSlot, InlinedAllocation<4>>

State

The animation state data.

Declaration
public Array<Bucket> State
Field Value
Array<Bucket>

TraceEvents

Declaration
public Array<AnimGraphTraceEvent> TraceEvents
Field Value
Array<AnimGraphTraceEvent>

Version

The instance data version number. Used to sync the Anim Graph data with the instance state. Handles Anim Graph reloads to ensure data is valid.

Declaration
public uint32 Version = 0
Field Value
uint32

Methods

Clear()

Clears this container data.

Declaration
public void Clear()

ClearState()

Clears this container state data.

Declaration
public void ClearState()

Invalidate()

Invalidates the update timer.

Declaration
public void Invalidate()

InvokeAnimEvents()

Invokes any outgoing AnimEvent and AnimContinuousEvent collected during the last animation update. When called from non-main thread only Async events will be invoked.

Declaration
public void InvokeAnimEvents()