1. Epic GamesDeveloper
  3. UControlRigBlueprint

UControlRigBlueprint

API > API/Plugins > API/Plugins/ControlRigDeveloper

   
Name UControlRigBlueprint
Type class
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRigDeveloper/Public/ControlRigBlueprintLegacy.h
Include Path #include "ControlRigBlueprintLegacy.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Meta=(IgnoreClassThumbnail))  
class UControlRigBlueprint :  
    public URigVMBlueprint,  
    public IControlRigAssetInterface ,  
    public IInterface_PreviewMeshProvider ,  
    public IRigHierarchyProvider

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers
  ControlRigBlueprintLegacy.h  

UControlRigBlueprint ( const FObjectInitializer& ObjectInitializer
)

   ControlRigBlueprintLegacy.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ArrayConnectionMap TMap< FRigElementKey, FRigElementKeyCollection >   ControlRigBlueprintLegacy.h  
bAllowMultipleInstances bool If set to true, multiple control rig tracks can be created for the same rig in sequencer ControlRigBlueprintLegacy.h
  • EditAnywhere
  • Category="Sequencer"
  • AssetRegistrySearchable
ControlRigType EControlRigType   ControlRigBlueprintLegacy.h
  • AssetRegistrySearchable
CustomThumbnail FString This relates to FAssetThumbnailPool::CustomThumbnailTagName and allows the thumbnail pool to show the thumbnail of the icon rather than the rig itself to avoid deploying the 3D renderer. ControlRigBlueprintLegacy.h
  • EditAnywhere
  • Category="Hierarchy"
  • AssetRegistrySearchable
DrawContainer FRigVMDrawContainer   ControlRigBlueprintLegacy.h
  • EditAnywhere
  • Category="Drawing"
Hierarchy TObjectPtr< URigHierarchy >   ControlRigBlueprintLegacy.h
  • BlueprintReadOnly
  • Category="Hierarchy"
HierarchySettings FRigHierarchySettings   ControlRigBlueprintLegacy.h
  • EditAnywhere
  • Category="Hierarchy"
Influences FRigInfluenceMapPerEvent   ControlRigBlueprintLegacy.h
  • EditAnywhere
  • Category="Influence Map"
ItemTypeDisplayName FName   ControlRigBlueprintLegacy.h
  • AssetRegistrySearchable
ModularRigModel FModularRigModel   ControlRigBlueprintLegacy.h
  • BlueprintReadOnly
  • Category="Modules"
ModularRigSettings FModularRigSettings   ControlRigBlueprintLegacy.h
  • EditAnywhere
  • Category="Modular Rig"
ModuleReferenceData TArray< FModuleReferenceData > Asset searchable information module references in this rig ControlRigBlueprintLegacy.h
  • AssetRegistrySearchable
RigModuleSettings FRigModuleSettings   ControlRigBlueprintLegacy.h
  • EditAnywhere
  • Category="Hierarchy"
  • AssetRegistrySearchable
ShapeLibraries TArray< TSoftObjectPtr< UControlRigShapeLibrary > >   ControlRigBlueprintLegacy.h
  • EditAnywhere
  • Category=Shapes

Protected

Name Type Remarks Include Path Unreal Specifiers
bExposesAnimatableControls bool If set to true, this control rig has animatable controls ControlRigBlueprintLegacy.h
  • AssetRegistrySearchable
bSupportsControls bool Whether or not this rig has Controls on It ControlRigBlueprintLegacy.h
  • AssetRegistrySearchable
bSupportsInversion bool Whether or not this rig has an Inversion Event ControlRigBlueprintLegacy.h
  • AssetRegistrySearchable
DebugBoneRadius float   ControlRigBlueprintLegacy.h  
HierarchyModifiedEvent FRigHierarchyModifiedEvent   ControlRigBlueprintLegacy.h  
ModularRigCompiled FOnRigVMRefreshEditorEvent   ControlRigBlueprintLegacy.h  
ModularRigPreCompiled FOnRigVMRefreshEditorEvent   ControlRigBlueprintLegacy.h  
ModulesRecompilationBracket int32   ControlRigBlueprintLegacy.h
  • Transient
  • DuplicateTransient
