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

Windows

MacOS

Linux

Inheritance Hierarchy

FAnimNode_Base

FAnimNode_CustomProperty

FAnimNode_ControlRigBase

	FAnimNode_ControlRig
	FAnimNode_ControlRig_ExternalSource

References

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

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
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
TMap< FName, ui...	ControlRigBoneMapping	Rig Hierarchy bone name to required array index mapping
TMap< FName, ui...	ControlRigCurveMapping	Rig Curve name to Curve LUI mapping
FControlRigIOSe...	InputSettings
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
void	ExecuteControlRig ( FPoseContext& InOutput )	Execute control rig on the input pose and outputs the result
UControlRig ...	GetControlRig()	Return Control Rig of current object
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 insufficent or inefficent 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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss