1. Epic GamesDeveloper
  3. UControlRigComponent

UControlRigComponent

A component that hosts an animation ControlRig, manages control components and marshals data between the two

API > API/Plugins > API/Plugins/ControlRig

A component that hosts an animation ControlRig, manages control components and marshals data between the two

   
Name UControlRigComponent
Type class
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/ControlRigComponent.h
Include Path #include "ControlRigComponent.h"

Syntax

UCLASS (MinimalAPI, Blueprintable, ClassGroup="Animation", Meta=(BlueprintSpawnableComponent))  
class UControlRigComponent : public UPrimitiveComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UControlRigComponent ( const FObjectInitializer& ObjectInitializer
)

   ControlRigComponent.h  

Classes

Name Remarks
FControlRigComponentEvent  

Structs

Name Remarks
FCachedSkeletalMeshComponentSettings  

Constants

Name Type Remarks Include Path
EditorNotifications TMap< FString, TSharedPtr< SNotificationItem > >   ControlRigComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDrawBones bool When checked the rig's bones are drawn using debug drawing similar to the animation editor viewport ControlRigComponent.h
  • EditAnywhere
  • Category="Rendering"
bEnableLazyEvaluation bool When checked the rig will only run if any of the mapped inputs has changed ControlRigComponent.h
  • EditAnywhere
  • Category="Lazy Evaluation"
bResetInitialsBeforeConstruction bool When checked the initial transforms on bones, nulls and controls are reset prior to a construction event ControlRigComponent.h
  • EditAnywhere
  • Category="Animation"
bResetTransformBeforeTick bool When checked the transforms are reset before a tick / update of the rig ControlRigComponent.h
  • EditAnywhere
  • Category="Animation"
bShowDebugDrawing bool When checked the rig's debug drawing instructions are drawn in the viewport ControlRigComponent.h
  • EditAnywhere
  • Category="Rendering"
bUpdateInEditor bool When checked the rig is run in the editor viewport without running / simulation the game ControlRigComponent.h
  • EditAnywhere
  • Category="Animation"
bUpdateRigOnTick bool When checked this ensures to run the rig's update on the component's tick automatically ControlRigComponent.h
  • EditAnywhere
  • Category="Animation"
ControlRigClass TSubclassOf< UControlRig > The class of control rig to instantiate ControlRigComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=ControlRig
  • Meta=(DisallowCreateNew)
  • BlueprintSetter=SetControlRigClass
LazyEvaluationPositionThreshold float The delta threshold for a translation / position difference. 0.0 disables position differences. ControlRigComponent.h
  • EditAnywhere
  • Category="Lazy Evaluation"
  • Meta=(DisplayName="Position Threshold")
LazyEvaluationRotationThreshold float The delta threshold for a rotation difference (in degrees). 0.0 disables rotation differences. ControlRigComponent.h
  • EditAnywhere
  • Category="Lazy Evaluation"
  • Meta=(DisplayName="Rotation Threshold")
LazyEvaluationScaleThreshold float The delta threshold for a scale difference. 0.0 disables scale differences. ControlRigComponent.h
  • EditAnywhere
  • Category="Lazy Evaluation"
  • Meta=(DisplayName="Scale Threshold")
MappedElements TArray< FControlRigComponentMappedElement >   ControlRigComponent.h
  • VisibleAnywhere
  • Category="Animation"
OnPostConstructionDelegate FControlRigComponentDelegate Event fired after this component's ControlRig is setup ControlRigComponent.h
  • BlueprintAssignable
  • Category="ControlRig"
  • Meta=(DisplayName="On Post Construction")
OnPostForwardsSolveDelegate FControlRigComponentDelegate Event fired after this component's ControlRig's forwards solve ControlRigComponent.h
  • BlueprintAssignable
  • Category="ControlRig"
  • Meta=(DisplayName="On Post Forwards Solve")
OnPostInitializeDelegate FControlRigComponentDelegate Event fired after this component's ControlRig is initialized ControlRigComponent.h
  • BlueprintAssignable
  • Category="ControlRig"
  • Meta=(DisplayName="On Post Initialize")
OnPreConstructionDelegate FControlRigComponentDelegate Event fired before this component's ControlRig is setup ControlRigComponent.h
  • BlueprintAssignable
  • Category="ControlRig"
  • Meta=(DisplayName="On Pre Construction")
OnPreForwardsSolveDelegate FControlRigComponentDelegate Event fired before this component's ControlRig's forwards solve ControlRigComponent.h
  • BlueprintAssignable
  • Category="ControlRig"
  • Meta=(DisplayName="On Pre Forwards Solve")
OnPreInitializeDelegate FControlRigComponentDelegate Event fired just before this component's ControlRig is initialized ControlRigComponent.h
  • BlueprintAssignable
  • Category="ControlRig"
  • Meta=(DisplayName="On Pre Initialize")
