1. Epic GamesDeveloper
  3. FAnimInstanceProxy

FAnimInstanceProxy

Proxy object passed around during animation tree update in lieu of a [UAnimInstance](API\Runtime\Engine\Animation\UAnimInstance)

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

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Animation/AnimInstanceProxy.h
Include #include "Animation/AnimInstanceProxy.h"

Syntax

struct FAnimInstanceProxy

Remarks

Proxy object passed around during animation tree update in lieu of a UAnimInstance

Variables

  Type Name Description
Protected variable TArray< FAnimNotifyEventReference > ActiveAnimNotifiesSinceLastTick Animation Notifies that has been triggered since the last tick. These can be safely consumed at any point.
Protected variable uint8: 1 bBoneCachesInvalidated When RequiredBones mapping has changed, AnimNodes need to update their bones caches.
Protected variable FGraphTraversalCounter CachedBonesCounter  
Protected variable FGraphTraversalCounter EvaluationCounter  
Protected variable uint64 FrameCounterForNodeUpdate  
Protected variable uint64 FrameCounterForUpdate Sync counter.
Protected variable FGraphTraversalCounter InitializationCounter Counters for synchronization.
Public variable TArray< FQueuedDrawDebugItem > QueuedDrawDebugItems  
Protected variable FGraphTraversalCounter SlotNodeInitializationCounter  
Protected variable FGraphTraversalCounter UpdateCounter  

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function void

AddAnimNotifies ( const TArray< FAnimNotifyEventReference >& NewNotifies,
const float InstanceWeight
)

 Add anim notifier
Public function void

AddAnimNotifyFromGeneratedClass ( int32 NotifyIndex
)

 Queues an Anim Notify from the shared list on our generated class
Protected function void

AddCurveValue ( const FName& CurveName,
float Value,
bool bMorphtarget,
bool bMaterial
)

 Add a curve value
Protected function void

AddNativeStateEntryBinding ( const FName& MachineName,
const FName& StateName,
const FOnGraphStateChanged& NativeEnteredDelegate,
const FName& BindingName
)

 Sets up a native state entry delegate from state with StateName, in the state machine with name MachineName.
Protected function void

AddNativeStateExitBinding ( const FName& MachineName,
const FName& StateName,
const FOnGraphStateChanged& NativeExitedDelegate,
const FName& BindingName
)

 Sets up a native state exit delegate from state with StateName, in the state machine with name MachineName.
Protected function void

AddNativeTransitionBinding ( const FName& MachineName,
const FName& PrevStateName,
const FName& NextStateName,
const FCanTakeTransition& NativeTransitionDelegate,
const FName& TransitionName
)

 Sets up a native transition delegate between states with PrevStateName and NextStateName, in the state machine with name MachineName.
Public function FPoseSnapshot &

AddPoseSnapshot ( FName SnapshotName
)

 Add an empty pose snapshot to the internal snapshot cache (or recycle an existing pose snapshot if the name is already in use)
Protected function Virtual void

AddReferencedObjects ( UAnimInstance* InAnimInstance,
FReferenceCollector& Collector
)

 Manually add object references to GC
Public function void

AddTickRecord ( const FAnimTickRecord& InTickRecord,
const UE::Anim::FAnimSyncParams& InSyncParams
)

 Adds a tick record in the list for the correct group or the ungrouped array.
Public function void

AnimDrawDebugCircle ( const FVector& Center,
float Radius,
int32 Segments,
const FColor& Color,
const FVector& UpVector,
bool bPersistentLines,
float LifeTime,
ESceneDepthPriorityGroup DepthPriority,
float Thickness
)

  
Public function void

AnimDrawDebugCone ( const FVector& Center,
float Radius,
const FVector& Direction,
float AngleWidth,
float AngleHeight,
int32 Segments,
const FColor& Color,
bool bPersistentLines,
float LifeTime,
ESceneDepthPriorityGroup DepthPriority,
float Thickness
)

  
Public function void

AnimDrawDebugCoordinateSystem ( FVector const& AxisLoc,
FRotator const& AxisRot,
float Scale,
bool bPersistentLines,
float LifeTime,
float Thickness,
ESceneDepthPriorityGroup DepthPriority
)

  
Public function void

