UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FAnimNode_PoseByName Struct Reference

#include <AnimNode_PoseByName.h>

+ Inheritance diagram for FAnimNode_PoseByName:

Public Member Functions

 FAnimNode_PoseByName ()
 
virtual ANIMGRAPHRUNTIME_API void Initialize_AnyThread (const FAnimationInitializeContext &Context) override
 
virtual ANIMGRAPHRUNTIME_API void UpdateAssetPlayer (const FAnimationUpdateContext &Context) override
 
virtual ANIMGRAPHRUNTIME_API void Evaluate_AnyThread (FPoseContext &Output) override
 
virtual ANIMGRAPHRUNTIME_API void GatherDebugData (FNodeDebugData &DebugData) override
 
- Public Member Functions inherited from FAnimNode_PoseHandler
 FAnimNode_PoseHandler ()
 
virtual float GetCurrentAssetTime () const
 
virtual float GetCurrentAssetLength () const
 
virtual ANIMGRAPHRUNTIME_API void CacheBones_AnyThread (const FAnimationCacheBonesContext &Context) override
 
virtual float GetAccumulatedTime () const
 
virtual void SetAccumulatedTime (float NewTime)
 
virtual UAnimationAsset * GetAnimAsset () const
 
- Public Member Functions inherited from FAnimNode_AssetPlayerBase
 FAnimNode_AssetPlayerBase ()=default
 
virtual ENGINE_API void Update_AnyThread (const FAnimationUpdateContext &Context) final override
 
ENGINE_API void CreateTickRecordForNode (const FAnimationUpdateContext &Context, UAnimSequenceBase *Sequence, bool bLooping, float PlayRate, bool bIsEvaluator)
 
virtual FName GetGroupName () const
 
virtual EAnimGroupRole::Type GetGroupRole () const
 
virtual EAnimSyncMethod GetGroupMethod () const
 
virtual bool GetOverridePositionWhenJoiningSyncGroupAsLeader () const
 
virtual bool SetGroupName (FName InGroupName)
 
virtual bool SetGroupRole (EAnimGroupRole::Type InRole)
 
virtual bool SetGroupMethod (EAnimSyncMethod InMethod)
 
virtual bool SetOverridePositionWhenJoiningSyncGroupAsLeader (bool InOverridePositionWhenJoiningSyncGroupAsLeader)
 
virtual ENGINE_API float GetCachedBlendWeight () const override
 
virtual ENGINE_API void ClearCachedBlendWeight () override
 
virtual ENGINE_API float GetCurrentAssetTimePlayRateAdjusted () const override
 
virtual ENGINE_API const FDeltaTimeRecord * GetDeltaTimeRecord () const override
 
- Public Member Functions inherited from FAnimNode_AssetPlayerRelevancyBase
virtual ENGINE_API bool IsLooping () const
 
virtual ENGINE_API bool GetIgnoreForRelevancyTest () const
 
virtual ENGINE_API bool SetIgnoreForRelevancyTest (bool bInIgnoreForRelevancyTest)
 
- Public Member Functions inherited from FAnimNode_Base
virtual ENGINE_API void EvaluateComponentSpace_AnyThread (FComponentSpacePoseContext &Output)
 
virtual bool CanUpdateInWorkerThread () const
 
virtual bool HasPreUpdate () const
 
virtual void PreUpdate (const UAnimInstance *InAnimInstance)
 
virtual bool NeedsDynamicReset () const
 
virtual ENGINE_API void ResetDynamics (ETeleportType InTeleportType)
 
virtual void PostCompile (const class USkeleton *InSkeleton)
 
virtual bool NeedsOnInitializeAnimInstance () const
 
virtual ~FAnimNode_Base ()
 
virtual void ResetDynamics ()
 
virtual bool WantsSkippedUpdates () const
 
virtual void OnUpdatesSkipped (TArrayView< const FAnimationUpdateContext * > SkippedUpdateContexts)
 
