1. Epic GamesDeveloper
  3. UControlRigComponent

UControlRigComponent

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

Unreal Engine C++ API Reference > Plugins > ControlRig

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Blueprintable, ClassGroup&61;"Animation", Meta&61;&40;BlueprintSpawnableComponent&41;&41;  
class UControlRigComponent : public UPrimitiveComponent

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bDrawBones When checked the rig's bones are drawn using debug drawing similar to the animation editor viewport
Public variable UProperty Category, EditAnywhere bool bEnableLazyEvaluation When checked the rig will only run if any of the mapped inputs has changed
Public variable UProperty Category, EditAnywhere bool bResetInitialsBeforeConstruction When checked the initial transforms on bones, nulls and controls are reset prior to a construction event
Public variable UProperty Category, EditAnywhere bool bResetTransformBeforeTick When checked the transforms are reset before a tick / update of the rig
Public variable UProperty Category, EditAnywhere bool bShowDebugDrawing When checked the rig's debug drawing instructions are drawn in the viewport
Public variable UProperty Category, EditAnywhere bool bUpdateInEditor When checked the rig is run in the editor viewport without running / simulation the game
Public variable UProperty Category, EditAnywhere bool bUpdateRigOnTick When checked this ensures to run the rig's update on the component's tick automatically
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter TSubclassOf< UControlRig > ControlRigClass The class of control rig to instantiate
Public variable UProperty Category, EditAnywhere, Meta float LazyEvaluationPositionThreshold The delta threshold for a translation / position difference. 0.0 disables position differences.
Public variable UProperty Category, EditAnywhere, Meta float LazyEvaluationRotationThreshold The delta threshold for a rotation difference (in degrees). 0.0 disables rotation differences.
Public variable UProperty Category, EditAnywhere, Meta float LazyEvaluationScaleThreshold The delta threshold for a scale difference. 0.0 disables scale differences.
Public variable UProperty Category visibleanywhere TArray< FControlRigComponentMappedElement > MappedElements  
Public variable UProperty Category, Meta BlueprintAssignable FControlRigComponentDelegate OnPostConstructionDelegate Event fired after this component's ControlRig is setup
Public variable UProperty Category, Meta BlueprintAssignable FControlRigComponentDelegate OnPostForwardsSolveDelegate Event fired after this component's ControlRig's forwards solve
Public variable UProperty Category, Meta BlueprintAssignable FControlRigComponentDelegate OnPostInitializeDelegate Event fired after this component's ControlRig is initialized
Public variable UProperty Category, Meta BlueprintAssignable FControlRigComponentDelegate OnPreConstructionDelegate Event fired before this component's ControlRig is setup
Public variable UProperty Category, Meta BlueprintAssignable FControlRigComponentDelegate OnPreForwardsSolveDelegate Event fired before this component's ControlRig's forwards solve
Public variable UProperty Category, Meta BlueprintAssignable FControlRigComponentDelegate OnPreInitializeDelegate Event fired just before this component's ControlRig is initialized
Public variable UProperty Category, EditAnywhere TArray< FControlRigComponentMappedElement > UserDefinedElements  

Constructors

  Type Name Description
Public function  

UControlRigComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta void Adds all matching bones to the rig, should not be used before OnPreInitialize Event
Public function UFunction BlueprintCallable, Category, Meta void Adds a series of mapped bones to the rig, should not be used before OnPreInitialize Event
Public function UFunction BlueprintCallable, Category, Meta void Adds the provided mapped elements to the component, should not be used before OnPreInitialize Event
Public function UFunction BlueprintCallable, Category, Meta void Adds a series of mapped bones to the rig, should not be used before OnPreInitialize Event
Public function UFunction BlueprintPure, Category bool Returns true if the Component can execute its Control Rig
Public function UFunction BlueprintCallable, Category void Removes all mapped elements from the component
Public function UFunction BlueprintPure, Category bool

DoesElementExist ( FName Name,
ERigElementType ElementType
)

 Returns true if an element given a type and name exists in the rig
Public function Const UFunction BlueprintPure, Category float Get the ControlRig's local time in seconds since its last initialize
Public function UFunction BlueprintPure, Category FTransform Returns the transform of the bone in the requested space
Public function UFunction BlueprintPure, Category bool

GetControlBool ( FName ControlName
)

 Returns the value of a bool control
Public function UFunction BlueprintPure, Category float

GetControlFloat ( FName ControlName
)

 Returns the value of a float control
Public function UFunction BlueprintPure, Category int32

