FAnimNode_MirrorBase Struct Reference

#include <AnimNode_Mirror.h>

Inheritance diagram for FAnimNode_MirrorBase:

Public Member Functions
ANIMGRAPHRUNTIME_API	FAnimNode_MirrorBase ()
ANIMGRAPHRUNTIME_API	FAnimNode_MirrorBase (const FAnimNode_MirrorBase &)
ANIMGRAPHRUNTIME_API	~FAnimNode_MirrorBase ()
virtual ANIMGRAPHRUNTIME_API void	Initialize_AnyThread (const FAnimationInitializeContext &Context) override
virtual ANIMGRAPHRUNTIME_API void	CacheBones_AnyThread (const FAnimationCacheBonesContext &Context) override
virtual ANIMGRAPHRUNTIME_API void	Update_AnyThread (const FAnimationUpdateContext &Context) override
virtual ANIMGRAPHRUNTIME_API void	Evaluate_AnyThread (FPoseContext &Output) override
virtual ANIMGRAPHRUNTIME_API void	GatherDebugData (FNodeDebugData &DebugData) override
virtual ANIMGRAPHRUNTIME_API UMirrorDataTable *	GetMirrorDataTable () const
virtual ANIMGRAPHRUNTIME_API bool	SetMirrorDataTable (UMirrorDataTable *MirrorTable)
virtual ANIMGRAPHRUNTIME_API bool	GetMirror () const
virtual ANIMGRAPHRUNTIME_API float	GetBlendTimeOnMirrorStateChange () const
virtual ANIMGRAPHRUNTIME_API bool	GetBoneMirroring () const
virtual ANIMGRAPHRUNTIME_API bool	GetCurveMirroring () const
virtual ANIMGRAPHRUNTIME_API bool	GetAttributeMirroring () const
virtual ANIMGRAPHRUNTIME_API bool	GetResetChildOnMirrorStateChange () const
virtual ANIMGRAPHRUNTIME_API bool	SetMirror (bool bInMirror)
virtual ANIMGRAPHRUNTIME_API bool	SetBlendTimeOnMirrorStateChange (float InBlendTime)
virtual ANIMGRAPHRUNTIME_API bool	SetBoneMirroring (bool bInBoneMirroring)
virtual ANIMGRAPHRUNTIME_API bool	SetCurveMirroring (bool bInCurveMirroring)
virtual ANIMGRAPHRUNTIME_API bool	SetAttributeMirroring (bool bInAttributeMirroring)
virtual ANIMGRAPHRUNTIME_API bool	SetResetChildOnMirrorStateChange (bool bInResetChildOnMirrorStateChange)
virtual ANIMGRAPHRUNTIME_API void	SetSourceLinkNode (FAnimNode_Base *NewLinkNode)
virtual ANIMGRAPHRUNTIME_API FAnimNode_Base *	GetSourceLinkNode ()
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

Protected Attributes
FPoseLink	Source

Additional Inherited Members
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)

Constructor & Destructor Documentation

FAnimNode_MirrorBase() [1/2]

FAnimNode_MirrorBase::FAnimNode_MirrorBase

(

)

FAnimNode_MirrorBase() [2/2]

FAnimNode_MirrorBase::FAnimNode_MirrorBase ( const FAnimNode_MirrorBase &  )

default

~FAnimNode_MirrorBase()

FAnimNode_MirrorBase::~FAnimNode_MirrorBase ( )

default

Member Function Documentation

CacheBones_AnyThread()

void FAnimNode_MirrorBase::CacheBones_AnyThread ( const FAnimationCacheBonesContext &  Context )

overridevirtual

Called to cache any bones that this node needs to track (e.g. in a FBoneReference). This is usually called at startup when LOD switches occur. This can be called on any thread.

Parameters

Context

Context structure providing access to relevant data

Reimplemented from FAnimNode_Base.

Evaluate_AnyThread()

void FAnimNode_MirrorBase::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

