FAnimNode_ControlRig | Unreal Engine 5.2 Documentation

Inheritance Hierarchy


Module	ControlRig
Header	/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/AnimNode_ControlRig.h
Include	#include "AnimNode_ControlRig.h"

USTRUCT&40;&41;  
struct FAnimNode_ControlRig : public FAnimNode_ControlRigBase

Animation node that allows animation ControlRig output to be used in an animation graph

	Type	Name	Description
	TOptional< int32 >	RefPoseSetterHash	A hash to encode the pointer to anim instance, an.

	Type	Name	Description
		FAnimNode_ControlRig ()

	Type	Name	Description
		~FAnimNode_ControlRig ()

Type	Name	Description
FName	GetIOMapping ( bool bInput, const FName& SourceProperty )
void	PostSerialize ( const FArchive& Ar )
void	SetIOMapping ( bool bInput, const FName& SourceProperty, const FName& TargetCurve )
void	UpdateControlRigRefPoseIfNeeded ( const FAnimInstanceProxy* InProxy, bool bIncludePoseInHash )	Helper function to update the initial ref pose within the Control Rig if needed.

Type	Name	Description
UControlRig *	GetControlRig ()	Return Control Rig of current object
TSubclassOf< UControlRig >	GetControlRigClass ()
void	UpdateInput ( UControlRig* ControlRig, const FPoseContext& InOutput )	Update input/output to control rig
void	UpdateOutput ( UControlRig* InControlRig, FPoseContext& InOutput )

Type	Name	Description
UClass *	GetTargetClass ()	Get Target Class
void	InitializeProperties ( const UObject* InSourceInstance, UClass* InTargetClass )	Initialize property links from the source instance, in this case AnimInstance Compiler creates those properties during compile time
void	PropagateInputProperties ( const UObject* InSourceInstance )	Propagate the Source Instances' properties to Target Instance

Type	Name	Description
void	CacheBones_AnyThread ( const FAnimationCacheBonesContext& Context )	Called to cache any bones that this node needs to track (e.g. in a FBoneReference).
void	Evaluate_AnyThread ( FPoseContext& Output )	Called to evaluate local-space bones transforms according to the weights set up in Update().
void	GatherDebugData ( FNodeDebugData& DebugData )	Called to gather on-screen debug data. This is called on the game thread.
int32	GetLODThreshold ()	Get the LOD threshold at which this node is enabled.
void	Initialize_AnyThread ( const FAnimationInitializeContext& Context )	Called when the node first runs.
void	OnInitializeAnimInstance ( const FAnimInstanceProxy* InProxy, const UAnimInstance* InAnimInstance )	We only subscribe to the OnInitializeAnimInstance path because we need to cache our source object, so we only override these methods in editor at the moment
void	Update_AnyThread ( const FAnimationUpdateContext& Context )	Called to update the state of the graph relative to this node.