1. Epic GamesDeveloper
  3. UControlRig

UControlRig

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

Unreal Engine C++ API Reference > Plugins > ControlRig

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Blueprintable, Abstract, EditInlineNew&41;  
class UControlRig :  
    public URigVMHost,  
    public INodeMappingProviderInterface

Remarks

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

Variables

  Type Name Description
Protected variable bool bCopyHierarchyBeforeConstruction  
Protected variable bool bInteractionJustBegan  
Public variable bool bIsClearingTransientControls  
Protected variable bool bManipulationEnabled  
Public variable bool bRecordSelectionPoseForConstructionMode  
Protected variable bool bResetInitialTransformsBeforeConstruction  
Protected variable TArray< TObjectPtr< UAssetUserData > > CombinedAssetUserData  
Protected variable UProperty TMap< FRigElementKey, FRigControlElementCustomization > ControlCustomizations  
Protected variable int32 ControlUndoBracketIndex  
Protected variable UProperty TObjectPtr< URigHierarchy > DynamicHierarchy  
Protected variable TArray< FRigElementKey > ElementsBeingInteracted  
Public variable UProperty Transient ERigExecutionType ExecutionType  
Public variable UProperty FRigHierarchySettings HierarchySettings  
Protected variable int32 InteractionBracket  
Protected variable uint8 InteractionType  
Protected variable int32 InterRigSyncBracket  
Protected variable TSharedPtr< IControlRigObjectBinding > ObjectBinding Runtime object binding
Protected variable FControlModifiedEvent OnControlModified  
Protected variable FControlRigBoundEvent OnControlRigBound  
Protected variable FControlSelectedEvent OnControlSelected  
Protected variable UProperty Category, Meta BlueprintAssignable FOnControlSelectedBP OnControlSelected_BP  
Protected variable FControlUndoBracketEvent OnControlUndoBracket  
Protected variable FFilterControlEvent OnFilterControl  
Protected variable TWeakObjectPtr< USceneComponent > OuterSceneComponent  
Protected variable int32 PostConstructionBracket  
Protected variable int32 PostForwardsSolveBracket  
Protected variable int32 PreConstructionBracket  
Protected variable int32 PreForwardsSolveBracket  
Protected variable TArray< FRigElementKey > QueuedModifiedControls  
Public variable TMap< FRigElementKey, FTransform > SelectionPoseForConstructionMode  
Protected variable UProperty TArray< TSoftObjectPtr< UControlRigShapeLibrary > > ShapeLibraries  
Protected variable UProperty Transient TMap< FString, FString > ShapeLibraryNameMap  

Constructors

  Type Name Description
Public function  

UControlRig ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Public function void  
Public function Virtual Const TArray< FRigControlElement * >  
Public function Virtual UFunction BlueprintCallable, Category bool  
Public function FFilterControlEvent & Returns a event that can be used to subscribe to filtering control data when needed
Public function FControlModifiedEvent & Returns a event that can be used to subscribe to change notifications coming from the manipulated subject.
Public function FControlRigBoundEvent &  
Public function FControlSelectedEvent & Returns a event that can be used to subscribe to selection changes coming from the manipulated subject.
Public function FControlUndoBracketEvent & Returns an event that can be used to subscribe to Undo Bracket requests such as Open and Close.
Public function Virtual void  
Public function Const UFunction BlueprintCallable, Category UTransformableControlHandle *

CreateTransformableControlHandle ( UObject* Outer,
const FName& ControlName
)

 Creates a transformable control handle for the specified control to be used by the constraints system.
Public function Virtual Const UFunction BlueprintPure, Category TArray< FName >  
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function Virtual Const FRigControlElement *

FindControl ( const FName& InControlName
)

  
Public function Static UFunction BlueprintCallable, Category TArray< UControlRig * >

FindControlRigs ( UObject* Outer,
TSubclassOf< UControlRig > OptionalClass
)

  
Public function CURRENT_FILE_ID__LINE__DELEGATE

