UControlRig

Runs logic for mapping input data to transforms (the "Rig")

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UControlRig

	UAdditiveControlRig
	UFKControlRig

References

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

Syntax

UCLASS(Blueprintable, Abstract, EditInlineNew)
class UControlRig :
    public UObject,
    public INodeMappingProviderInterface,
    public IInterface_AssetUserData

Remarks

Runs logic for mapping input data to transforms (the "Rig")

Variables

	Name	Description
TArray< TObject...	AssetUserData	Array of user data stored with the asset
bool	bCopyHierarchyBeforeSetup
bool	bManipulationEnabled
bool	bRequiresInitExecution
bool	bRequiresSetupEvent
bool	bResetInitialTransformsBeforeSetup
bool	bSetupModeEnabled
ERigExecutionTy...	ExecutionType
int32	InitBracket
int32	InteractionBracket
int32	InterRigSyncBracket
FControlModifie...	OnControlModified
FControlSelecte...	OnControlSelected
FFilterControlE...	OnFilterControl
TWeakObjectPtr<...	OuterSceneComponent
int32	PostForwardsSolveBracket
int32	PostSetupBracket
int32	PreForwardsSolveBracket
int32	PreSetupBracket
TArray< FRigEle...	QueuedModifiedControls
int32	UpdateBracket
FRigVMRuntimeSe...	VMRuntimeSettings

