Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FAnimNode_ControlRigBase

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FAnimNode_Base

FAnimNode_CustomProperty

FAnimNode_ControlRigBase

	FAnimNode_ControlRig
	FAnimNode_ControlRig_ExternalSource

References

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

Syntax

USTRUCT()
struct FAnimNode_ControlRigBase : public FAnimNode_CustomProperty

Remarks

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

Variables

	Name	Description
bool	bExecute
bool	bResetInputPoseToInitial	If this is checked the rig's pose needs to be reset to its initial prior to evaluating the rig.
bool	bTransferInputCurves	If this is checked the curves coming from the AnimBP will be transferred into the Control Rig.
bool	bTransferInputPose	If this is checked the bone pose coming from the AnimBP will be transferred into the Control Rig.
bool	bTransferPoseInGlobalSpace	Transferring the pose in global space guarantees a global pose match, while transferring in local space ensures a match of the local transforms.
TArray< TPair< ...	ControlRigBoneInputMappingByIndex	Complete mapping from skeleton to control rig bone index
TMap< FName, ui...	ControlRigBoneInputMappingByName	Rig Hierarchy bone name to required array index mapping
TArray< TPair< ...	ControlRigBoneOutputMappingByIndex
TMap< FName, ui...	ControlRigBoneOutputMappingByName
TArray< TPair< ...	ControlRigCurveMappingByIndex	Complete mapping from skeleton to curve index
TMap< FName, ui...	ControlRigCurveMappingByName	Rig Curve name to Curve LUI mapping
TArray< FBoneRe...	InputBonesToTransfer	An inclusive list of bones to transfer as part of the input pose transfer phase.
FControlRigIOSe...	InputSettings
TMap< FName, in...	InputToControlIndex
TMap< FName, ui...	InputToCurveMappingUIDs
float	InternalBlendAlpha	The below is alpha value support for control rig.
TWeakObjectPtr<...	NodeMappingContainer	Node Mapping Container
FControlRigIOSe...	OutputSettings
FPoseLink	Source

Constructors

	Name	Description
	FAnimNode_ControlRigBase()

Functions

	Name	Description
bool	CanExecute()
void	ExecuteControlRig ( FPoseContext& InOutput )	Execute control rig on the input pose and outputs the result
UControlRig ...	GetControlRig()	Return Control Rig of current object
void	QueueControlRigDrawInstructions ( UControlRig* ControlRig, FAnimInstanceProxy* Proxy )
void	UpdateInput ( UControlRig* ControlRig, const FPoseContext& InOutput )	Update input/output to control rig
void	UpdateOutput ( UControlRig* ControlRig, FPoseContext& InOutput )

Overridden from FAnimNode_CustomProperty

		Name	Description
	UClass *	GetTargetClass()	Get Target Class

Overridden from FAnimNode_Base

	Name	Description
void	CacheBones_AnyThread ( const FAnimationCacheBonesContext&... )	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.
void	Initialize_AnyThread ( const FAnimationInitializeContext&... )	Called when the node first runs.
bool	NeedsOnInitializeAnimInstance()	For nodes that need some kind of initialization that is not dependent on node relevancy (i.e. it is insufficient or inefficient to use Initialize_AnyThread), return true here.
void	OnInitializeAnimInstance ( const FAnimInstanceProxy* InPr..., const UAnimInstance* InAnimIns... )	Called once, from game thread as the parent anim instance is created
void	Update_AnyThread ( const FAnimationUpdateContext& Con... )	Called to update the state of the graph relative to this node.