Output

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

Reimplemented from FAnimNode_Base.

GatherDebugData()

void FAnimNode_MirrorBase::GatherDebugData ( FNodeDebugData &  DebugData )

overridevirtual

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

Parameters

DebugData

Debug data structure used to output any relevant data

Reimplemented from FAnimNode_Base.

GetAttributeMirroring()

bool FAnimNode_MirrorBase::GetAttributeMirroring ( ) const

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

GetBlendTimeOnMirrorStateChange()

float FAnimNode_MirrorBase::GetBlendTimeOnMirrorStateChange ( ) const

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

GetBoneMirroring()

bool FAnimNode_MirrorBase::GetBoneMirroring ( ) const

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

GetCurveMirroring()

bool FAnimNode_MirrorBase::GetCurveMirroring ( ) const

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

GetMirror()

bool FAnimNode_MirrorBase::GetMirror ( ) const

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

GetMirrorDataTable()

UMirrorDataTable * FAnimNode_MirrorBase::GetMirrorDataTable ( ) const

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

GetResetChildOnMirrorStateChange()

bool FAnimNode_MirrorBase::GetResetChildOnMirrorStateChange ( ) const

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

GetSourceLinkNode()

FAnimNode_Base * FAnimNode_MirrorBase::GetSourceLinkNode ( )

virtual

This only used by custom handlers, and it is advanced feature.

Initialize_AnyThread()

void FAnimNode_MirrorBase::Initialize_AnyThread ( const FAnimationInitializeContext &  Context )

overridevirtual

Called when the node first runs. If the node is inside a state machine or cached pose branch then this can be called multiple times. This can be called on any thread.

Parameters

Context

Context structure providing access to relevant data

Reimplemented from FAnimNode_Base.

SetAttributeMirroring()

bool FAnimNode_MirrorBase::SetAttributeMirroring ( bool  bInAttributeMirroring )

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

SetBlendTimeOnMirrorStateChange()

bool FAnimNode_MirrorBase::SetBlendTimeOnMirrorStateChange ( float  InBlendTime )

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

SetBoneMirroring()

bool FAnimNode_MirrorBase::SetBoneMirroring ( bool  bInBoneMirroring )

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

SetCurveMirroring()

bool FAnimNode_MirrorBase::SetCurveMirroring ( bool  bInCurveMirroring )

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

SetMirror()

bool FAnimNode_MirrorBase::SetMirror ( bool  bInMirror )

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

SetMirrorDataTable()

bool FAnimNode_MirrorBase::SetMirrorDataTable ( UMirrorDataTable *  MirrorTable )

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

SetResetChildOnMirrorStateChange()

bool FAnimNode_MirrorBase::SetResetChildOnMirrorStateChange ( bool  bInResetChildOnMirrorStateChange )

virtual

Reimplemented in FAnimNode_Mirror, and FAnimNode_Mirror_Standalone.

SetSourceLinkNode()

void FAnimNode_MirrorBase::SetSourceLinkNode ( FAnimNode_Base *  NewLinkNode )

virtual

This only used by custom handlers, and it is advanced feature.

Update_AnyThread()

void FAnimNode_MirrorBase::Update_AnyThread ( const FAnimationUpdateContext &  Context )

overridevirtual

Called to update the state of the graph relative to this node. Generally this should configure any weights (etc.) that could affect the poses that will need to be evaluated. This function is what usually executes EvaluateGraphExposedInputs. This can be called on any thread.

Parameters

Context

Context structure providing access to relevant data

Reimplemented from FAnimNode_Base.

Member Data Documentation

Source

FPoseLink FAnimNode_MirrorBase::Source

protected

---

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

• Engine/Source/Runtime/AnimGraphRuntime/Public/AnimNodes/AnimNode_Mirror.h
• Engine/Source/Runtime/AnimGraphRuntime/Private/AnimNodes/AnimNode_Mirror.cpp