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

Light Theme

Dark Theme

UControlRigComponent

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UControlRigComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, ClassGroup="Animation", Abstract, Meta=(BlueprintSpawnableComponent))
class UControlRigComponent : public UActorComponent

Remarks

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

Variables

	Name	Description
UControlRig ...	ControlRig	The current root instance of our ControlRig
FControlRigSign...	OnPostEvaluateDelegate	Event fired after this component's ControlRig is evaluated
FControlRigSign...	OnPostInitializeDelegate	Event fired before this component's ControlRig is evaluated
FControlRigSign...	OnPreEvaluateDelegate	Event fired before this component's ControlRig is evaluated
FControlRigSign...	OnPreInitializeDelegate	Event fired before this component's ControlRig is initialized

Constructors

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

Functions

	Name	Description
UControlRig ...	BP_GetControlRig()	Get the ControlRig hosted by this component
ControlRigTy...	GetControlRig()	Get the ControlRig hosted by this component
void	OnPostEvaluate()
void	OnPostInitialize()
void	OnPreEvaluate()
void	OnPreInitialize()

Overridden from UActorComponent

	Name	Description
TStructOnSco...	GetComponentInstanceData()	Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

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

Take our survey

Dismiss