AnimDrawDebugDirectionalArrow ( const FVector& LineStart,
const FVector& LineEnd,
float ArrowSize,
const FColor& Color,
bool bPersistentLines,
float LifeTime,
float Thickness,
ESceneDepthPriorityGroup DepthPriority
)

  
Public function void

AnimDrawDebugInWorldMessage ( const FString& DebugMessage,
const FVector& TextLocation,
const FColor& Color,
float TextScale
)

  
Public function void

AnimDrawDebugLine ( const FVector& StartLoc,
const FVector& EndLoc,
const FColor& Color,
bool bPersistentLines,
float LifeTime,
float Thickness,
ESceneDepthPriorityGroup DepthPriority
)

  
Public function void

AnimDrawDebugOnScreenMessage ( const FString& DebugMessage,
const FColor& Color,
const FVector2D& TextScale,
ESceneDepthPriorityGroup DepthPriority
)

  
Public function void

AnimDrawDebugPlane ( const FTransform& BaseTransform,
float Radii,
const FColor& Color,
bool bPersistentLines,
float LifeTime,
float Thickness,
ESceneDepthPriorityGroup DepthPriority
)

  
Public function void

AnimDrawDebugPoint ( const FVector& Loc,
float Size,
const FColor& Color,
bool bPersistentLines,
float LifeTime,
ESceneDepthPriorityGroup DepthPriority
)

  
Public function void

AnimDrawDebugSphere ( const FVector& Center,
float Radius,
int32 Segments,
const FColor& Color,
bool bPersistentLines,
float LifeTime,
float Thickness,
ESceneDepthPriorityGroup DepthPriority
)

  
Protected function void Bind any native delegates that we have set up
Protected function void

BlendSpaceAdvanceImmediate ( UBlendSpace* BlendSpace,
const FVector& BlendInput,
TArray< FBlendSampleData >& BlendSampleDataCache,
FBlendFilter& BlendFilter,
bool bLooping,
float PlayRate,
float DeltaSeconds,
float& CurrentTime,
FMarkerTickRecord& MarkerTickRecord
)

  
Protected function Virtual void Cache bones override point.
Protected function Virtual void Cache bones override point.
Protected function Static void  
Protected function Const float

CalcSlotMontageLocalWeight ( const FName& SlotNodeName
)

 Get local weight of any montages this slot is playing.
Protected function void Removes all queued transition requests
Protected function Virtual void Clear any UObjects we might be using.
Protected function void If it doesn't tick, it will keep old weight, so we'll have to clear it in the beginning of tick
Protected function void

ClearTransitionEvents ( const FName& EventName
)

 Removes all queued transition requests with the given event name
Protected function Virtual bool

Evaluate ( FPoseContext& Output
)

 Evaluate override point
Protected function Virtual bool

Evaluate_WithRoot ( FPoseContext& Output,
FAnimNode_Base* InRootNode
)

 Evaluate override point with root node override.
Protected function void Evaluates the anim graph if Evaluate() returns false
Protected function void Evaluates the anim graph given the specified root if Evaluate() returns false
Protected function void Evaluates the anim graph
Protected function void Evaluates the anim graph given the specified root
Protected function Static void  
Public function void Flip buffer read/write indices
Public function void Gather debug data from this instance proxy and the blend tree for display
Public function void

GatherDebugData_WithRoot ( FNodeDebugData& DebugData,
FAnimNode_Base* InRootNode,
FName InLayerName
)

 Gather debug data from this instance proxy and the specified blend tree root for display
Protected function Static void  
Protected function Const const FMontageEvaluationState * Get Currently active montage evaluation state.
Public function Const const FString &  
Public function Const const FTransform & Get the transform of the actor we are running on
Protected function Const const TMap< FName, float > &

GetAnimationCurves ( EAnimCurveType InCurveType
)

  
Protected function TMap< FName, float > &

GetAnimationCurves ( EAnimCurveType InCurveType
)

 Get the current value of all animation curves