PreviewSkeletalMesh TSoftObjectPtr< USkeletalMesh > The default skeletal mesh to use when previewing this asset ControlRigBlueprintLegacy.h
  • AssetRegistrySearchable
  • EditAnywhere
  • Category="Control Rig Blueprint"
SourceCurveImport TSoftObjectPtr< UObject > The skeleton from import into a curve ControlRigBlueprintLegacy.h
  • DuplicateTransient
  • AssetRegistrySearchable
  • EditAnywhere
  • Category="Control Rig Blueprint"
SourceHierarchyImport TSoftObjectPtr< UObject > The skeleton from import into a hierarchy ControlRigBlueprintLegacy.h
  • DuplicateTransient
  • AssetRegistrySearchable
  • EditAnywhere
  • Category="Control Rig Blueprint"
Validator TObjectPtr< UControlRigValidator >   ControlRigBlueprintLegacy.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanTurnIntoStandaloneRig_Blueprint()

   ControlRigBlueprintLegacy.h
  • BlueprintPure
  • Meta=(DisplayName="CanTurnIntoStandaloneRig", ScriptName="CanTurnIntoStandaloneRig")
  • Category="Control Rig Blueprint"

TArray< URigVMNode * > ConvertHierarchyElementsToSpawnerNodes ( URigHierarchy* InHierarchy,
TArray< FRigElementKey > InKeys,
bool bRemoveElements
)

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="Control Rig Blueprint"

TArray< FModuleReferenceData > FindReferencesToModule()

   ControlRigBlueprintLegacy.h
  • BlueprintPure
  • Category="Control Rig Blueprint"

UTexture2D * GetRigModuleIcon()

   ControlRigBlueprintLegacy.h
  • BlueprintPure
  • Category="Control Rig Blueprint"

virtual UClass * GetRigVMBlueprintGeneratedClassPrototype()

   ControlRigBlueprintLegacy.h  

virtual UClass * GetRigVMGeneratedClassPrototype()

   ControlRigBlueprintLegacy.h  

virtual UClass * RegenerateClass ( UClass* ClassToRegenerate,
UObject* PreviousCDO
)

   ControlRigBlueprintLegacy.h  

bool TurnIntoControlRigModule_Blueprint()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Meta=(DisplayName="TurnIntoControlRigModule", ScriptName="TurnIntoControlRigModule")
  • Category="Control Rig Blueprint"

bool TurnIntoStandaloneRig_Blueprint()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Meta=(DisplayName="TurnIntoStandaloneRig", ScriptName="TurnIntoStandaloneRig")
  • Category="Control Rig Blueprint"

Overridden from IControlRigAssetInterface

Name Remarks Include Path Unreal Specifiers

virtual UControlRig * CreateControlRig()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="Control Rig Blueprint"

virtual TArray< FString > GeneratePythonCommands ( const FString InNewBlueprintName
)

 Virtual UClass* GetRigVMGeneratedClassPrototype() const override { return UControlRigBlueprintGeneratedClass::StaticClass(); } ControlRigBlueprintLegacy.h  

virtual bool & GetAllowMultipleInstances()

 If set to true, multiple control rig tracks can be created for the same rig in sequencer ControlRigBlueprintLegacy.h  

virtual TMap< FRigElementKey, FRigElementKeyCollection > & GetArrayConnectionMap()

   ControlRigBlueprintLegacy.h  

virtual UClass * GetBlueprintClass()

   ControlRigBlueprintLegacy.h  

virtual UClass * GetControlRigClass()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="VM"

virtual EControlRigType & GetControlRigType()

   ControlRigBlueprintLegacy.h  

virtual FString & GetCustomThumbnail()

 This relates to FAssetThumbnailPool::CustomThumbnailTagName and allows the thumbnail pool to show the thumbnail of the icon rather than the rig itself to avoid deploying the 3D renderer. ControlRigBlueprintLegacy.h  

