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

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintCore

UBlueprint

UControlRigBlueprint

References

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

Syntax

UCLASS(BlueprintType, Meta=(IgnoreClassThumbnail))
class UControlRigBlueprint :
    public UBlueprint,
    public IInterface_PreviewMeshProvider,
    public IRigVMClientHost

Variables

	Name	Description
bool	bSuspendAllNotifications
bool	bSuspendModelNotificationsForOthers
bool	bSuspendModelNotificationsForSelf
FRigVMDrawConta...	DrawContainer
TObjectPtr< UCo...	FunctionLibraryEdGraph
TArray< FRigVMR...	FunctionReferenceNodeData	Asset searchable information function references in this rig
TObjectPtr< URi...	Hierarchy
FRigHierarchySe...	HierarchySettings
FRigInfluenceMa...	Influences
TMap< FString, ...	PinToOperandMap
TArray< FRigVMG...	PublicGraphFunctions	Asset searchable information about exposed public functions on this rig
FControlRigPyth...	PythonLogSettings
FRigGraphDispla...	RigGraphDisplaySettings
FRigVMClient	RigVMClient
TArray< TSoftOb...	ShapeLibraries
TArray< FString...	ShapeLibrariesToLoadOnPackageLoaded	Shape libraries to load during package load completed
TObjectPtr< URi...	TemplateController
TObjectPtr< URi...	TemplateModel
FRigVMCompileSe...	VMCompileSettings
FRigVMRuntimeSe...	VMRuntimeSettings

Constructors

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

Functions

	Name	Description