Public function Const UAnimBlueprint *  
Public function Const FAnimBlueprintDebugData * Get the debug data for this instance's anim bp
Public function Const IAnimClassInterface * Get the IAnimClassInterface associated with this context, if there is one.
Public function Const const FString &  
Public function Const const UObject *  
Public function UObject * Access UObject base of UAnimInstance
Protected function Const int32 Gets the buffer we should be reading from.
Protected function Const int32 Gets the sync group we should be writing to.
Public function Const const FGraphTraversalCounter &  
Public function Const NodeType *

GetCheckedMutableNodeFromIndex ( int32 NodeIdx
)

 Gets a checked node given an index into the node property array
Public function FAnimNode_Base *

GetCheckedMutableNodeFromIndexUntyped ( int32 NodeIdx,
UScriptStruct* RequiredStructType
)

 Gets a checked node given an index into the node property array
Public function Const const NodeType *

GetCheckedNodeFromIndex ( int32 NodeIdx
)

 Gets a checked node given an index into the node property array
Public function Const const FAnimNode_Base *

GetCheckedNodeFromIndexUntyped ( int32 NodeIdx,
UScriptStruct* RequiredStructType
)

 Gets a checked node given an index into the node property array
Public function Const const FTransform & Get the relative transform of the component we are running on
Public function Const const FTransform & Get the component to world transform of the component we are running on
Protected function Virtual void Called when the anim instance is being initialized.
Protected function Virtual FAnimNode_Base * Called when the anim instance is being initialized.
Public function Const float Get the last DeltaSeconds passed into PreUpdate()
Public function Const const FGraphTraversalCounter &  
Public function FRootMotionMovementParams & Access root motion params
Public function Const const FGraphTraversalCounter & Access various counters
Public function Const int32

GetInstanceAssetPlayerIndex ( FName MachineName,
FName StateName,
FName InstanceName
)

 Get the index of the specified instance asset player.
Protected function Const float

GetInstanceAssetPlayerLength ( int32 AssetPlayerIndex
)

 Gets the length in seconds of the asset referenced in an asset player node
Public function Const TArray< const FAnimNode_AssetPlayerBase * >

GetInstanceAssetPlayers ( const FName& GraphName
)

 Returns all Animation Nodes of FAnimNode_AssetPlayerBase class within the specified (named) Animation Graph
Protected function Const float

GetInstanceAssetPlayerTime ( int32 AssetPlayerIndex
)

 Get the current accumulated time in seconds for an asset player node
Protected function Const float

GetInstanceAssetPlayerTimeFraction ( int32 AssetPlayerIndex
)

 Get the current accumulated time as a fraction for an asset player node
Protected function Const float

GetInstanceAssetPlayerTimeFromEnd ( int32 AssetPlayerIndex
)

 Get the time in seconds from the end of an animation in an asset player node
Protected function Const float

GetInstanceAssetPlayerTimeFromEndFraction ( int32 AssetPlayerIndex
)

 Get the time as a fraction of the asset length of an animation in an asset player node
Protected function Const float

GetInstanceCurrentStateElapsedTime ( int32 MachineIndex
)

 Get the current elapsed time of a state within the specified state machine
Protected function Const float

GetInstanceMachineWeight ( int32 MachineIndex
)

 Get the blend weight of a specified state
Public function Const TArray< const FAnimNode_AssetPlayerRelevancyBase * >

GetInstanceRelevantAssetPlayers ( const FName& GraphName
)

 Returns all Animation Nodes of FAnimNode_AssetPlayerRelevancyBase class within the specified (named) Animation Graph
Protected function Const float

GetInstanceStateWeight ( int32 MachineIndex,
int32 StateIndex
)

 Get the blend weight of a specified state
Protected function Const float

GetInstanceTransitionCrossfadeDuration ( int32 MachineIndex,
int32 TransitionIndex
)

 Get the crossfade duration of a specified transition
Protected function Const float

GetInstanceTransitionTimeElapsed ( int32 MachineIndex,
int32 TransitionIndex
)

 Get the elapsed time in seconds of a specified transition
Protected function Const float

GetInstanceTransitionTimeElapsedFraction ( int32 MachineIndex,
int32 TransitionIndex
)

 Get the elapsed time as a fraction of the crossfade duration of a specified transition