Constructors

	Name	Description
	UControlRig ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddBreakpoint ( int32 InstructionIndex, URigVMNode* InNode, uint16 InDepth )	Adds a breakpoint in the VM at the InstructionIndex for the Node
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	ApplyTransformOverrideForUserCreatedBones()
TArray< FRig...	AvailableControls()
void	BroadCastEndLoadPackage()	These are needed so that sequencer can have a chance to update its ControlRig instances after the package is fully end-loaded
bool	CanExecute()	Is valid for execution
bool	ClearControlSelection()
FFilterContr...	ControlFilter()	Returns a event that can be used to subscribe to filtering control data when needed
FControlModi...	ControlModified()	Returns a event that can be used to subscribe to change notifications coming from the manipulated subject.
FControlSele...	ControlSelected()	Returns a event that can be used to subscribe to selection changes coming from the manipulated subject.
void	CreateRigControlsForCurveContainer()
TArray< FNam...	CurrentControlSelection()
void	Evaluate_AnyThread()	Evaluate at Any Thread
void	Execute ( const EControlRigState State, const FName& InEventName )	Execute
bool	ExecuteBreakpointAction ( const ERigVMBreakpointAction Breakp... )	If the VM is halted at a breakpoint, it sets a breakpoint action so that it is applied on the next VM execution
void	ExecuteUnits ( FRigUnitContext& InOutContext, const FName& InEventName )	ExecuteUnits
FRigControlE...	FindControl ( const FName& InControlName )
TArray< UCon...	FindControlRigs ( UObject* Outer, TSubclassOf< UControlRig > Optional... )
float	GetAbsoluteTime()	Gets the current absolute time
FText	GetCategory()	Get the category of this ControlRig (for display in menus)
const FRigCo...	GetControlCustomization ( const FRigElementKey& InControl )
FTransform	GetControlGlobalTransform ( const FName& InControlName )
FTransform	GetControlLocalTransform ( const FName& InControlName )
void	GetControlsInOrder ( TArray< FRigControlElement* > ... )
FRigControlV...	GetControlValue ( const FName& InControlName )	Returns the value of a Control.
FRigControlV...	GetControlValueFromGlobalTransform ( const FName& InControlName, const FTransform& InGlobalTransfor... )
float	GetCurrentFramesPerSecond()	Returns the current frames per second (this may change over time)
UAnimationDa...	GetDataSourceRegistry()	Data Source Registry Getter
float	GetDebugBoneRadiusMultiplier()
FRigVMDebugI...	GetDebugInfo()
FControlRigD...	GetDrawContainer()
const FContr...	GetDrawContainer()
const FContr...	GetDrawInterface()
FControlRigD...	GetDrawInterface()
const TArray...	GetEventQueue()	Returns the queue of events to run
TArray< FRig...	GetExternalVariables()	Returns the member properties as an external variable array
URigHierarch...	GetHierarchy()
UControlRig ...	GetInteractionRig()
TSubclassOf<...	GetInteractionRigClass()
FString	GetName()
TSharedPtr< ...	GetObjectBinding()
FRigVMExtern...	GetPublicVariableByName ( const FName& InVariableName )	Returns a public variable given its name
TArray< FRig...	GetPublicVariables()	Returns the public member properties as an external variable array
T	GetPublicVariableValue ( const FName& InVariableName )
TArray< FNam...	GetScriptAccessibleVariables()	Returns the names of variables accessible in scripting
const TArray...	GetShapeLibraries()
URigVM *	GetSnapshotVM ( bool bCreateIfNeeded )	Creates the snapshot VM if required and returns it
TArray< FNam...	GetSupportedEvents()
FText	GetToolTipText()	Get the tooltip text to display for this node (displayed in graphs and from context menus)
FString	GetVariableAsString ( const FName& InVariableName )	Returns the value of a given variable as a string
FName	GetVariableType ( const FName& InVariableName )	Returns the type of a given variable
URigVM *	GetVM()
UWorld *	GetWorld()	UObject interface
void	Initialize ( bool bInitRigUnits )	Initialize things for the ControlRig
bool	IsControlSelected ( const FName& InControlName )
bool	IsCurveControl ( const FRigControlElement* InCo... )
bool	IsExecuting()
bool	IsInDebugMode()
bool	IsInitializing()
bool	IsInteracting()
bool	IsRunningPostSetup()
bool	IsRunningPreSetup()
bool	IsSetupModeEnabled()
bool	IsSyncingWithOtherRig()
bool	ManipulationEnabled()	Returns true if this manipulatable subject is currently available for manipulation / is enabled.
FOnEndLoadPa...	OnEndLoadPackage()
FControlRigE...	OnExecuted_AnyThread()
void	OnHierarchyTransformUndoRedo ( URigHierarchy* InHierarchy, const FRigElementKey& InKey, ERigTransformType::Type InTransform..., const FTransform& InTransform, bool bIsUndo )
void	OnHierarchyTransformUndoRedoWeak ( URigHierarchy* InHierarchy, const FRigElementKey& InKey, ERigTransformType::Type InTransform..., const FTransform& InTransform, bool bIsUndo, TWeakObjectPtr< UControlRig > WeakT... )
FControlRigE...	OnInitialized_AnyThread()
FControlRigE...	OnPostForwardsSolve_AnyThread()
FControlRigE...	OnPostSetup_AnyThread()
FControlRigE...	OnPreForwardsSolve_AnyThread()
FControlRigE...	OnPreSetup_AnyThread()
FRigEventDel...	OnRigEvent_AnyThread()
void	PostInitInstanceIfRequired()
void	PostReinstanceCallback ( const UControlRig* Old )	Called after post reinstance when compilng blueprint by Sequencer
void	RequestInit()	Requests to perform an init during the next execution
void	RequestSetup()	Requests to perform a setup during the next execution
void	SelectControl ( const FName& InControlName, bool bSelect )
void	SetAbsoluteAndDeltaTime ( float InAbsoluteTime, float InDeltaTime )	Set the current absolute and delta times
void	SetAbsoluteTime ( float InAbsoluteTime, bool InSetDeltaTimeZero )	Set the current absolute time
void	SetBoneInitialTransformsFromAnimInstance ( UAnimInstance* InAnimInstance )	Setup the initial transform / ref pose of the bones based upon an anim instance This uses the current refpose instead of the RefSkeleton pose.
void	SetBoneInitialTransformsFromAnimInstanceProxy ( const FAnimInstanceProxy* InAn... )	Setup the initial transform / ref pose of the bones based upon an anim instance proxy This uses the current refpose instead of the RefSkeleton pose.
void	SetBoneInitialTransformsFromRefSkeleton ( const FReferenceSkeleton& InRefere... )	Setup the initial transforms / ref pose of the bones based on a reference skeleton This uses the RefSkeleton pose instead of the current refpose.
void	SetBoneInitialTransformsFromSkeletalMesh ( USkeletalMesh* InSkeletalMesh )	Setup the initial transforms / ref pose of the bones based on a skeletal mesh This uses the RefSkeleton pose instead of the current refpose.
void	SetBoneInitialTransformsFromSkeletalMeshComponent ( USkeletalMeshComponent* InSkel..., bool bUseAnimInstance )	Setup the initial transform / ref pose of the bones based upon skeletal mesh component (ref skeleton) This uses the RefSkeleton pose instead of the current refpose (or vice versae is bUseAnimInstance == true)
void	SetControlCustomization ( const FRigElementKey& InControl, const FRigControlElementCustomizati... )
bool	SetControlGlobalTransform ( const FName& InControlName, const FTransform& InGlobalTransfor..., bool bNotify, const FRigControlModifiedContext& ..., bool bSetupUndo, bool bPrintPythonCommands )
void	SetControlLocalTransform ( const FName& InControlName, const FTransform& InLocalTransform, bool bNotify, const FRigControlModifiedContext& ..., bool bSetupUndo )
void	SetControlValue ( const FName& InControlName, T InValue, bool bNotify, const FRigControlModifiedContext& ..., bool bSetupUndo, bool bPrintPythonCommnds )	Sets the relative value of a Control.
void	SetControlValueImpl ( const FName& InControlName, const FRigControlValue& InValue, bool bNotify, const FRigControlModifiedContext& ..., bool bSetupUndo, bool bPrintPythonCommnds )	Sets the relative value of a Control.
void	SetDeltaTime ( float InDeltaTime )	Set the current delta time
void	SetEventQueue ( const TArray< FName >& InEventName... )	Sets the queue of events to run
void	SetFramesPerSecond ( float InFramesPerSecond )	Set the current fps
void	SetInteractionRig ( UControlRig* InInteractionRig )
void	SetInteractionRigClass ( TSubclassOf< UControlRig > InIntera... )
void	SetIsInDebugMode ( const bool bValue )
bool	SetManipulationEnabled ( bool Enabled )	Sets the manipulatable subject to enabled or disabled.
void	SetObjectBinding ( TSharedPtr< IControlRigObjectBindin... )	Setup bindings to a runtime object (or clear by passing in nullptr).
void	SetPublicVariableValue ( const FName& InVariableName, const T& InValue )
FTransform	SetupControlFromGlobalTransform ( const FName& InControlName, const FTransform& InGlobalTransfor... )
bool	SetVariableFromString ( const FName& InVariableName, const FString& InValue )	Returns the value of a given variable as a string
bool	ShouldApplyLimits()
bool	SupportsEvent()
bool	SupportsEvent ( const FName& InEventName )
void	UpdateVMSettings()	Update the settings such as array bound and log facilities

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from INodeMappingProviderInterface

		Name	Description
	void	GetMappableNodeData ( TArray< FName >& OutNames, TArray< FNodeItem >& OutNodeItems )	INodeMappingInterface implementation

Overridden from IInterface_AssetUserData

		Name	Description
	void	AddAssetUserData ( UAssetUserData* InUserData )
	const TArray...	GetAssetUserDataArray()
	UAssetUserDa...	GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUse... )
	void	RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUse... )

Classes

	Name	Description
	FControlModifiedEvent	Bindable event for external objects to be notified of Control changes
	FControlRigExecuteEvent
	FControlSelectedEvent	Bindable event for external objects to be notified that a Control is Selected
	FFilterControlEvent	Bindable event for external objects to contribute to / filter a control value
	FOnEndLoadPackage	Bindable event for external objects to be notified that a control rig is fully end-loaded
	FTransientControlPoseScope	Class used to temporarily cache current pose of transient controls restore them after a ResetPoseToInitial call, which allows user to move bones in setup mode

Constants

Name	Description
OwnerComponent