GetControlInt ( FName ControlName
)

 Returns the value of an integer control
Public function UFunction BlueprintCallable, Category FTransform Returns the offset transform of a control
Public function UFunction BlueprintPure, Category FVector Returns the value of a position control
Public function UFunction BlueprintPure, Category UControlRig * Get the ControlRig hosted by this component
Public function UFunction BlueprintPure, Category FRotator Returns the value of a rotator control
Public function UFunction BlueprintPure, Category FVector Returns the value of a scale control
Public function UFunction BlueprintPure, Category FTransform Returns the value of a transform control
Public function UFunction BlueprintPure, Category FVector2D

GetControlVector2D ( FName ControlName
)

 Returns the value of a Vector3D control
Public function UFunction BlueprintPure, Category TArray< FName > Returns all of the names for a given element type (Bone, Control, etc)
Public function UFunction BlueprintPure, Category FTransform Returns the initial transform of the bone in the requested space
Public function UFunction BlueprintPure, Category FTransform Returns the initial transform of the space in the requested space
Public function UFunction BlueprintPure, Category FTransform Returns the transform of the space in the requested space
Public function UFunction BlueprintCallable, Category void Initializes the rig's memory and calls the construction event
Public function FControlRigComponentEvent &  
Public function UFunction Category blueprintnativeevent, callineditor void  
Public function UFunction Category, Meta blueprintnativeevent, callineditor void  
Public function UFunction Category blueprintnativeevent, callineditor void  
Public function UFunction Category blueprintnativeevent, callineditor void  
Public function UFunction Category, Meta blueprintnativeevent, callineditor void  
Public function UFunction Category blueprintnativeevent, callineditor void  
Public function UFunction BlueprintCallable, Category, Meta void Setup the initial transforms / ref pose of the bones based on a skeletal mesh
Public function UFunction BlueprintCallable, Category void

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

 Sets the transform of the bone in the requested space
Public function UFunction BlueprintCallable, Category void

SetControlBool ( FName ControlName,
bool Value
)

 Sets the value of a bool control
Public function UFunction BlueprintCallable, Category void

SetControlFloat ( FName ControlName,
float Value
)

 Sets the value of a float control
Public function UFunction BlueprintCallable, Category void

SetControlInt ( FName ControlName,
int32 Value
)

 Sets the value of an integer control
Public function UFunction BlueprintCallable, Category void

SetControlOffset ( FName ControlName,
FTransform OffsetTransform,
EControlRigComponentSpace Space
)

 Sets the offset transform of a control
Public function UFunction BlueprintCallable, Category void

SetControlPosition ( FName ControlName,
FVector Value,
EControlRigComponentSpace Space
)

 Sets the value of a position control
Public function void

SetControlRig ( UControlRig* ControlRig
)

  
Public function UFunction BlueprintCallable, Category void

SetControlRigClass ( TSubclassOf< UControlRig > InControlRigClass
)

  
Public function UFunction BlueprintCallable, Category void

SetControlRotator ( FName ControlName,
FRotator Value,
EControlRigComponentSpace Space
)

 Sets the value of a rotator control
Public function UFunction BlueprintCallable, Category void

SetControlScale ( FName ControlName,
FVector Value,
EControlRigComponentSpace Space
)

 Sets the value of a scale control
Public function UFunction BlueprintCallable, Category void

SetControlTransform ( FName ControlName,
FTransform Value,
EControlRigComponentSpace Space
)

 Sets the value of a transform control
Public function UFunction BlueprintCallable, Category void

SetControlVector2D ( FName ControlName,
FVector2D Value
)

 Sets the value of a vector2D control
Public function UFunction BlueprintCallable, Category void

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

 Sets the initial transform of the bone in the requested space
Public function UFunction BlueprintCallable, Category void

SetInitialSpaceTransform ( FName SpaceName,
FTransform InitialTransform,
EControlRigComponentSpace Space
)

 Sets the transform of the space in the requested space
Public function UFunction BlueprintCallable, Category, Meta void Replaces the mapped elements on the component with the provided array, should not be used before OnPreInitialize Event
Public function UFunction BlueprintCallable, Category void

SetObjectBinding ( UObject* InObjectToBind
)

  
Public function UFunction BlueprintCallable, Category void

Update ( float DeltaTime
)

 Updates and ticks the rig.

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.
Public function Virtual void

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

 Function called every frame on this ActorComponent.

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 Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public class FControlRigComponentEvent    

Constants

Name Description
EditorNotifications  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page