Public function Const int32 Access to LODLevel
Public function Static const FBakedAnimationStateMachine *

GetMachineDescription ( IAnimClassInterface* AnimBlueprintClass,
const FAnimNode_StateMachine* MachineInstance
)

 Get the machine description for the specified instance.
Public function Const FAnimInstanceProxy * Get the current main instance proxy.
Protected function TArray< FMontageEvaluationState > & Access montage array data
Protected function Const const TArray< FMontageEvaluationState > & Access montage array data
Public function TArray< FAnimNode_AssetPlayerBase * >

GetMutableInstanceAssetPlayers ( const FName& GraphName
)

 Returns all Animation Nodes of FAnimNode_AssetPlayerBase class within the specified (named) Animation Graph
Public function TArray< FAnimNode_AssetPlayerRelevancyBase * > Returns all Animation Nodes of FAnimNode_AssetPlayerRelevancyBase class within the specified (named) Animation Graph
Public function Const NodeType *

GetMutableNodeFromIndex ( int32 NodeIdx
)

 Gets an unchecked (can return nullptr) node given an index into the node property array
Public function FAnimNode_Base *

GetMutableNodeFromIndexUntyped ( int32 NodeIdx,
UScriptStruct* RequiredStructType
)

 Gets an unchecked (can return nullptr) node given an index into the node property array
Public function Const const NodeType *

GetNodeFromIndex ( int32 NodeIdx
)

 Gets an unchecked (can return nullptr) node given an index into the node property array
Public function Const const FAnimNode_Base *

GetNodeFromIndexUntyped ( int32 NodeIdx,
UScriptStruct* RequiredStructType
)

 Gets an unchecked (can return nullptr) node given an index into the node property array
Protected function NodeType * Gets an unchecked (can return nullptr) node given a property of the anim instance
Public function Const const FPoseSnapshot *

GetPoseSnapshot ( FName SnapshotName
)

 Get a cached pose snapshot by name
Public function Const float

GetRecordedMachineWeight ( const int32 InMachineClassIndex
)

  
Public function Const float

GetRecordedStateWeight ( const int32 InMachineClassIndex,
const int32 InStateIndex
)

  
Protected function Const float

GetRelevantAnimLength ( int32 MachineIndex,
int32 StateIndex
)

 Get the length in seconds of the most relevant animation in the source state
Protected function Const float

GetRelevantAnimTime ( int32 MachineIndex,
int32 StateIndex
)

 Get the current accumulated time in seconds for the most relevant animation in the source state
Protected function Const float

GetRelevantAnimTimeFraction ( int32 MachineIndex,
int32 StateIndex
)

 Get the current accumulated time as a fraction of the length of the most relevant animation in the source state
Protected function Const float

GetRelevantAnimTimeRemaining ( int32 MachineIndex,
int32 StateIndex
)

 Get the time remaining in seconds for the most relevant animation in the source state
Protected function Const float

GetRelevantAnimTimeRemainingFraction ( int32 MachineIndex,
int32 StateIndex
)

 Get the time remaining as a fraction of the duration for the most relevant animation in the source state
Protected function Const const FAnimNode_AssetPlayerRelevancyBase *

GetRelevantAssetPlayerInterfaceFromState ( int32 MachineIndex,
int32 StateIndex
)

 Gets the most relevant asset player in a specified state
Public function FBoneContainer & Access to required bones array
Public function Const const FBoneContainer & Const access to required bones array
Public function Const ERootMotionMode::Type Get the root motion mode assigned to this anim instance proxy.
Public function FAnimNode_Base *  
Public function USkeleton * Get the current skeleton we are using.
Public function Const USkeletalMeshComponent * Get the current skeletal mesh component we are running on.
Protected function TMap< FName, UE::Anim::FSlotInertializationRequest > &  
Public function bool  
Protected function Const float

GetSlotMontageGlobalWeight ( const FName& SlotNodeName
)

 Get Global weight of any montages this slot node is playing.
Protected function Const float

GetSlotMontageLocalWeight ( const FName& SlotNodeName
)

 Get local weight of any montages this slot node is playing.
Protected function Const float

GetSlotNodeGlobalWeight ( const FName& SlotNodeName
)

 Get global weight in AnimGraph for this slot node.