bool	AddBreakpoint ( const FString& InBreakpointNodePat... )	Adds a breakpoint to all loaded blueprints which use the node indicated by InBreakpointNodePath If the node is inside a public function, it will add a breakpoint to all blueprints calling this function.
bool	AddBreakpoint ( URigVMNode* InBreakpointNode, URigVMLibraryNode* LibraryNode )	Adds a breakpoint to all loaded blueprints which use the InBreakpointNode.
bool	AddBreakpointToControlRig ( URigVMNode* InBreakpointNode )	Adds a breakpoint to the first instruction of each callpath related to the InBreakpointNode
FName	AddMemberVariable ( const FName& InName, const FString& InCPPType, bool bIsPublic, bool bIsReadOnly, FString InDefaultValue )
URigVMGraph ...	AddModel ( FString InName, bool bSetupUndoRedo, bool bPrintPythonCommand )
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	BroadcastGraphImported ( UEdGraph* InGraph )
void	BroadcastNodeDoubleClicked ( URigVMNode* InNode )
void	BroadcastPostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )
void	BroadcastRefreshEditor()
void	BroadCastReportCompilerMessage ( EMessageSeverity::Type InSeverity, UObject* InSubject, const FString& InMessage )
void	BroadcastRequestLocalizeFunctionDialog ( FRigVMGraphFunctionIdentifier InFun..., bool bForce )
bool	ChangeMemberVariableType ( const FName& InName, const FString& InCPPType, bool bIsPublic, bool bIsReadOnly, FString InDefaultValue )
void	ClearBreakpoints()	Removes all the breakpoints from the blueprint and the VM
void	ClearTransientControls()	Removes all transient / temporary control used to interact with pins
UControlRig ...	CreateControlRig()
void	DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutC..., const UClass* SpecificSubclass )
void	DecrementVMRecompileBracket()
TArray< FStr...	GeneratePythonCommands ( const FString InNewBlueprintName )
TArray< URig...	GetAllModels()
TArray< UStr...	GetAvailableRigUnits()
URigVMContro...	GetController ( const UEdGraph* InEdGraph )
URigVMContro...	GetController ( const URigVMGraph* InGraph )
URigVMContro...	GetControllerByName ( const FString InGraphName )
URigVMBluepr...	GetControlRigBlueprintGeneratedClass()	Get the (full) generated class for this control rig blueprint
URigVMBluepr...	GetControlRigBlueprintSkeletonClass()	Get the (skeleton) generated class for this control rig blueprint
UClass *	GetControlRigClass()
const FContr...	GetControlShapeByName ( const FName& InName )
TArray< UCon...	GetCurrentlyOpenRigBlueprints()
URigVMGraph ...	GetDefaultModel()
TArray< UCon...	GetDependencies ( bool bRecursive )	Returns a list of dependencies of this blueprint.
TArray< FAss...	GetDependentAssets()	Returns a list of dependents as unresolved soft object pointers.
TArray< UCon...	GetDependentBlueprints ( bool bRecursive, bool bOnlyLoaded )	Returns a list of dependents as resolved blueprints.
UEdGraph ...	GetEdGraph ( const FString& InNodePath )
UEdGraph ...	GetEdGraph ( URigVMGraph* InModel )
URigHierarch...	GetHierarchyController()
URigVMFuncti...	GetLocalFunctionLibrary()
TArray< FRig...	GetMemberVariables()
URigVMGraph ...	GetModel ( const FString& InNodePath )
URigVMGraph ...	GetModel ( const UEdGraph* InEdGraph )
URigVMContro...	GetOrCreateController ( const UEdGraph* InGraph )
URigVMContro...	GetOrCreateController ( URigVMGraph* InGraph )
TArray< FRig...	GetReferenceNodeData()
URigVMContro...	GetTemplateController ( bool bIsFunctionLibrary )
URigVMGraph ...	GetTemplateModel ( bool bIsFunctionLibrary )
void	IncrementVMRecompileBracket()
void	InitializeModelIfRequired ( bool bRecompileVM )
bool	IsFunctionPublic ( const FName& InFunctionName )
void	MarkFunctionPublic ( const FName& InFunctionName, bool bIsPublic )
FOnBreakpoin...	OnBreakpointAdded()
FOnExternalV...	OnExternalVariablesChanged()
FOnGraphImpo...	OnGraphImported()
FRigHierarch...	OnHierarchyModified()	Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy.
FRigVMGraphM...	OnModified()
FOnNodeDoubl...	OnNodeDoubleClicked()
FOnPostEditC...	OnPostEditChangeChainProperty()
void	OnPostVariableChange ( UBlueprint* InBlueprint )
void	OnPreVariableChange ( UObject* InObject )
FOnRefreshEd...	OnRefreshEditor()
FOnReportCom...	OnReportCompilerMessage()
FControlRigO...	OnRequestBreakLinksDialog()
FControlRigO...	OnRequestBulkEditDialog()
FOnRequestIn...	OnRequestInspectObject()
FRigVMContro...	OnRequestJumpToHyperlink()
FOnLocalizeF...	OnRequestLocalizeFunctionDialog()
void	OnRigVMRegistryChanged()	RigVMRegistry changes can be triggered when new user defined types(structs/enums) are added/removed in which case we have to refresh the model
void	OnVariableAdded ( const FName& InVarName )
FOnVariableD...	OnVariableDropped()
void	OnVariableRemoved ( const FName& InVarName )
void	OnVariableRenamed ( const FName& InOldVarName, const FName& InNewVarName )
void	OnVariableTypeChanged ( const FName& InVarName, FEdGraphPinType InOldPinType, FEdGraphPinType InNewPinType )
FOnVMCompile...	OnVMCompiled()
void	PopulateModelFromGraphForBackwardsCompatibility ( UControlRigGraph* InGraph )
void	PropagateDrawInstructionsFromBPToInstances()
void	PropagateHierarchyFromBPToInstances()
void	PropagatePoseFromBPToInstances()
void	PropagatePoseFromInstanceToBP ( UControlRig* InControlRig )
void	PropagatePropertyFromBPToInstances ( FRigElementKey InRigElement, const FProperty* InProperty )
void	PropagatePropertyFromInstanceToBP ( FRigElementKey InRigElement, const FProperty* InProperty, UControlRig* InInstance )
void	PropagateRuntimeSettingsFromBPToInstances()
void	RebuildGraphFromModel()
void	RecompileVM()
void	RecompileVMIfRequired()
void	RefreshAllModels ( EControlRigBlueprintLoadType InLoad... )	This is needed since even after load model data can change while the Control Rig BP is not opened for example, if a user defined struct changed after BP load, any pin that references the struct needs to be regenerated
void	RefreshControlRigBreakpoints()	Recomputes the instruction breakpoints given the node breakpoints in the blueprint
bool	RemoveBreakpoint ( const FString& InBreakpointNodePat... )	Removes the given breakpoint from all the loaded blueprints that use this node, and recomputes all breakpoints in the VM
bool	RemoveBreakpoint ( URigVMNode* InBreakpointNode )	Removes the given breakpoint from all the loaded blueprints that use this node, and recomputes all breakpoints in the VM
bool	RemoveMemberVariable ( const FName& InName )
bool	RemoveModel ( FString InName, bool bSetupUndoRedo, bool bPrintPythonCommand )
FName	RemoveTransientControl ( URigVMPin* InPin )	Remove a transient / temporary control used to interact with a pin
FName	RemoveTransientControl ( const FRigElementKey& InElement )	Remove a transient / temporary control used to interact with a bone
bool	RenameMemberVariable ( const FName& InOldName, const FName& InNewName )
void	RequestAutoVMRecompilation()
void	RequestControlRigInit()
void	RequestInspectObject ( const TArray< UObject* >& InO... )
void	SetAutoVMRecompile ( bool bAutoRecompile )
void	SetDebugMode ( const bool bValue )	Sets the execution mode. In Release mode the rig will ignore all breakpoints.
void	SetupPinRedirectorsForBackwardsCompatibility()