virtual float & GetDebugBoneRadius()

   ControlRigBlueprintLegacy.h  

virtual UControlRig * GetDebuggedControlRig()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="Control Rig Blueprint"

virtual FRigVMDrawContainer & GetDrawContainer()

   ControlRigBlueprintLegacy.h  

virtual IRigVMEditorModule * GetEditorModule()

   ControlRigBlueprintLegacy.h  

virtual bool & GetExposesAnimatableControls()

 If set to true, this control rig has animatable controls ControlRigBlueprintLegacy.h  

virtual URigHierarchy * GetHierarchy ()

   ControlRigBlueprintLegacy.h  

virtual URigHierarchy * GetHierarchy ()

   ControlRigBlueprintLegacy.h  

virtual URigHierarchyController * GetHierarchyController()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="Hierarchy"

virtual FRigHierarchySettings & GetHierarchySettings()

   ControlRigBlueprintLegacy.h  

virtual FRigInfluenceMapPerEvent & GetInfluences()

   ControlRigBlueprintLegacy.h  

virtual void GetInstanceActions ( FBlueprintActionDatabaseRegistrar& ActionRegistrar
) const

   ControlRigBlueprintLegacy.h  

virtual FName & GetItemTypeDisplayName()

   ControlRigBlueprintLegacy.h  

virtual UModularRigController * GetModularRigController()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="Modules"

virtual FModularRigModel & GetModularRigModel()

   ControlRigBlueprintLegacy.h  

virtual FModularRigSettings & GetModularRigSettings()

   ControlRigBlueprintLegacy.h  

virtual TArray< FModuleReferenceData > & GetModuleReferenceData()

 Asset searchable information module references in this rig ControlRigBlueprintLegacy.h  

virtual const FLazyName & GetPanelPinFactoryName()

   ControlRigBlueprintLegacy.h  

virtual void GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

   ControlRigBlueprintLegacy.h  

virtual USkeletalMesh * GetPreviewMesh()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="Control Rig Blueprint"

virtual TSoftObjectPtr< USkeletalMesh > & GetPreviewSkeletalMesh()

 The default skeletal mesh to use when previewing this asset ControlRigBlueprintLegacy.h  

virtual FRigModuleSettings & GetRigModuleSettings()

   ControlRigBlueprintLegacy.h  

virtual FRigVMAssetInterfacePtr GetRigVMAssetInterface()

 IControlRigAssetInterface interface ControlRigBlueprintLegacy.h  

virtual UClass * GetRigVMEdGraphClass()

   ControlRigBlueprintLegacy.h  

virtual UClass * GetRigVMEdGraphNodeClass()

   ControlRigBlueprintLegacy.h  

virtual UClass * GetRigVMEdGraphSchemaClass()

   ControlRigBlueprintLegacy.h  

virtual UClass * GetRigVMEditorSettingsClass()

   ControlRigBlueprintLegacy.h  

virtual UScriptStruct * GetRigVMExecuteContextStruct()

   ControlRigBlueprintLegacy.h  

virtual UClass * GetRigVMSchemaClass()

 IRigVMClientHost interface ControlRigBlueprintLegacy.h  

virtual TArray< TSoftObjectPtr< UControlRigShapeLibrary > > & GetShapeLibraries()

   ControlRigBlueprintLegacy.h  

virtual TSoftObjectPtr< UObject > & GetSourceCurveImport()

 The skeleton from import into a curve ControlRigBlueprintLegacy.h  

virtual TSoftObjectPtr< UObject > & GetSourceHierarchyImport()

 The skeleton from import into a hierarchy ControlRigBlueprintLegacy.h  

virtual bool & GetSupportsControls()

 Whether or not this rig has Controls on It ControlRigBlueprintLegacy.h  

virtual bool & GetSupportsInversion()

 Whether or not this rig has an Inversion Event ControlRigBlueprintLegacy.h  