Public function Const const FGraphTraversalCounter &  
Public function Const void

GetSlotWeight ( const FName& SlotNodeName,
float& out_SlotNodeWeight,
float& out_SourceWeight,
float& out_TotalNodeWeight
)

 Get Slot Node Weight : this returns new Slot Node Weight, Source Weight, Original TotalNodeWeight this 3 values can't be derived from each other
Protected function Const int32

GetStateMachineIndex ( FName MachineName
)

 Gets the index of the state machine matching MachineName
Protected function Const int32 Gets the index of the state machine
Protected function Const void

GetStateMachineIndexAndDescription ( FName InMachineName,
int32& OutMachineIndex,
const FBakedAnimationStateMachine** OutMachineDescription
)

  
Public function Const const FAnimNode_StateMachine *

GetStateMachineInstance ( int32 MachineIndex
)

 Gets the runtime instance of the specified state machine
Protected function Const const FBakedAnimationStateMachine * Gets the runtime instance desc of the state machine specified by name
Public function Const const FAnimNode_StateMachine * Gets the runtime instance of the specified state machine by Name
Protected function Const int32

GetSyncGroupIndexFromName ( FName SyncGroupName
)

 Returns the baked sync group index from the compile step
Public function Const const FSyncGroupMap & Get the sync group we are currently reading from
Protected function Const FMarkerSyncAnimPosition

GetSyncGroupPosition ( FName InSyncGroupName
)

  
Public function Const float Get the last time dilation, gleaned from world settings
Protected function Const bool

GetTimeToClosestMarker ( FName SyncGroup,
FName MarkerName,
float& OutMarkerTime
)

  
Public function const TArray< FAnimTickRecord > & Get the ungrouped active player we are currently reading from
Public function Const const FGraphTraversalCounter &  
Protected function Const bool Check whether we have any active curves
Protected function Const bool

HasMarkerBeenHitThisFrame ( FName SyncGroup,
FName MarkerName
)

  
Protected function bool

HasNativeStateEntryBinding ( const FName& MachineName,
const FName& StateName,
FName& OutBindingName
)

 Check for whether a native entry delegate is bound to the specified state.
Protected function bool

HasNativeStateExitBinding ( const FName& MachineName,
const FName& StateName,
FName& OutBindingName
)

 Check for whether a native exit delegate is bound to the specified state.
Protected function bool

HasNativeTransitionBinding ( const FName& MachineName,
const FName& PrevStateName,
const FName& NextStateName,
FName& OutBindingName
)

 Check for whether a native rule is bound to the specified transition.
Public function Const bool Check whether we have a valid root node
Protected function Virtual void

Initialize ( UAnimInstance* InAnimInstance
)

 Called when our anim instance is being initialized
Protected function Static void

InitializeInputProxy ( FAnimInstanceProxy* InputProxy,
UAnimInstance* InAnimInstance
)

 Custom proxy Init/Cache/Update/Evaluate functions
Protected function Virtual void

InitializeObjects ( UAnimInstance* InAnimInstance
)

 Copy any UObjects we might be using. Called Pre-update and pre-evaluate.
Protected function void

InitializeRootNode ( bool bInDeferRootNodeInitialization
)

 Initialize the root node - split into a separate function for backwards compatibility (initialization order) reasons
Protected function void Initialize the specified root node
Public function Const bool Whether the UAnimInstance this context refers to is currently being debugged in the editor
Public function Const bool

IsSlotNodeRelevantForNotifies ( const FName& SlotNodeName
)

  
Protected function Const bool

IsSyncGroupBetweenMarkers ( FName InSyncGroupName,
FName PreviousMarker,
FName NextMarker,
bool bRespectMarkerOrder
)

  
Public function Const bool

IsSyncGroupValid ( FName InSyncGroupName
)

 Returns true if SyncGroupName is valid (exists, and if is based on markers, has valid markers)
Protected function Const void

LogMessage ( FName InLogType,
EMessageSeverity::Type InSeverity,
const FText& InMessage
)

 Allow nodes to register log messages to be processed on the game thread
Protected function Const void