FUNC_DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FOnControlSelectedBP_MCSignature,
FOnControlSelectedBP_DelegateWrapper,
FUNC_CONCAT(FUNC_CONCAT(UControlRig*InParam1, const FRigControlElement&InParam2, bool InParam3...,
FUNC_CONCAT(FUNC_CONCAT(*this, InParam1, InParam2, InParam3)),
void,
UControlRig*,
const FRigControlElement&,
bool
)

 To support Blueprints/scripting, we need a different delegate type (a 'Dynamic' delegate) which supports looser style UFunction binding (using names).
Public function Virtual Const FText Get the category of this ControlRig (for display in menus)
Public function Const const FRigControlElementCustomization *  
Public function Virtual Const FTransform

GetControlGlobalTransform ( const FName& InControlName
)

  
Public function Virtual FTransform

GetControlLocalTransform ( const FName& InControlName
)

  
Public function Virtual Const void

GetControlsInOrder ( TArray< FRigControlElement* >& SortedControls
)

  
Public function Const bool  
Public function FRigControlValue

GetControlValue ( const FName& InControlName
)

 Returns the value of a Control.
Public function Virtual FRigControlValue

GetControlValueFromGlobalTransform ( const FName& InControlName,
const FTransform& InGlobalTransform,
ERigTransformType::Type InTransformType
)

  
Public function UAnimationDataSourceRegistry * Data Source Registry Getter
Public function Const float  
Public function UFunction BlueprintPure, Category URigHierarchy *  
Public function Const URigHierarchy *  
Public function Const UFunction BlueprintPure, Category AActor * Find the actor the rig is bound to, if any
Public function Const UFunction blueprintgetter UControlRig *  
Public function Const UFunction blueprintgetter TSubclassOf< UControlRig >  
Protected function Const uint8  
Public function Const TSharedPtr< IControlRigObjectBinding >  
Public function Virtual Const const TArray< TSoftObjectPtr< UControlRigShapeLibrary > > &  
Public function Virtual Const FText Get the tooltip text to display for this node (displayed in graphs and from context menus)
Public function Virtual Const bool  
Public function Const bool  
Public function Virtual Const UFunction BlueprintPure, Category bool

IsControlSelected ( const FName& InControlName
)

  
Public function Const bool

IsCurveControl ( const FRigControlElement* InControlElement
)

  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Public function Virtual Const bool Returns true if this manipulatable subject is currently available for manipulation / is enabled.
Protected function void

OnHierarchyTransformUndoRedo ( URigHierarchy* InHierarchy,
const FRigElementKey& InKey,
ERigTransformType::Type InTransformType,
const FTransform& InTransform,
bool bIsUndo
)

  
Protected function Static void

OnHierarchyTransformUndoRedoWeak ( URigHierarchy* InHierarchy,
const FRigElementKey& InKey,
ERigTransformType::Type InTransformType,
const FTransform& InTransform,
bool bIsUndo,
TWeakObjectPtr< UControlRig > WeakThis
)

  
Public function FControlRigExecuteEvent &  
Public function FControlRigExecuteEvent &  
Public function FControlRigExecuteEvent &  
Public function FControlRigExecuteEvent &  
Public function FControlRigExecuteEvent &  
Public function FRigEventDelegate &  
Public function void Called after post reinstance when compilng blueprint by Sequencer
Public function UFunction BlueprintCallable, Category void Requests to perform construction during the next execution
Public function Virtual UFunction BlueprintCallable, Category void

SelectControl ( const FName& InControlName,
bool bSelect
)

  
Public function Virtual void Setup the initial transform / ref pose of the bones based upon an anim instance This uses the current refpose instead of the RefSkeleton pose.
Public function Virtual void 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.
Public function Virtual void Setup the initial transforms / ref pose of the bones based on a reference skeleton This uses the RefSkeleton pose instead of the current refpose.
Public function Virtual void Setup the initial transforms / ref pose of the bones based on a skeletal mesh This uses the RefSkeleton pose instead of the current refpose.
Public function Virtual void 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)
Public function void

SetControlCustomization ( const FRigElementKey& InControl,
const FRigControlElementCustomization& InCustomization
)

  
Public function bool

SetControlGlobalTransform ( const FName& InControlName,
const FTransform& InGlobalTransform,
bool bNotify,
const FRigControlModifiedContext& Context,
bool bSetupUndo,
bool bPrintPythonCommands,
bool bFixEulerFlips
)

  
Public function Virtual void