virtual void OverrideAsset (class UAnimationAsset *NewAsset)
 
ENGINE_API const FExposedValueHandler & GetEvaluateGraphExposedInputs () const
 
void SetExposedValueHandler (const FExposedValueHandler *Handler)
 
int32 GetNodeIndex () const
 
const IAnimClassInterface * GetAnimClassInterface () const
 

Public Attributes

FName PoseName
 
float PoseWeight
 
- Public Attributes inherited from FAnimNode_PoseHandler
TObjectPtr< UPoseAsset > PoseAsset
 

Additional Inherited Members

- Protected Member Functions inherited from FAnimNode_PoseHandler
virtual void OnPoseAssetChange ()
 
ANIMGRAPHRUNTIME_API void CacheBoneBlendWeights (FAnimInstanceProxy *InstanceProxy)
 
- Protected Member Functions inherited from FAnimNode_AssetPlayerBase
ENGINE_API UE::Anim::FAnimSyncParams GetSyncParams (bool bRequestedInertialization) const
 
- Protected Member Functions inherited from FAnimNode_Base
template<typename DataType >
const DataType & GetData (UE::Anim::FNodeDataId InId, const UObject *InObject=nullptr) const
 
template<typename DataType >
DataType * GetInstanceDataPtr (UE::Anim::FNodeDataId InId, UObject *InObject=nullptr)
 
ENGINE_API bool IsLODEnabled (FAnimInstanceProxy *AnimInstanceProxy)
 
virtual int32 GetLODThreshold () const
 
virtual ENGINE_API void OnInitializeAnimInstance (const FAnimInstanceProxy *InProxy, const UAnimInstance *InAnimInstance)
 
- Protected Attributes inherited from FAnimNode_PoseHandler
TWeakObjectPtr< UPoseAsset > CurrentPoseAsset
 
FAnimExtractContext PoseExtractContext
 
TArray< float > BoneBlendWeights
 
- Protected Attributes inherited from FAnimNode_AssetPlayerBase
FMarkerTickRecord MarkerTickRecord
 
float BlendWeight = 0.0f
 
float InternalTimeAccumulator = 0.0f
 
FDeltaTimeRecord DeltaTimeRecord
 
bool bHasBeenFullWeight = false
 

Constructor & Destructor Documentation

◆ FAnimNode_PoseByName()

FAnimNode_PoseByName::FAnimNode_PoseByName ( )
inline

Member Function Documentation

◆ Evaluate_AnyThread()

void FAnimNode_PoseByName::Evaluate_AnyThread ( FPoseContext &  Output)
overridevirtual

Called to evaluate local-space bones transforms according to the weights set up in Update(). You should implement either Evaluate or EvaluateComponentSpace, but not both of these. This can be called on any thread.

Parameters
OutputOutput structure to write pose or curve data to. Also provides access to relevant data as a context.

Reimplemented from FAnimNode_Base.

◆ GatherDebugData()

void FAnimNode_PoseByName::GatherDebugData ( FNodeDebugData &  DebugData)
overridevirtual

Called to gather on-screen debug data. This is called on the game thread.

Parameters
DebugDataDebug data structure used to output any relevant data

Reimplemented from FAnimNode_PoseHandler.

◆ Initialize_AnyThread()

void FAnimNode_PoseByName::Initialize_AnyThread ( const FAnimationInitializeContext &  Context)
overridevirtual

Initialize function for setup purposes

Reimplemented from FAnimNode_PoseHandler.

◆ UpdateAssetPlayer()

void FAnimNode_PoseByName::UpdateAssetPlayer ( const FAnimationUpdateContext &  Context)
overridevirtual

Update method for the asset player, to be implemented by derived classes

Reimplemented from FAnimNode_PoseHandler.

Member Data Documentation

◆ PoseName

FName FAnimNode_PoseByName::PoseName

◆ PoseWeight

float FAnimNode_PoseByName::PoseWeight
The documentation for this struct was generated from the following files: