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

> Unreal Engine API Reference > Plugins > ControlRig > UControlRig

Light Theme

Dark Theme

UControlRig

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UControlRig

	UAdditiveControlRig
	UFKControlRig

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(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< UAssetU...	AssetUserData	Array of user data stored with the asset
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	PostSetupBracket
int32	PreSetupBracket
TArray< FRigCon...	QueuedModifiedControls
int32	UpdateBracket

Constructors

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

Functions

	Name	Description
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
const TArray...	AvailableControls()
const TArray...	AvailableSpaces()
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
void	ExecuteUnits ( FRigUnitContext& InOutContext, const FName& InEventName )	ExecuteUnits
FRigControl ...	FindControl ( const FName& InControlName )
FRigSpace &#...	FindSpace ( const FName& InSpaceName )
FRigBoneHier...	GetBoneHierarchy()
FText	GetCategory()	Get the category of this ControlRig (for display in menus)
FTransform	GetControlGlobalTransform ( const FName& InControlName )
FRigControlH...	GetControlHierarchy()
FTransform	GetControlLocalTransform ( const FName& InControlName )
void	GetControlsInOrder ( TArray< FRigControl >& SortedContr... )
const FRigCo...	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)
FRigCurveCon...	GetCurveContainer()
float	GetCurveValue ( const int32 CurveIndex )	Evaluate another animation ControlRig
float	GetCurveValue ( const FName& CurveName )	Evaluate another animation ControlRig
UAnimationDa...	GetDataSourceRegistry()	Data Source Registry Getter
const FContr...	GetDrawContainer()
FControlRigD...	GetDrawContainer()
const FContr...	GetDrawInterface()
FControlRigD...	GetDrawInterface()
const TArray...	GetEventQueue()	Returns the queue of events to run
FRigVMExtern...	GetExternalVariableFromDescription ( const FBPVariableDescription& InVa... )
FRigVMExtern...	GetExternalVariableFromPinType ( const FName& InName, const FEdGraphPinType& InPinType, bool bInPublic, bool bInReadonly )
TArray< FRig...	GetExternalVariables()	Returns the member properties as an external variable array
UControlRigG...	GetGizmoLibrary()
FTransform	GetGlobalTransform ( const FName& BoneName )	Evaluate another animation ControlRig
FTransform	GetGlobalTransform ( const int32 BoneIndex )	Evaluate another animation ControlRig
FRigHierarch...	GetHierarchy()
UControlRig ...	GetInteractionRig()
TSubclassOf<...	GetInteractionRigClass()
FString	GetName()
TSharedPtr< ...	GetObjectBinding()
FEdGraphPinT...	GetPinTypeFromExternalVariable ( const FRigVMExternalVariable& InEx... )
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 )
FTransform	GetSpaceGlobalTransform ( const FName& InSpaceName )
FRigSpaceHie...	GetSpaceHierarchy()
TArray< FNam...	GetSupportedEvents()
FText	GetToolTipText()	Get the tooltip text to display for this node (displayed in graphs and from context menus)
URigVM *	GetVM()
UWorld *	GetWorld()	UObject interface
void	Initialize ( bool bInitRigUnits )	Initialize things for the ControlRig
bool	IsControlSelected ( const FName& InControlName )
bool	IsCurveControl ( const FRigControl* InRigContro... )
bool	IsExecuting()
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.
FControlRigE...	OnExecuted_AnyThread()
FControlRigE...	OnInitialized_AnyThread()
FControlRigE...	OnPostSetup_AnyThread()
FControlRigE...	OnPreSetup_AnyThread()
FRigEventDel...	OnRigEvent_AnyThread()
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	SetBoneInitialTransformsFromRefSkeleton ( const FReferenceSkeleton& InRefere... )	Setup the initial transforms / ref pose of the bones based on a reference skeleton.
void	SetBoneInitialTransformsFromSkeletalMesh ( USkeletalMesh* InSkeletalMesh )	Setup the initial transforms / ref pose of the bones based on a skeletal mesh.
bool	SetControlGlobalTransform ( const FName& InControlName, const FTransform& InGlobalTransfor..., const FRigControlModifiedContext& ... )
void	SetControlLocalTransform ( const FName& InControlName, const FTransform& InLocalTransform, bool bNotify, const FRigControlModifiedContext& ... )
bool	SetControlSpace ( const FName& InControlName, const FName& InSpaceName )
void	SetControlValue ( const FName& InControlName, T InValue, bool bNotify, const FRigControlModifiedContext& ... )	Sets the relative value of a Control.
void	SetControlValueImpl ( const FName& InControlName, const FRigControlValue& InValue, bool bNotify, const FRigControlModifiedContext& ... )	Sets the relative value of a Control.
void	SetCurveValue ( const int32 CurveIndex, const float CurveValue )	Evaluate another animation ControlRig
void	SetCurveValue ( const FName& CurveName, const float CurveValue )	Evaluate another animation ControlRig
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	SetGlobalTransform ( const int32 BoneIndex, const FTransform& InTransform, bool bPropagateTransform )	Evaluate another animation ControlRig
void	SetGlobalTransform ( const FName& BoneName, const FTransform& InTransform, bool bPropagateTransform )	Evaluate another animation ControlRig
void	SetInteractionRig ( UControlRig* InInteractionRig )
void	SetInteractionRigClass ( TSubclassOf< UControlRig > InIntera... )
void	SetInteractOff()	Turn Off Interact, MUST Have Called SetInteractOn
void	SetInteractOn()	Turn On Interact, MUST Call SetInteractOff
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 )
bool	SetSpaceGlobalTransform ( const FName& InSpaceName, const FTransform& InTransform )
FTransform	SetupControlFromGlobalTransform ( const FName& InControlName, const FTransform& InGlobalTransfor... )
bool	ShouldApplyLimits()
bool	SupportsEvent()
bool	SupportsEvent ( const FName& InEventName )

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	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

Constants

Name	Description
OwnerComponent

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

Take our survey

Dismiss