UserDefinedElements TArray< FControlRigComponentMappedElement >   ControlRigComponent.h
  • EditAnywhere
  • Category="Animation"

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsInsideInitializeBracket bool   ControlRigComponent.h  
bNeedsEvaluation bool   ControlRigComponent.h  
bNeedToInitialize bool   ControlRigComponent.h  
CachedSkeletalMeshComponentSettings TMap< USkeletalMeshComponent *, FCachedSkeletalMeshComponentSettings >   ControlRigComponent.h  
ControlRig TObjectPtr< UControlRig >   ControlRigComponent.h
  • Transient
ControlRigCreatedEvent FControlRigComponentEvent   ControlRigComponent.h  
InputElementIndices TArray< int32 >   ControlRigComponent.h  
InputTransforms TArray< FTransform >   ControlRigComponent.h  
LastInputTransforms TArray< FTransform >   ControlRigComponent.h  
ObjectBinding TSharedPtr< IControlRigObjectBinding >   ControlRigComponent.h  
TempAttributeContainer UE::Anim::FMeshAttributeContainer   ControlRigComponent.h  
TickDependencyErrorMessages TSet< FString >   ControlRigComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMappedCompleteSkeletalMesh ( USkeletalMeshComponent* SkeletalMeshComponent,
const EControlRigComponentMapDirection InDirection
)

 Adds all matching bones to the rig, should not be used before OnPreInitialize Event ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"
  • Meta=(DisplayName="Add Mapped Skeletal Mesh", UnsafeDuringActorConstruction="true")

void AddMappedComponents ( TArray< FControlRigComponentMappedComponent > Components
)

 Adds a series of mapped bones to the rig, should not be used before OnPreInitialize Event ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"
  • Meta=(UnsafeDuringActorConstruction="true")

void AddMappedElements ( TArray< FControlRigComponentMappedElement > NewMappedElements
)

 Adds the provided mapped elements to the component, should not be used before OnPreInitialize Event ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"
  • Meta=(UnsafeDuringActorConstruction="true")

void AddMappedSkeletalMesh ( USkeletalMeshComponent* SkeletalMeshComponent,
TArray< FControlRigComponentMappedBone > Bones,
TArray< FControlRigComponentMappedCurve > Curves,
const EControlRigComponentMapDirection InDirection
)

 Adds a series of mapped bones to the rig, should not be used before OnPreInitialize Event ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"
  • Meta=(DisplayName="Add Mapped Skeletal Mesh Bone Array", UnsafeDuringActorConstruction="true")

bool CanExecute()

 Returns true if the Component can execute its Control Rig ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

void ClearMappedElements()

 Removes all mapped elements from the component ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

bool DoesElementExist ( FName Name,
ERigElementType ElementType
)

 Returns true if an element given a type and name exists in the rig ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

float GetAbsoluteTime()

 Get the ControlRig's local time in seconds since its last initialize ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

FTransform GetBoneTransform ( FName BoneName,
EControlRigComponentSpace Space
)

 Returns the transform of the bone in the requested space ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

bool GetControlBool ( FName ControlName
)

 Returns the value of a bool control ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

float GetControlFloat ( FName ControlName
)

 Returns the value of a float control ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

int32 GetControlInt ( FName ControlName
)

 Returns the value of an integer control ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

FTransform GetControlOffset ( FName ControlName,
EControlRigComponentSpace Space
)

 Returns the offset transform of a control ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

FVector GetControlPosition ( FName ControlName,
EControlRigComponentSpace Space
)

 Returns the value of a position control ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

UControlRig * GetControlRig()

 Get the ControlRig hosted by this component ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

FRotator GetControlRotator ( FName ControlName,
EControlRigComponentSpace Space
)

 Returns the value of a rotator control ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

FVector GetControlScale ( FName ControlName,
EControlRigComponentSpace Space
)

 Returns the value of a scale control ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

FTransform GetControlTransform ( FName ControlName,
EControlRigComponentSpace Space
)

 Returns the value of a transform control ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

FVector2D GetControlVector2D ( FName ControlName
)

 Returns the value of a Vector3D control ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

TArray< FName > GetElementNames ( ERigElementType ElementType
)

 Returns all of the names for a given element type (Bone, Control, etc) ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

FTransform GetInitialBoneTransform ( FName BoneName,
EControlRigComponentSpace Space
)

 Returns the initial transform of the bone in the requested space ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

FTransform GetInitialSpaceTransform ( FName SpaceName,
EControlRigComponentSpace Space
)

 Returns the initial transform of the space in the requested space ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

FTransform GetSpaceTransform ( FName SpaceName,
EControlRigComponentSpace Space
)

 Returns the transform of the space in the requested space ControlRigComponent.h
  • BlueprintPure
  • Category="ControlRig"

void Initialize()

 Initializes the rig's memory and calls the construction event ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

