Navigation
Unreal Engine C++ API Reference > Runtime > Engine > Animation
Inheritance Hierarchy
- FAnimNode_Base
- FAnimNode_ApplyMeshSpaceAdditive
- FAnimNode_AssetPlayerRelevancyBase
- FAnimNode_AssetPlayerBase
- FAnimNode_SequencePlayerBase
- FAnimNode_SequencePlayer
- FAnimNode_SequencePlayer_Standalone
- FAnimNode_ConvertComponentToLocalSpace
- FAnimNode_ConvertLocalToComponentSpace
- FAnimNode_CustomProperty
- FAnimNode_IKRig
- FAnimNode_LinkedAnimGraph
- FAnimNode_LinkedAnimLayer
- FAnimNode_DeadBlending
- FAnimNode_Inertialization
- FAnimNode_LinkedInputPose
- FAnimNode_PreviewRetargetPose
- FAnimNode_RetargetPoseFromMesh
- FAnimNode_RigLogic
- FAnimNode_Root
- FAnimNode_StateResult
- FAnimNode_SaveCachedPose
- FAnimNode_SingleNode
- FAnimNode_StateMachine
- FAnimNode_TransitionPoseEvaluator
- FAnimNode_TransitionResult
- FAnimNode_UseCachedPose
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Animation/AnimNodeBase.h |
| Include | #include "Animation/AnimNodeBase.h" |
Syntax
USTRUCT ()
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 | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | CacheBones_AnyThread
(
const FAnimationCacheBonesContext& Context |
Called to cache any bones that this node needs to track (e.g. in a FBoneReference). |
   |
bool | Whether this node can run its Update() call on a worker thread. | |
  |
void | Evaluate_AnyThread
(
FPoseContext& Output |
Called to evaluate local-space bones transforms according to the weights set up in Update(). |
  |
void | Called to evaluate component-space bone transforms according to the weights set up in Update(). | |
  |
void | GatherDebugData
(
FNodeDebugData& DebugData |
Called to gather on-screen debug data. This is called on the game thread. |
  |
const IAnimClassInterface * | Get the anim class that this node is hosted within. | |
  |
const DataType & | GetData
(
UE::Anim::FNodeDataId InId, |
Get anim node constant/folded data of the specified type given the identifier. Do not use directly - use GET_ANIM_NODE_DATA. |
  |
const FExposedValueHandler & | The default handler for graph-exposed inputs: | |
 |
DataType * | GetInstanceDataPtr
(
UE::Anim::FNodeDataId InId, |
Get anim node mutable data of the specified type given the identifier. |
   |
int32 | Get the LOD level at which this node is enabled. | |
 |
DataType & | GetMutableData
(
UE::Anim::FNodeDataId InId, |
Get anim node constant/folded data of the specified type given the identifier. |
  |
int32 | GetNodeIndex () |
Get this node's index. The node index provides a unique key into its location within the class data. |
   |
bool | 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. |
  |
void | Initialize_AnyThread
(
const FAnimationInitializeContext& Context |
Called when the node first runs. |
 |
bool | IsLODEnabled
(
FAnimInstanceProxy* AnimInstanceProxy |
Return true if enabled, otherwise, return false. |
   |
bool | For nodes that implement some kind of simulation, return true here so ResetDynamics() gets called when things like teleports, time skips etc. | |
   |
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. | |
  |
void | OnInitializeAnimInstance
(
const FAnimInstanceProxy* InProxy, |
Called once, from game thread as the parent anim instance is created |
  |
void | OnUpdatesSkipped
(
TArrayView< const FAnimationUpdateContext* > SkippedUpdateContexts |
|
  |
void | OverrideAsset
(
UAnimationAsset* NewAsset |
|
  |
void | PostCompile
(
const USkeleton* InSkeleton |
Called after compilation |
  |
void | PreUpdate
(
const UAnimInstance* InAnimInstance |
Override this to perform game-thread work prior to non-game thread Update() being called |
  |
void | Deprecated functions | |
  |
void | ResetDynamics
(
ETeleportType InTeleportType |
Called to help dynamics-based updates to recover correctly from large movements/teleports |
 |
void | SetExposedValueHandler
(
const FExposedValueHandler* Handler |
Initialization function for the default handler for graph-exposed inputs, used only by instancing code: |
  |
void | Update_AnyThread
(
const FAnimationUpdateContext& Context |
Called to update the state of the graph relative to this node. |
   |
bool |