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 > ControlRigDeveloper > UControlRigBlueprint

Light Theme

Dark Theme

UControlRigBlueprint

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintCore

UBlueprint

UControlRigBlueprint

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Meta=(IgnoreClassThumbnail))
class UControlRigBlueprint :
public UBlueprint,
public IInterface_PreviewMeshProvider

Variables

		Name	Description
	bool	bSuspendModelNotificationsForOthers
	bool	bSuspendModelNotificationsForSelf
	URigVMControlle...	Controller
	FControlRigDraw...	DrawContainer
	TAssetPtr< UCon...	GizmoLibrary
	FRigHierarchyCo...	HierarchyContainer
	URigVMGraph ...	Model
	TMap< FString, ...	PinToOperandMap
	FRigVMStatistic...	Statistics
	FRigVMCompileSe...	VMCompileSettings

Constructors

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

Functions

	Name	Description
FName	AddTransientControl ( URigVMPin* InPin )	Remove a transient / temporary control used to interact with a pin
FName	AddTransientControl ( const FRigElementKey& InElement )	Remove a transient / temporary control used to interact with a bone
void	ClearTransientControls()	Removes all transient / temporary control used to interact with pins
void	DecrementVMRecompileBracket()
TArray< UStr...	GetAvailableRigUnits()
UControlRigB...	GetControlRigBlueprintGeneratedClass()	Get the (full) generated class for this control rig blueprint
UControlRigB...	GetControlRigBlueprintSkeletonClass()	Get the (skeleton) generated class for this control rig blueprint
TArray< UCon...	GetCurrentlyOpenRigBlueprints()
UControlRigH...	GetHierarchyModifier()
void	IncrementVMRecompileBracket()
void	InitializeModelIfRequired()
FRigVMGraphM...	OnModified()
FOnVMCompile...	OnVMCompiled()
void	PopulateModelFromGraphForBackwardsCompatibility ( UControlRigGraph* InGraph )
void	PropagateDrawInstructionsFromBPToInstances()
void	PropagateHierarchyFromBPToInstances ( bool bInitializeContainer, bool bInitializeRigs )
void	PropagatePoseFromBPToInstances()
void	PropagatePoseFromInstanceToBP ( UControlRig* InControlRig )
void	PropagatePropertyFromBPToInstances ( FRigElementKey InRigElement, const FProperty* InProperty )
void	PropagatePropertyFromInstanceToBP ( FRigElementKey InRigElement, const FProperty* InProperty, UControlRig* InInstance )
void	RebuildGraphFromModel()
void	RecompileVM()
void	RecompileVMIfRequired()
FName	RemoveTransientControl ( const FRigElementKey& InElement )	Remove a transient / temporary control used to interact with a bone
FName	RemoveTransientControl ( URigVMPin* InPin )	Remove a transient / temporary control used to interact with a pin
void	RequestAutoVMRecompilation()
void	RequestControlRigInit()

Overridden from UBlueprint

	Name	Description
UClass *	GetBlueprintClass()	Gets the class generated when this blueprint is compiled.
void	GetTypeActions ( FBlueprintActionDatabaseRegistrar&... )	Allow each blueprint type (AnimBlueprint or ControlRigBlueprint) to add specific UBlueprintNodeSpawners pertaining to the sub-class type.
bool	IsValidForBytecodeOnlyRecompile()	Whether or not this blueprint can be considered for a bytecode only compile
void	LoadModulesRequiredForCompilation()	Blueprint can choose to load specific modules for compilation.
void	SetObjectBeingDebugged ( UObject* NewObject )	Sets the current object being debugged
bool	ShouldBeMarkedDirtyUponTransaction()	Returns true if this blueprint should be marked dirty upon a transaction
bool	SupportedByDefaultBlueprintFactory()	Should the generic blueprint factory work for this blueprint?
bool	SupportsAnimLayers()	Returns true if this blueprint supports animation layers
bool	SupportsDelegates()	Returns true if this blueprint supports delegates
bool	SupportsEventGraphs()	Returns true if this blueprint supports event graphs
bool	SupportsFunctions()	Returns true if this blueprint supports functions
bool	SupportsGlobalVariables()	Returns true if this blueprint supports global variables
bool	SupportsLocalVariables()	Returns true if this blueprint supports lobal variables
bool	SupportsMacros()	Returns true if this blueprint supports macros

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
	void	PostTransacted ( const FTransactionObjectEvent& Tra... )	Called after the object has been transacted in some way.

Overridden from IInterface_PreviewMeshProvider

		Name	Description
	USkeletalMes...	GetPreviewMesh()	Get the preview mesh for this asset
	void	SetPreviewMesh ( USkeletalMesh* PreviewMesh, bool bMarkAsDirty )	IInterface_PreviewMeshProvider interface

Constants

Name	Description
sCurrentlyOpenedRigBlueprints

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

Take our survey

Dismiss