LogMessage ( FName InLogType,
const TSharedRef< FTokenizedMessage >& InMessage
)

 Allow nodes to register log messages to be processed on the game thread
Protected function void

OnPreUpdateLODChanged ( const int32 PreviousLODIndex,
const int32 NewLODIndex
)

 Called during PreUpdate, if SkelMesh LOD has changed since last update
Protected function Virtual void

PostEvaluate ( UAnimInstance* InAnimInstance
)

 Called after evaluate so we can do any game thread work we need to
Protected function Virtual Const void

PostUpdate ( UAnimInstance* InAnimInstance
)

 Called after update so we can copy any data we need
Protected function Virtual void

PreEvaluateAnimation ( UAnimInstance* InAnimInstance
)

 Called on the game thread pre-evaluate.
Protected function Virtual void

PreUpdate ( UAnimInstance* InAnimInstance,
float DeltaSeconds
)

 Called before update so we can copy any data we need
Protected function bool

QueryAndMarkTransitionEvent ( int32 MachineIndex,
int32 TransitionIndex,
const FName& EventName
)

 Behaves like QueryTransitionEvent but additionally marks the event for consumption
Protected function Const bool

QueryTransitionEvent ( int32 MachineIndex,
int32 TransitionIndex,
const FName& EventName
)

 Returns whether or not the given event transition request has been queued
Protected function void Recalculate Required Bones [RequiredBones] Is called when bRequiredBonesUpToDate = false The provided asset must be a SkeletalMesh or a Skeleton.
Protected function void

RecalcRequiredCurves ( const UE::Anim::FCurveFilterSettings& CurveFilterSettings
)

 Recalculate required curve list for animation - if you call RecalcRequiredBones, this should already happen
Public function void

RecordMachineWeight ( const int32 InMachineClassIndex,
const float InMachineWeight
)

  
Public function void

RecordNodeAttribute ( const FAnimInstanceProxy& InSourceProxy,
int32 InTargetNodeIndex,
int32 InSourceNodeIndex,
FName InAttribute
)

 Record a node attribute in the debugger
Public function void

RecordNodeSync ( int32 InSourceNodeIndex,
FName InSyncGroup
)

 Record a node sync in the debugger
Public function void

RecordNodeVisit ( int32 TargetNodeIndex,
int32 SourceNodeIndex,
float BlendWeight
)

 Record a visited node in the debugger
Public function void

RecordStateWeight ( const int32 InMachineClassIndex,
const int32 InStateIndex,
const float InStateWeight,
const float InElapsedTime
)

  
Public function void

RegisterSlotNodeWithAnimInstance ( const FName& SlotNodeName
)

 Register a named slot
Public function void

RegisterWatchedPose ( const FCompactPose& Pose,
const FBlendedCurve& InCurve,
int32 LinkID
)

 Record pose for node of ID LinkID if it is currently being watched.
Protected function void Slot node run-time functions
Public function void

RemovePoseSnapshot ( FName SnapshotName
)

 Remove a previously saved pose snapshot from the internal snapshot cache
Protected function bool

RequestTransitionEvent ( const FName& EventName,
const double RequestTimeout,
const ETransitionRequestQueueMode& QueueMode,
const ETransitionRequestOverwriteMode& OverwriteMode
)

 Attempts to queue a transition request, returns true if successful
Protected function void Reset Animation Curves
Protected function Static void  
Public function void

ResetDynamics ( ETeleportType InTeleportType
)

 Reset any dynamics running simulation-style updates (e.g. on teleport, time skip etc.)
Protected function void Reset the sync system to its starting state
Public function void  
Public function void

SavePoseSnapshot ( USkeletalMeshComponent* InSkeletalMeshComponent,
FName SnapshotName
)

 Save a pose snapshot to the internal snapshot cache
Protected function void

SequenceAdvanceImmediate ( UAnimSequenceBase* Sequence,
bool bLooping,
float PlayRate,
float DeltaSeconds,
float& CurrentTime,
FMarkerTickRecord& MarkerTickRecord
)

  
Protected function void

SetSyncMirror ( const UMirrorDataTable* MirrorDataTable
)

 Set the mirror data table to sync animations.
Public function Const bool Check whether we should extract root motion
Public function void

