FAnimationBaseContext Struct Reference

#include <AnimNodeBase.h>

Inheritance diagram for FAnimationBaseContext:

Public Member Functions
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

Public Attributes
FAnimInstanceProxy *	AnimInstanceProxy
FAnimationUpdateSharedContext *	SharedContext

Protected Member Functions
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
bool	bIsActive = true
int32	CurrentNodeId
int32	PreviousNodeId

Detailed Description

Base class for update/evaluate contexts

Constructor & Destructor Documentation

FAnimationBaseContext() [1/5]

FAnimationBaseContext::FAnimationBaseContext

(

)

FAnimationBaseContext() [2/5]

ENGINE_API FAnimationBaseContext::FAnimationBaseContext ( UAnimInstance *  InAnimInstance )

protected

FAnimationBaseContext() [3/5]

FAnimationBaseContext::FAnimationBaseContext ( FAnimInstanceProxy *  InAnimInstanceProxy, FAnimationUpdateSharedContext *  InSharedContext = nullptr  )

protected

FAnimationBaseContext() [4/5]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FAnimationBaseContext::FAnimationBaseContext ( FAnimationBaseContext &&  )

default

FAnimationBaseContext() [5/5]

FAnimationBaseContext::FAnimationBaseContext ( const FAnimationBaseContext &  )

default

Member Function Documentation

FindMessage()

template<typename TGraphMessageType >

TGraphMessageType * FAnimationBaseContext::FindMessage ( TFunctionRef< bool(TGraphMessageType &)>  InFunction ) const

inline

GetAncestor()

template<typename NodeType >

NodeType * FAnimationBaseContext::GetAncestor ( ) const

inline

GetAnimClass()

IAnimClassInterface * FAnimationBaseContext::GetAnimClass

(

)

const

GetAnimInstanceObject()

UObject * FAnimationBaseContext::GetAnimInstanceObject

(

)

const

GetCurrentNodeId()

int32 FAnimationBaseContext::GetCurrentNodeId ( ) const

inline

GetMessage()

template<typename TGraphMessageType >

TGraphMessageType * FAnimationBaseContext::GetMessage ( ) const

inline

GetMessageChecked()

template<typename TGraphMessageType >

TGraphMessageType & FAnimationBaseContext::GetMessageChecked ( ) const

inline

GetPreviousNodeId()

int32 FAnimationBaseContext::GetPreviousNodeId ( ) const

inline

IsActive()

bool FAnimationBaseContext::IsActive ( ) const

inline

LogMessageInternal()

void FAnimationBaseContext::LogMessageInternal ( FName  InLogType, const TSharedRef< FTokenizedMessage > &  InMessage  ) const

protected

Interface for node contexts to register log messages with the proxy

operator=() [1/2]

FAnimationBaseContext & FAnimationBaseContext::operator= ( const FAnimationBaseContext &  )

default

operator=() [2/2]

FAnimationBaseContext & FAnimationBaseContext::operator= ( FAnimationBaseContext &&  )

default

SetNodeId()

void FAnimationBaseContext::SetNodeId ( int32  InNodeId )

inline

SetNodeIds()

void FAnimationBaseContext::SetNodeIds ( const FAnimationBaseContext &  InContext )

inline

TrackAncestor()

template<typename NodeType >

FScopedAnimNodeTracker FAnimationBaseContext::TrackAncestor ( NodeType *  Node ) const

inline

Member Data Documentation

AnimInstanceProxy

FAnimInstanceProxy* FAnimationBaseContext::AnimInstanceProxy

bIsActive

bool FAnimationBaseContext::bIsActive = true

protected

CurrentNodeId

int32 FAnimationBaseContext::CurrentNodeId

protected

PreviousNodeId

int32 FAnimationBaseContext::PreviousNodeId

protected

SharedContext

FAnimationUpdateSharedContext* FAnimationBaseContext::SharedContext

---

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

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