SetControlLocalTransform ( const FName& InControlName,
const FTransform& InLocalTransform,
bool bNotify,
const FRigControlModifiedContext& Context,
bool bSetupUndo,
bool bFixEulerFlips
)

  
Public function void

SetControlsVisible ( const bool bIsVisible
)

  
Public function void

SetControlValue ( const FName& InControlName,
T InValue,
bool bNotify,
const FRigControlModifiedContext& Context,
bool bSetupUndo,
bool bPrintPythonCommnds,
bool bFixEulerFlips
)

 Sets the relative value of a Control.
Public function Virtual void

SetControlValueImpl ( const FName& InControlName,
const FRigControlValue& InValue,
bool bNotify,
const FRigControlModifiedContext& Context,
bool bSetupUndo,
bool bPrintPythonCommnds,
bool bFixEulerFlips
)

 Sets the relative value of a Control.
Public function UFunction blueprintsetter void

SetInteractionRig ( UControlRig* InInteractionRig
)

  
Public function UFunction blueprintsetter void

SetInteractionRigClass ( TSubclassOf< UControlRig > InInteractionRigClass
)

  
Public function Virtual bool

SetManipulationEnabled ( bool Enabled
)

 Sets the manipulatable subject to enabled or disabled.
Public function void Setup bindings to a runtime object (or clear by passing in nullptr).
Public function Virtual FTransform

SetupControlFromGlobalTransform ( const FName& InControlName,
const FTransform& InGlobalTransform
)

  
Public function Virtual Const bool  
Public function void  

Overridden from URigVMHost

  Type Name Description
Public function Virtual void

AdaptEventQueueForEvaluate ( TArray< FName >& InOutEventQueueToRun
)

 Provides the chance to a subclass to modify the event queue as needed
Public function Virtual bool

Execute ( const FName& InEventName
)

 Execute
Public function Virtual bool

Execute_Internal ( const FName& InEventName
)

 ExecuteUnits
Public function Virtual USceneComponent *  
Public function Virtual Const UScriptStruct * Returns the public context script struct to use for this owner
Public function Virtual Const UWorld * UObject interface
Public function Virtual void

Initialize ( bool bInitRigUnits
)

 Initialize things for the ControlRig
Public function Virtual bool

InitializeVM ( const FName& InEventName
)

 Initialize the VM
Protected function Virtual void  
Public function Virtual void  
Public function Virtual void Requests to perform an init during the next execution

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_AssetUserData

  Type Name Description
Public function Virtual Const const TArray< UAssetUserData * > *  

Overridden from INodeMappingProviderInterface

  Type Name Description
Public function Virtual Const void

GetMappableNodeData ( TArray< FName >& OutNames,
TArray< FNodeItem >& OutNodeItems
)

 INodeMappingInterface implementation

Classes

  Type Name Description
Public class FAnimAttributeContainerPtrScope    
Public class FControlModifiedEvent Bindable event for external objects to be notified of Control changes  
Public class FControlRigBoundEvent Bindable event to notify object binding change.  
Public class FControlRigExecuteEvent    
Public class FControlSelectedEvent Bindable event for external objects to be notified that a Control is Selected  
Public class FControlUndoBracketEvent Bindable event to manage undo / redo brackets in the client  
Public class FFilterControlEvent Bindable event for external objects to contribute to / filter a control value  
Public struct FOnControlSelectedBP    
Public class FTransientControlPoseScope Class used to temporarily cache current pose of transient controls restore them after a ResetPoseToInitial call, which allows user to move bones in construction mode  

Constants

Name Description
OwnerComponent  

Deprecated Variables

  Type Name Description
Protected variable UProperty TSoftObjectPtr< UControlRigShapeLibrary > GizmoLibrary_DEPRECATED  
Protected variable UProperty TMap< FName, FCachedPropertyPath > InputProperties_DEPRECATED You either go Input or Output, currently if you put it in both place, Output will override
Protected variable UProperty TMap< FName, FCachedPropertyPath > OutputProperties_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page