SlotEvaluatePose ( const FName& SlotNodeName,
const FAnimationPoseData& SourceAnimationPoseData,
float InSourceWeight,
FAnimationPoseData& OutBlendedAnimationPoseData,
float InBlendWeight,
float InTotalNodeWeight
)

  
Public function void

TriggerAnimNotifies ( USkeletalMeshComponent* SkelMeshComp,
float DeltaSeconds
)

 Trigger any anim notifies
Protected function Virtual void

Uninitialize ( UAnimInstance* InAnimInstance
)

 Called when our anim instance is being uninitialized
Protected function Virtual void

Update ( float DeltaSeconds
)

 Update override point
Protected function void Let us copy the full notify queue from the last frame
Protected function void Calls Update(), updates the anim graph, ticks asset players
Protected function void

UpdateAnimation_WithRoot ( const FAnimationUpdateContext& InContext,
FAnimNode_Base* InRootNode,
FName InLayerName
)

 Calls Update(), updates the anim graph from the specified root, ticks asset players
Protected function Virtual void Updates the anim graph
Protected function Virtual void

UpdateAnimationNode_WithRoot ( const FAnimationUpdateContext& InContext,
FAnimNode_Base* InRootNode,
FName InLayerName
)

 Updates the anim graph using a specified root node
Protected function void Update curves once evaluation has taken place. Mostly pushes curves to materials/morphs
Protected function void Pushes blended heap curve to output curves in the proxy using required bones cached data
Protected function Static void  
Public function void

UpdateSlotNodeWeight ( const FName& SlotNodeName,
float InLocalMontageWeight,
float InNodeGlobalWeight
)

 Allow slot nodes to store off their weight during ticking.
Protected function Const bool Get whether the animation notify with the specified name triggered last tick.
Protected function Const bool

WasAnimNotifyNameTriggeredInSourceState ( int32 MachineIndex,
int32 StateIndex,
FName NotifyName
)

 Get whether the most relevant animation triggered the given notify last tick.
Protected function bool

WasAnimNotifyNameTriggeredInStateMachine ( int32 MachineIndex,
FName NotifyName
)

 Get whether the given state machine triggered the animation notify with the specified name last tick.
Protected function Const bool Get whether a particular notify state was active in any state machine last tick.
Protected function Const bool

WasAnimNotifyStateActiveInSourceState ( int32 MachineIndex,
int32 StateIndex,
TSubclassOf< UAnimNotifyState > AnimNotifyStateType
)

 Get whether the most relevant animation was in a particular notify state last tick.
Protected function Const bool

WasAnimNotifyStateActiveInStateMachine ( int32 MachineIndex,
TSubclassOf< UAnimNotifyState > AnimNotifyStateType
)

 Get whether a particular notify state is active in a specific state machine last tick.
Protected function Const bool Get whether an animation notify of a given type was triggered last tick.
Protected function Const bool

WasAnimNotifyTriggeredInSourceState ( int32 MachineIndex,
int32 StateIndex,
TSubclassOf< UAnimNotify > AnimNotifyType
)

 Get whether the most relevant animation triggered the given notify last tick.
Protected function Const bool

WasAnimNotifyTriggeredInStateMachine ( int32 MachineIndex,
TSubclassOf< UAnimNotify > AnimNotifyType
)

 Get whether a particular notify type was active in a specific state machine last tick.

Operators

  Type Name Description
Public function FAnimInstanceProxy &  
Public function FAnimInstanceProxy &  

Typedefs

Name Description
FLogMessageEntry Logged message queues.
FSyncGroupMap  

Deprecated Functions

  Type Name Description
Protected function void

AddCurveValue ( const FSmartNameMapping& Mapping,
const FName& CurveName,
float Value
)

 Please use AddCurveValue that does not take a FSmartNameMapping.
Public function FAnimTickRecord &

CreateUninitializedTickRecord ( int32 GroupIndex,
FAnimGroupInstance*& OutSyncGroupPtr
)

 Please use the overload that takes a group FName
Public function FAnimTickRecord &

CreateUninitializedTickRecord ( FAnimGroupInstance*& OutSyncGroupPtr,
FName GroupName
)

 Please use FAnimSyncGroupScope