FControlRigComponentEvent & OnControlRigCreated()

   ControlRigComponent.h  

void OnPostConstruction ( UControlRigComponent* Component
)

   ControlRigComponent.h
  • BlueprintNativeEvent
  • Category="ControlRig"
  • CallInEditor

void OnPostForwardsSolve ( UControlRigComponent* Component
)

   ControlRigComponent.h
  • BlueprintNativeEvent
  • Category="ControlRig"
  • CallInEditor
  • Meta=(DisplayName="On Post Forwards Solve")

void OnPostInitialize ( UControlRigComponent* Component
)

   ControlRigComponent.h
  • BlueprintNativeEvent
  • Category="ControlRig"
  • CallInEditor

void OnPreConstruction ( UControlRigComponent* Component
)

   ControlRigComponent.h
  • BlueprintNativeEvent
  • Category="ControlRig"
  • CallInEditor

void OnPreForwardsSolve ( UControlRigComponent* Component
)

   ControlRigComponent.h
  • BlueprintNativeEvent
  • Category="ControlRig"
  • CallInEditor
  • Meta=(DisplayName="On Pre Forwards Solve")

void OnPreInitialize ( UControlRigComponent* Component
)

   ControlRigComponent.h
  • BlueprintNativeEvent
  • Category="ControlRig"
  • CallInEditor

void SetBoneInitialTransformsFromSkeletalMesh ( USkeletalMesh* InSkeletalMesh
)

 Setup the initial transforms / ref pose of the bones based on a skeletal mesh ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"
  • Meta=(DisplayName="Set Bone Initial Transforms From Skeletal Mesh")

void SetBoneTransform ( FName BoneName,
FTransform Transform,
EControlRigComponentSpace Space,
float Weight,
bool bPropagateToChildren
)

 Sets the transform of the bone in the requested space ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetControlBool ( FName ControlName,
bool Value
)

 Sets the value of a bool control ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetControlFloat ( FName ControlName,
float Value
)

 Sets the value of a float control ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetControlInt ( FName ControlName,
int32 Value
)

 Sets the value of an integer control ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetControlOffset ( FName ControlName,
FTransform OffsetTransform,
EControlRigComponentSpace Space
)

 Sets the offset transform of a control ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetControlPosition ( FName ControlName,
FVector Value,
EControlRigComponentSpace Space
)

 Sets the value of a position control ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetControlRig ( UControlRig* ControlRig
)

   ControlRigComponent.h  

void SetControlRigClass ( TSubclassOf< UControlRig > InControlRigClass
)

   ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetControlRotator ( FName ControlName,
FRotator Value,
EControlRigComponentSpace Space
)

 Sets the value of a rotator control ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetControlScale ( FName ControlName,
FVector Value,
EControlRigComponentSpace Space
)

 Sets the value of a scale control ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetControlTransform ( FName ControlName,
FTransform Value,
EControlRigComponentSpace Space
)

 Sets the value of a transform control ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetControlVector2D ( FName ControlName,
FVector2D Value
)

 Sets the value of a vector2D control ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetInitialBoneTransform ( FName BoneName,
FTransform InitialTransform,
EControlRigComponentSpace Space,
bool bPropagateToChildren
)

 Sets the initial transform of the bone in the requested space ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetInitialSpaceTransform ( FName SpaceName,
FTransform InitialTransform,
EControlRigComponentSpace Space
)

 Sets the transform of the space in the requested space ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void SetMappedElements ( TArray< FControlRigComponentMappedElement > NewMappedElements
)

 Replaces the mapped elements on the component with the provided array, should not be used before OnPreInitialize Event ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"
  • Meta=(UnsafeDuringActorConstruction="true")

void SetObjectBinding ( UObject* InObjectToBind
)

   ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

void Update ( float DeltaTime
)

 Updates and ticks the rig. ControlRigComponent.h
  • BlueprintCallable
  • Category="ControlRig"

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   ControlRigComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   ControlRigComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnRegister()

   ControlRigComponent.h  

virtual void OnUnregister()

   ControlRigComponent.h  

virtual void TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   ControlRigComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   ControlRigComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   ControlRigComponent.h  

virtual void PostLoad()

   ControlRigComponent.h  

virtual void Serialize ( FArchive& Ar
)

   ControlRigComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool AllowsTickDependency ( const UObject* InDependent,
const UObject* InDependency,
FString* OutErrorMessage
)

   ControlRigComponent.h  

static FName GetComponentNameWithinActor ( UActorComponent* InComponent
)

   ControlRigComponent.h  

static bool HasTickDependency ( const UObject* InDependent,
const UObject* InDependency,
FString* OutErrorMessage
)

   ControlRigComponent.h  

static bool HasTickDependency_Impl ( const UObject* InDependent,
const UObject* InDependency,
TSet< const UObject* >& InOutVisited,
FString* OutErrorMessage
)

   ControlRigComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page