1. Epic GamesDeveloper
  3. FAnimNode_Base

FAnimNode_Base

This is the base of all runtime animation nodes

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Animation

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Animation/AnimNodeBase.h
Include #include "Animation/AnimNodeBase.h"

Syntax

struct FAnimNode_Base

Remarks

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void Called to cache any bones that this node needs to track (e.g. in a FBoneReference).
Public function Virtual Const bool Whether this node can run its Update() call on a worker thread.
Public function Virtual void Called to evaluate local-space bones transforms according to the weights set up in Update().
Public function Virtual void Called to evaluate component-space bone transforms according to the weights set up in Update().
Public function Virtual void Called to gather on-screen debug data. This is called on the game thread.
Public function Const const IAnimClassInterface * Get the anim class that this node is hosted within.
Protected function Const const DataType &

GetData ( UE::Anim::FNodeDataId InId,
const UObject* InObject
)

 Get anim node constant/folded data of the specified type given the identifier. Do not use directly - use GET_ANIM_NODE_DATA.
Public function Const const FExposedValueHandler & The default handler for graph-exposed inputs:
Protected function DataType * Get anim node mutable data of the specified type given the identifier.
Protected function Virtual Const int32 Get the LOD threshold at which this node is enabled.
Protected function DataType & Get anim node constant/folded data of the specified type given the identifier.
Public function Const int32 Get this node's index. The node index provides a unique key into its location within the class data.
Public function Virtual Const bool Override this to indicate that PreUpdate() should be called on the game thread (usually to gather non-thread safe data) before Update() is called.
Public function Virtual void Called when the node first runs.
Protected function bool

IsLODEnabled ( FAnimInstanceProxy* AnimInstanceProxy
)

 Return true if enabled, otherwise, return false.
Public function Virtual Const bool For nodes that implement some kind of simulation, return true here so ResetDynamics() gets called when things like teleports, time skips etc.
Public function Virtual Const bool For nodes that need some kind of initialization that is not dependent on node relevancy (i.e. it is insufficient or inefficient to use Initialize_AnyThread), return true here.
Protected function Virtual void

OnInitializeAnimInstance ( const FAnimInstanceProxy* InProxy,
const UAnimInstance* InAnimInstance
)

 Called once, from game thread as the parent anim instance is created
Public function Virtual void

PostCompile ( const USkeleton* InSkeleton
)

 Called after compilation
Public function Virtual void

PreUpdate ( const UAnimInstance* InAnimInstance
)

 Override this to perform game-thread work prior to non-game thread Update() being called
Public function Virtual void

ResetDynamics ( ETeleportType InTeleportType
)

 Called to help dynamics-based updates to recover correctly from large movements/teleports
Public function Virtual void Called to update the state of the graph relative to this node.

Deprecated Functions

  Type Name Description
Public function Virtual void

OnUpdatesSkipped ( TArrayView< const FAnimationUpdateContext* > SkippedUpdateContexts
)

 Please use IGraphMessage instead
Public function Virtual void Please use the OverrideAssets API on UAnimGraphNode_Base to opt-in to child anim BP override functionality, or per-node specific asset override calls.
Public function Virtual void Please use ResetDynamics with an ETeleportPhysics flag instead
Public function void Exposed value handlers are now accessed via FAnimNodeConstantData
Public function Virtual Const bool Please use IGraphMessage instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page