FAnimationUpdateContext Struct Reference

#include <AnimNodeBase.h>

Inheritance diagram for FAnimationUpdateContext:

Public Member Functions
	FAnimationUpdateContext (FAnimInstanceProxy *InAnimInstanceProxy=nullptr)
	FAnimationUpdateContext (FAnimInstanceProxy *InAnimInstanceProxy, float InDeltaTime, FAnimationUpdateSharedContext *InSharedContext=nullptr)
	FAnimationUpdateContext (const FAnimationUpdateContext &Copy, FAnimInstanceProxy *InAnimInstanceProxy)
FAnimationUpdateContext	WithOtherProxy (FAnimInstanceProxy *InAnimInstanceProxy) const
FAnimationUpdateContext	WithOtherSharedContext (FAnimationUpdateSharedContext *InSharedContext) const
FAnimationUpdateContext	AsInactive () const
FAnimationUpdateContext	FractionalWeight (float WeightMultiplier) const
FAnimationUpdateContext	FractionalWeightAndRootMotion (float WeightMultiplier, float RootMotionMultiplier) const
FAnimationUpdateContext	FractionalWeightAndTime (float WeightMultiplier, float TimeMultiplier) const
FAnimationUpdateContext	FractionalWeightTimeAndRootMotion (float WeightMultiplier, float TimeMultiplier, float RootMotionMultiplier) const
FAnimationUpdateContext	WithNodeId (int32 InNodeId) const
FAnimationUpdateSharedContext *	GetSharedContext () const
float	GetFinalBlendWeight () const
float	GetRootMotionWeightModifier () const
float	GetDeltaTime () const
void	LogMessage (const TSharedRef< FTokenizedMessage > &InMessage) const
void	LogMessage (EMessageSeverity::Type InSeverity, FText InMessage) const
Public Member Functions inherited from FAnimationBaseContext
ENGINE_API	FAnimationBaseContext ()
PRAGMA_DISABLE_DEPRECATION_WARNINGS	FAnimationBaseContext (FAnimationBaseContext &&)=default
	FAnimationBaseContext (const FAnimationBaseContext &)=default
FAnimationBaseContext &	operator= (FAnimationBaseContext &&)=default
FAnimationBaseContext &	operator= (const FAnimationBaseContext &)=default
ENGINE_API IAnimClassInterface *	GetAnimClass () const
ENGINE_API UObject *	GetAnimInstanceObject () const
template<typename NodeType >
FScopedAnimNodeTracker	TrackAncestor (NodeType *Node) const
template<typename NodeType >
NodeType *	GetAncestor () const
template<typename TGraphMessageType >
TGraphMessageType *	GetMessage () const
template<typename TGraphMessageType >
TGraphMessageType *	FindMessage (TFunctionRef< bool(TGraphMessageType &)> InFunction) const
template<typename TGraphMessageType >
TGraphMessageType &	GetMessageChecked () const
void	SetNodeId (int32 InNodeId)
void	SetNodeIds (const FAnimationBaseContext &InContext)
int32	GetCurrentNodeId () const
int32	GetPreviousNodeId () const
bool	IsActive () const

Additional Inherited Members
Public Attributes inherited from FAnimationBaseContext
FAnimInstanceProxy *	AnimInstanceProxy
FAnimationUpdateSharedContext *	SharedContext
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

Update context passed around during animation tree update

Constructor & Destructor Documentation

FAnimationUpdateContext() [1/3]

FAnimationUpdateContext::FAnimationUpdateContext ( FAnimInstanceProxy *  InAnimInstanceProxy = nullptr )

inline

FAnimationUpdateContext() [2/3]

FAnimationUpdateContext::FAnimationUpdateContext ( FAnimInstanceProxy *  InAnimInstanceProxy, float  InDeltaTime, FAnimationUpdateSharedContext *  InSharedContext = nullptr  )

inline

FAnimationUpdateContext() [3/3]

FAnimationUpdateContext::FAnimationUpdateContext ( const FAnimationUpdateContext &  Copy, FAnimInstanceProxy *  InAnimInstanceProxy  )

inline

Member Function Documentation

AsInactive()

FAnimationUpdateContext FAnimationUpdateContext::AsInactive ( ) const

inline

FractionalWeight()

FAnimationUpdateContext FAnimationUpdateContext::FractionalWeight ( float  WeightMultiplier ) const

inline

FractionalWeightAndRootMotion()

FAnimationUpdateContext FAnimationUpdateContext::FractionalWeightAndRootMotion ( float  WeightMultiplier, float  RootMotionMultiplier  ) const

inline

FractionalWeightAndTime()

FAnimationUpdateContext FAnimationUpdateContext::FractionalWeightAndTime ( float  WeightMultiplier, float  TimeMultiplier  ) const

inline

FractionalWeightTimeAndRootMotion()

FAnimationUpdateContext FAnimationUpdateContext::FractionalWeightTimeAndRootMotion ( float  WeightMultiplier, float  TimeMultiplier, float  RootMotionMultiplier  ) const

inline

GetDeltaTime()

float FAnimationUpdateContext::GetDeltaTime ( ) const

inline

GetFinalBlendWeight()

float FAnimationUpdateContext::GetFinalBlendWeight ( ) const

inline

GetRootMotionWeightModifier()

float FAnimationUpdateContext::GetRootMotionWeightModifier ( ) const

inline

GetSharedContext()

FAnimationUpdateSharedContext * FAnimationUpdateContext::GetSharedContext ( ) const

inline

LogMessage() [1/2]

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

inline

LogMessage() [2/2]

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

inline

WithNodeId()

FAnimationUpdateContext FAnimationUpdateContext::WithNodeId ( int32  InNodeId ) const

inline

WithOtherProxy()

FAnimationUpdateContext FAnimationUpdateContext::WithOtherProxy ( FAnimInstanceProxy *  InAnimInstanceProxy ) const

inline

WithOtherSharedContext()

FAnimationUpdateContext FAnimationUpdateContext::WithOtherSharedContext ( FAnimationUpdateSharedContext *  InSharedContext ) const

inline

---

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

• Engine/Source/Runtime/Engine/Classes/Animation/AnimNodeBase.h