virtual void GetTypeActions ( FBlueprintActionDatabaseRegistrar& ActionRegistrar
) const

   ControlRigBlueprintLegacy.h  

virtual TObjectPtr< UControlRigValidator > & GetValidator()

   ControlRigBlueprintLegacy.h  

virtual bool IsControlRigModule()

   ControlRigBlueprintLegacy.h
  • BlueprintPure
  • Category="Control Rig Blueprint"

virtual bool IsValidForBytecodeOnlyRecompile()

   ControlRigBlueprintLegacy.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   ControlRigBlueprintLegacy.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   ControlRigBlueprintLegacy.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   ControlRigBlueprintLegacy.h  

virtual void PostLoad()

   ControlRigBlueprintLegacy.h  

virtual void PostRename ( UObject* OldOuter,
const FName OldName
)

   ControlRigBlueprintLegacy.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   ControlRigBlueprintLegacy.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   ControlRigBlueprintLegacy.h  

virtual void RecompileModularRig()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="Control Rig Blueprint"

virtual bool RequiresForceLoadMembers ( UObject* InObject
) const

   ControlRigBlueprintLegacy.h  

virtual bool RequiresForceLoadMembersSuper ( UObject* InObject
) const

   ControlRigBlueprintLegacy.h  

virtual void Serialize ( FArchive& Ar
)

   ControlRigBlueprintLegacy.h  

virtual void SerializeSuper ( FArchive& Ar
)

   ControlRigBlueprintLegacy.h  

virtual void SetPreviewMesh ( USkeletalMesh* PreviewMesh,
bool bMarkAsDirty
)

 IInterface_PreviewMeshProvider interface ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="Control Rig Blueprint"

virtual void SetupPinRedirectorsForBackwardsCompatibility()

   ControlRigBlueprintLegacy.h  

virtual bool SupportedByDefaultBlueprintFactory()

   ControlRigBlueprintLegacy.h  

virtual bool SupportsEventGraphs()

   ControlRigBlueprintLegacy.h  

virtual bool SupportsFunctions()

   ControlRigBlueprintLegacy.h  

virtual bool SupportsGlobalVariables()

   ControlRigBlueprintLegacy.h  

virtual bool SupportsLocalVariables()

   ControlRigBlueprintLegacy.h  

virtual void UpdateExposedModuleConnectors()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="Control Rig Blueprint"

Protected

Overridden from IControlRigAssetInterface

Name Remarks Include Path Unreal Specifiers

virtual void CreateMemberVariablesOnLoad()

   ControlRigBlueprintLegacy.h  

virtual void PatchVariableNodesOnLoad()

   ControlRigBlueprintLegacy.h  

virtual void SetHierarchy ( TObjectPtr< URigHierarchy > InHierarchy
)

   ControlRigBlueprintLegacy.h  

virtual void SetupDefaultObjectDuringCompilation ( URigVMHost* InCDO
)

   ControlRigBlueprintLegacy.h  

Static

Name Remarks Include Path Unreal Specifiers

static TArray< UControlRigBlueprint * > GetCurrentlyOpenRigBlueprints()

   ControlRigBlueprintLegacy.h
  • BlueprintCallable
  • Category="VM"

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
ConnectionMap_DEPRECATED TMap< FRigElementKey, FRigElementKey >   ControlRigBlueprintLegacy.h  
GizmoLibrary_DEPRECATED TSoftObjectPtr< UControlRigShapeLibrary >   ControlRigBlueprintLegacy.h  
HierarchyContainer_DEPRECATED FRigHierarchyContainer   ControlRigBlueprintLegacy.h  
PublicFunctions_DEPRECATED TArray< FRigVMOldPublicFunctionData > Asset searchable information about exposed public functions on this rig ControlRigBlueprintLegacy.h
  • AssetRegistrySearchable
Statistics_DEPRECATED FRigVMStatistics   ControlRigBlueprintLegacy.h
  • Transient
  • DuplicateTransient
  • Meta=(DisplayName="VM Statistics", DisplayAfter="VMCompileSettings")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page