UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FPoseContext Struct Reference

#include <AnimNodeBase.h>

+ Inheritance diagram for FPoseContext:

Public Member Functions

 FPoseContext (FAnimInstanceProxy *InAnimInstanceProxy, bool bInExpectsAdditivePose=false)
 
 FPoseContext (const FPoseContext &SourceContext, bool bInOverrideExpectsAdditivePose=false)
 
 FPoseContext (const FBoneContainer &InRequiredBones, bool bInExpectsAdditivePose=false)
 
void Initialize (FAnimInstanceProxy *InAnimInstanceProxy)
 
void LogMessage (const TSharedRef< FTokenizedMessage > &InMessage) const
 
void LogMessage (EMessageSeverity::Type InSeverity, FText InMessage) const
 
void ResetToRefPose ()
 
void ResetToAdditiveIdentity ()
 
bool ContainsNaN () const
 
bool IsNormalized () const
 
FPoseContextoperator= (const FPoseContext &Other)
 
bool ExpectsAdditivePose () const
 
- Public Member Functions inherited from FAnimationBaseContext
ENGINE_API FAnimationBaseContext ()
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS FAnimationBaseContext (FAnimationBaseContext &&)=default
 
 FAnimationBaseContext (const FAnimationBaseContext &)=default
 
FAnimationBaseContextoperator= (FAnimationBaseContext &&)=default
 
FAnimationBaseContextoperator= (const FAnimationBaseContext &)=default
 
ENGINE_API IAnimClassInterfaceGetAnimClass () const
 
ENGINE_API UObjectGetAnimInstanceObject () const
 
template<typename NodeType >
FScopedAnimNodeTracker TrackAncestor (NodeType *Node) const
 
template<typename NodeType >
NodeType * GetAncestor () const
 
template<typename TGraphMessageType >
TGraphMessageTypeGetMessage () const
 
template<typename TGraphMessageType >
TGraphMessageTypeFindMessage (TFunctionRef< bool(TGraphMessageType &)> InFunction) const
 
template<typename TGraphMessageType >
TGraphMessageTypeGetMessageChecked () const
 
void SetNodeId (int32 InNodeId)
 
void SetNodeIds (const FAnimationBaseContext &InContext)
 
int32 GetCurrentNodeId () const
 
int32 GetPreviousNodeId () const
 
bool IsActive () const
 

Public Attributes

FCompactPose Pose
 
FBlendedCurve Curve
 
UE::Anim::FStackAttributeContainer CustomAttributes
 
- Public Attributes inherited from FAnimationBaseContext
FAnimInstanceProxyAnimInstanceProxy
 
FAnimationUpdateSharedContextSharedContext
 

Friends

class FScopedExpectsAdditiveOverride
 

Additional Inherited Members

- Protected Member Functions inherited from FAnimationBaseContext
ENGINE_API FAnimationBaseContext (UAnimInstance *InAnimInstance)
 
ENGINE_API FAnimationBaseContext (FAnimInstanceProxy *InAnimInstanceProxy, FAnimationUpdateSharedContext *InSharedContext=nullptr)
 
ENGINE_API void LogMessageInternal (FName InLogType, const TSharedRef< FTokenizedMessage > &InMessage) const
 
- Protected Attributes inherited from FAnimationBaseContext
bool bIsActive = true
 
int32 CurrentNodeId
 
int32 PreviousNodeId
 

Detailed Description

Evaluation context passed around during animation tree evaluation

Constructor & Destructor Documentation

◆ FPoseContext() [1/3]

FPoseContext::FPoseContext ( FAnimInstanceProxy InAnimInstanceProxy,
bool  bInExpectsAdditivePose = false 
)
inline

◆ FPoseContext() [2/3]

FPoseContext::FPoseContext ( const FPoseContext SourceContext,
bool  bInOverrideExpectsAdditivePose = false 
)
inline

◆ FPoseContext() [3/3]

FPoseContext::FPoseContext ( const FBoneContainer InRequiredBones,
bool  bInExpectsAdditivePose = false 
)
inline

Member Function Documentation

◆ ContainsNaN()

bool FPoseContext::ContainsNaN ( ) const
inline

◆ ExpectsAdditivePose()

bool FPoseContext::ExpectsAdditivePose ( ) const
inline

◆ Initialize()

void FPoseContext::Initialize ( FAnimInstanceProxy InAnimInstanceProxy)
inline

◆ IsNormalized()

bool FPoseContext::IsNormalized ( ) const
inline

◆ LogMessage() [1/2]

void FPoseContext::LogMessage ( const TSharedRef< FTokenizedMessage > &  InMessage) const
inline

◆ LogMessage() [2/2]

void FPoseContext::LogMessage ( EMessageSeverity::Type  InSeverity,
FText  InMessage 
) const
inline

◆ operator=()

FPoseContext & FPoseContext::operator= ( const FPoseContext Other)
inline

◆ ResetToAdditiveIdentity()

void FPoseContext::ResetToAdditiveIdentity ( )
inline

◆ ResetToRefPose()

void FPoseContext::ResetToRefPose ( )
inline

Friends And Related Symbol Documentation

◆ FScopedExpectsAdditiveOverride

Member Data Documentation

◆ Curve

FBlendedCurve FPoseContext::Curve

◆ CustomAttributes

UE::Anim::FStackAttributeContainer FPoseContext::CustomAttributes

◆ Pose

FCompactPose FPoseContext::Pose

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