Overridden from UBlueprint

	Name	Description
bool	CanImportGraphFromText ( const FString& InClipboardText )	Returns true if the blueprint can import a given InClipboardText.
bool	ExportGraphToText ( UEdGraph* InEdGraph, FString& OutText )	Copies a given graph into a text buffer. Returns true if successful.
UClass *	GetBlueprintClass()	Gets the class generated when this blueprint is compiled.
void	GetInstanceActions ( FBlueprintActionDatabaseRegistrar&... )	Allow each blueprint instance to add specific UBlueprintNodeSpawners pertaining to the sub-class type.
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	ReplaceDeprecatedNodes()	Checks all nodes in all graphs to see if they should be replaced by other nodes
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 global variables
bool	SupportsMacros()	Returns true if this blueprint supports macros
bool	TryImportGraphFromText ( const FString& InClipboardText, UEdGraph** OutGraphPtr )	Returns a new ed graph if the blueprint's specialization imported a graph based on a clipboard text content an nullptr if that's not successful.

Overridden from UObject

	Name	Description
void	GetPreloadDependencies ( TArray< UObject* >& OutDeps )	Called during cooking.
bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PostRename ( UObject* OldOuter, const FName OldName )	Called at the end of Rename(), but only if the rename was actually carried out
void	PostTransacted ( const FTransactionObjectEvent& Tra... )	Called after the object has been transacted in some way.
void	PreDuplicate ( FObjectDuplicationParameters& DupP... )	Called before duplication.
void	PreSave ( FObjectPreSaveContext SaveContext )	Presave function.
UClass *	RegenerateClass ( UClass* ClassToRegenerate, UObject* PreviousCDO )	Called on the target when a class is loaded with ClassGeneratedBy is loaded.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_PreviewMeshProvider

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

Overridden from IRigVMClientHost

	Name	Description
UObject *...	GetEditorObjectForRigVMGraph ( URigVMGraph* InVMGraph )	Returns the editor object corresponding with the supplied editor object.
FRigVMClient...	GetRigVMClient()	Returns the rigvm client for this host.
const FRigVM...	GetRigVMClient()	Returns the rigvm client for this host.
IRigVMGraphF...	GetRigVMGraphFunctionHost()	Returns the rigvm function host.
const IRigVM...	GetRigVMGraphFunctionHost()	Returns the rigvm function host.
void	HandleConfigureRigVMController ( const FRigVMClient* InClient, URigVMController* InController... )	Reacts to a request to configure a controller.
void	HandleRigVMGraphAdded ( const FRigVMClient* InClient, const FString& InNodePathOrName )	Reacts to adding a graph.
void	HandleRigVMGraphRemoved ( const FRigVMClient* InClient, const FString& InNodePathOrName )	Reacts to removing a graph.
void	HandleRigVMGraphRenamed ( const FRigVMClient* InClient, const FString& InOldNodePath, const FString& InNewNodePath )	Reacts to renaming a graph.

Constants

Name	Description
PreDuplicateAssetPath
PreDuplicateHostPath
RigVMModelPrefix
sCurrentlyOpenedRigBlueprints

Deprecated Variables

	Name	Description
TObjectPtr< URi...	FunctionLibrary_DEPRECATED
TSoftObjectPtr<...	GizmoLibrary_DEPRECATED
FRigHierarchyCo...	HierarchyContainer_DEPRECATED
TObjectPtr< URi...	Model_DEPRECATED
TArray< FContro...	PublicFunctions_DEPRECATED	Asset searchable information about exposed public functions on this rig
FRigVMStatistic...	Statistics_DEPRECATED

Deprecated Functions

		Name	Description
	PRAGMA_DISAB...	PreSave ( const ITargetPlatform* TargetP... )	Use version that takes FObjectPreSaveContext instead.

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

Take our survey

Cancel