UControlRig

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

Windows
MacOS
Linux

Inheritance Hierarchy

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 IControlRigManipulatable

Remarks

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

Variables

Name Description

Public variable UProperty Transient

ERigExecutionTy...

 

ExecutionType

Constructors

Name Description

Public function

UControlRig()

Public function

UControlRig

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

void

 

AddReferencedObjects

(
    UObject* InThis,
    FReferenceCollector& Collector
)

Public function Virtual

void

 

Evaluate_AnyThread()

Evaluate at Any Thread

Public function

void

 

Execute

(
    const EControlRigState State
)

Execute

Public function Virtual

void

 

ExecuteUnits

(
    FRigUnitContext& InOutContext
)

ExecuteUnits

Public function

FRigBoneHier...

 

GetBoneHierarchy()

Public function Virtual Const

FText

 

GetCategory()

Get the category of this ControlRig (for display in menus)

Public function

FRigControlH...

 

GetControlHierarchy()

Public function

FRigCurveCon...

 

GetCurveContainer()

Public function Const

float

 

GetCurveValue

(
    const int32 CurveIndex
)

Evaluate another animation ControlRig

Public function Const

float

 

GetCurveValue

(
    const FName& CurveName
)

Evaluate another animation ControlRig

Public function

UAnimationDa...

 

GetDataSourceRegistry()

Data Source Registry Getter

Public function Const

FTransform

 

GetGlobalTransform

(
    const int32 BoneIndex
)

Evaluate another animation ControlRig

Public function Const

FTransform

 

GetGlobalTransform

(
    const FName& BoneName
)

Evaluate another animation ControlRig

Public function

FRigHierarch...

 

GetHierarchy()

Public function Const

const TArray...

 

GetParameters()

Input output handling

Public function

T

 

GetParameterValue

(
    const FName& InParameterName
)

Public function

FRigSpaceHie...

 

GetSpaceHierarchy()

Public function Virtual Const

FText

 

GetToolTipText()

Get the tooltip text to display for this node (displayed in graphs and from context menus)

Public function

URigVM *

 

GetVM()

Public function Virtual Const

UWorld *

 

GetWorld()

UObject interface

Public function Virtual

void

 

Initialize

(
    bool bInitRigUnits
)

Initialize things for the ControlRig

Public function Const

bool

 

IsCurveControl

(
    const FRigControl* InRigContro...
)

Not in IControlRigManipulatable *, but maybe should.

Public function

FControlRigE...

 

OnExecuted_AnyThread()

Public function

FControlRigE...

 

OnInitialized_AnyThread()

Public function

void

 

PostReinstanceCallback

(
    const UControlRig* Old
)

Called after post reinstance when compilng blueprint by Sequencer

Public function

void

 

RequestInit()

Requests to perform an init during the next execution

Public function

void

 

SetCurveValue

(
    const int32 CurveIndex,
    const float CurveValue
)

Evaluate another animation ControlRig

Public function

void

 

SetCurveValue

(
    const FName& CurveName,
    const float CurveValue
)

Evaluate another animation ControlRig

Public function

void

 

SetDeltaTime

(
    float InDeltaTime
)

Set the current delta time

Public function

void

 

SetGlobalTransform

(
    const int32 BoneIndex,
    const FTransform& InTransform,
    bool bPropagateTransform
)

Evaluate another animation ControlRig

Public function

void

 

SetGlobalTransform

(
    const FName& BoneName,
    const FTransform& InTransform,
    bool bPropagateTransform
)

Evaluate another animation ControlRig

Public function

void

 

SetParameterValue

(
    const FName& InParameterName,
    const T& InValue
)

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

PostEditUndo()

Called after applying a transaction to the object.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Overridden from INodeMappingProviderInterface

Name Description

Public function Virtual Const

void

 

GetMappableNodeData

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

INodeMappingInterface implementation

Overridden from IControlRigManipulatable

Name Description

Public function Virtual Const

const TArray...

 

AvailableControls()

Returns a list of available controls on the subject.

Public function Virtual Const

const TArray...

 

AvailableSpaces()

Returns a list of available spaces on the subject.

Public function Virtual

bool

 

ClearControlSelection()

Clear selection on all controls.

Public function Virtual

void

 

CreateRigControlsForCurveContainer()

Create RigControls for Curves, they will get added to the AvailableControls.

Public function Virtual Const

TArray< FNam...

 

CurrentControlSelection()

Get the current selection.

Public function Virtual

FRigControl ...

 

FindControl

(
    const FName& InControlName
)

Returns a control given its name.

Public function Virtual

FRigSpace &#...

 

FindSpace

(
    const FName& InSpaceName
)

Returns a space given its name.

Public function Virtual Const

FTransform

 

GetControlGlobalTransform

(
    const FName& InControlName
)

Returns the global / world transform of a Control.

Public function Virtual

FRigControlV...

 

GetControlValueFromGlobalTransform

(
    const FName& InControlName,
    const FTransform& InGlobalTransfor...
)

Returns the value given a global transform.

Public function Virtual Const

UControlRigG...

 

GetGizmoLibrary()

Returns the gizmo library used for generating gizmos.

Public function Virtual Const

FString

 

GetName()

Get OurName

Public function Virtual Const

TSharedPtr< ...

 

GetObjectBinding()

Get bindings to a runtime object

Public function Virtual

FTransform

 

GetSpaceGlobalTransform

(
    const FName& InSpaceName
)

Gets a space's transform given a global / world transform.

Public function Virtual Const

bool

 

IsControlSelected

(
    const FName& InControlName
)

Is the Specified Control Selected.

Public function Virtual

void

 

SelectControl

(
    const FName& InControlName,
    bool bSelect
)

Select or deselected the specified control.

Public function Virtual

bool

 

SetControlSpace

(
    const FName& InControlName,
    const FName& InSpaceName
)

Sets a Control's Space (for space switching), returns true when successful.

Public function Virtual

void

 

SetObjectBinding

(
    TSharedPtr< IControlRigObjectBindin...
)

Setup bindings to a runtime object (or clear by passing in nullptr).

Public function Virtual

bool

 

SetSpaceGlobalTransform

(
    const FName& InSpaceName,
    const FTransform& InTransform
)

Sets a space's transform given a global / world transform. Returns true when successful.

Classes

Name

Description

Public class

FControlRigExecuteEvent

Constants

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