|
Module |
|
|
Header |
/Engine/Source/Runtime/Engine/Classes/Animation/AnimNodeBase.h |
|
Include |
#include "Animation/AnimNodeBase.h" |
struct FAnimNode_Base
This is the base of all runtime animation nodes
To create a new animation node: Create a struct derived from FAnimNode_Base - this is your runtime node Create a class derived from UAnimGraphNode_Base, containing an instance of your runtime node as a member - this is your visual/editor-only node
| Name | Description | |
|---|---|---|
|
|
~FAnimNode_Base() |
| Name | Description | ||
|---|---|---|---|
|
|
CacheBones_AnyThread ( |
Called to cache any bones that this node needs to track (e.g. in a FBoneReference). |
|
|
|
CanUpdateInWorkerThread() |
Whether this node can run its Update() call on a worker thread. |
|
|
|
Evaluate_AnyThread ( |
Called to evaluate local-space bones transforms according to the weights set up in Update(). |
|
|
|
EvaluateComponentSpace_AnyThread ( |
Called to evaluate component-space bone transforms according to the weights set up in Update(). |
|
|
|
GatherDebugData ( |
Called to gather on-screen debug data. This is called on the game thread. |
|
|
|
const FExpos... |
GetEvaluateGraphExposedInputs() |
The default handler for graph-exposed inputs: |
|
|
GetLODThreshold() |
||
|
|
HasPreUpdate() |
Override this to indicate that PreUpdate() should be called on the game thread (usually to gather non-thread safe data) before Update() is called. |
|
|
|
Initialize_AnyThread ( |
Called when the node first runs. |
|
|
|
IsLODEnabled ( |
Return true if enabled, otherwise, return false. |
|
|
|
NeedsDynamicReset() |
For nodes that implement some kind of simulation, return true here so ResetDynamics() gets called when things like teleports, time skips etc. |
|
|
|
NeedsOnInitializeAnimInstance() |
For nodes that need some kind of initialization that is not dependent on node relevancy (i.e. it is insufficent or inefficent to use Initialize_AnyThread), return true here. |
|
|
|
OnInitializeAnimInstance ( |
Called once, from game thread as the parent anim instance is created |
|
|
|
OnUpdatesSkipped ( |
Called on a tracked ancestor node when there are Update() calls that were skipped due to pose caching. |
|
|
|
OverrideAsset ( |
If a derived anim node should respond to asset overrides, OverrideAsset should be defined to handle changing the asset This is called during anim blueprint compilation to handle child anim blueprints. |
|
|
|
PostCompile ( |
Called after compilation |
|
|
|
PreUpdate ( |
Override this to perform game-thread work prior to non-game thread Update() being called |
|
|
|
ResetDynamics ( |
Called to help dynamics-based updates to recover correctly from large movements/teleports |
|
|
|
SetExposedValueHandler ( |
Initialization function for the default handler for graph-exposed inputs, used only by instancing code: |
|
|
|
Update_AnyThread ( |
Called to update the state of the graph relative to this node. |
|
|
|
WantsSkippedUpdates() |
Override this if your node uses ancestor tracking and wants to be informed of Update() calls that were skipped due to pose caching. |
| Name | Description | ||
|---|---|---|---|
|
|
CacheBones ( |
Please use CacheBones_AnyThread instead |
|
|
|
Evaluate ( |
Please use Evaluate_AnyThread instead |
|
|
|
EvaluateComponentSpace ( |
Please use EvaluateComponentSpace_AnyThread instead |
|
|
|
Initialize ( |
Please use Initialize_AnyThread instead |
|
|
|
ResetDynamics() |
Please use ResetDynamics with an ETeleportPhysics flag instead |
|
|
|
RootInitialize ( |
Please use OnInitializeAnimInstance instead |
|
|
|
Update ( |
Please use Update_AnyThread instead |