Public function FAnimTickRecord &

CreateUninitializedTickRecordInScope ( int32 GroupIndex,
EAnimSyncGroupScope Scope,
FAnimGroupInstance*& OutSyncGroupPtr
)

 Please use the overload that takes a group FName
Public function FAnimTickRecord &

CreateUninitializedTickRecordInScope ( FAnimGroupInstance*& OutSyncGroupPtr,
FName GroupName,
EAnimSyncGroupScope Scope
)

 Please use FAnimSyncGroupScope
Protected function Const const FAnimNode_AssetPlayerBase *

GetRelevantAssetPlayerFromState ( int32 MachineIndex,
int32 StateIndex
)

 Please use GetRelevantAssetPlayerInterfaceFromState
Public function Const const FTransform & Please use GetComponentTransform
Public function Const const FTransform & Please use GetActorTransform
Public function Const const TArray< FAnimGroupInstance > & Sync groups are no longer stored in arrays, please use GetSyncGroupMapRead.
Protected function Const int32 Function renamed to GetBufferReadIndex as this no longer deals with sync groups.
Protected function Const int32 Function renamed to GetBufferWriteIndex as this no longer deals with sync groups.
Public function Const bool

IsSkeletonCompatible ( USkeleton const* InSkeleton
)

 Skeleton compatibility is now an editor-only concern, this function is no longer used.
Public function Const void

MakeBlendSpaceTickRecord ( FAnimTickRecord& TickRecord,
UBlendSpace* BlendSpace,
const FVector& BlendInput,
TArray< FBlendSampleData >& BlendSampleDataCache,
FBlendFilter& BlendFilter,
bool bLooping,
float PlayRate,
float FinalBlendWeight,
float& CurrentTime,
FMarkerTickRecord& MarkerTickRecord
)

 Please use the FAnimTickRecord constructor that takes a UBlendSpace
Public function Const void

MakePoseAssetTickRecord ( FAnimTickRecord& TickRecord,
UPoseAsset* PoseAsset,
float FinalBlendWeight
)

 Please use the FAnimTickRecord constructor that takes a UPoseAsset
Public function Const void

MakeSequenceTickRecord ( FAnimTickRecord& TickRecord,
UAnimSequenceBase* Sequence,
bool bLooping,
float PlayRate,
float FinalBlendWeight,
float& CurrentTime,
FMarkerTickRecord& MarkerTickRecord
)

 Please use the FAnimTickRecord constructor that takes a UAnimSequenceBase
Protected function void

RecalcRequiredCurves ( const FCurveEvaluationOption& CurveEvalOption
)

 Please use RecalcRequiredCurves that takes a FCurveEvaluationOption.
Public function void

RegisterWatchedPose ( const FCSPose< FCompactPose >& Pose,
int32 LinkID
)

 Please use RegisterWatchedPose that takes a pose and a curve
Public function void

RegisterWatchedPose ( const FCSPose< FCompactPose >& Pose,
const FBlendedCurve& InCurve,
int32 LinkID
)

 Please use RegisterWatchedPose that takes a pose and a curve
Public function void

RegisterWatchedPose ( const FCompactPose& Pose,
int32 LinkID
)

 Please use RegisterWatchedPose that takes a pose and a curve
Public function void Please use ResetDynamics with a ETeleportType argument
Public function void

SlotEvaluatePose ( const FName& SlotNodeName,
const FCompactPose& SourcePose,
const FBlendedCurve& SourceCurve,
float InSourceWeight,
FCompactPose& BlendedPose,
FBlendedCurve& BlendedCurve,
float InBlendWeight,
float InTotalNodeWeight
)

 Use SlotEvaluatePose with other signature
Public function void Do not call directly. Instead sync and asset player ticking is controlled via UE::Anim::FSync and UE::Anim::FSyncScope.
Public function void

TickAssetPlayerInstances ( float DeltaSeconds
)

 Do not call directly. Instead sync and asset player ticking is controlled via UE::Anim::FSync and UE::Anim::FSyncScope.
Public function void Function renamed to FlipBufferWriteIndex as this no longer deals with sync groups.
Protected function void This function is no longer used.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page