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/ControlRigBlueprint.h
Include Path #include "ControlRigBlueprint.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers
  ControlRigBlueprint.h  

UControlRigBlueprint ( const FObjectInitializer& ObjectInitializer
)

   ControlRigBlueprint.h  

Classes

Name Remarks
FControlValueScope Class used to temporarily cache all current control values and reapply them on destruction
FOnRigTypeChanged  

Constants

Name Type Remarks Include Path
ControlRigPanelNodeFactoryName const FLazyName   ControlRigBlueprint.h
sCurrentlyOpenedRigBlueprints TArray< UControlRigBlueprint * >   ControlRigBlueprint.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ArrayConnectionMap TMap< FRigElementKey, FRigElementKeyCollection >   ControlRigBlueprint.h  
bAllowMultipleInstances bool If set to true, multiple control rig tracks can be created for the same rig in sequencer ControlRigBlueprint.h
  • EditAnywhere
  • Category="Sequencer"
  • AssetRegistrySearchable
ControlRigType EControlRigType   ControlRigBlueprint.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. ControlRigBlueprint.h
  • EditAnywhere
  • Category="Hierarchy"
  • AssetRegistrySearchable
DrawContainer FRigVMDrawContainer   ControlRigBlueprint.h
  • EditAnywhere
  • Category="Drawing"
Hierarchy TObjectPtr< URigHierarchy >   ControlRigBlueprint.h
  • BlueprintReadOnly
  • Category="Hierarchy"
HierarchySettings FRigHierarchySettings   ControlRigBlueprint.h
  • EditAnywhere
  • Category="Hierarchy"
Influences FRigInfluenceMapPerEvent   ControlRigBlueprint.h
  • EditAnywhere
  • Category="Influence Map"
ItemTypeDisplayName FName   ControlRigBlueprint.h
  • AssetRegistrySearchable
ModularRigModel FModularRigModel   ControlRigBlueprint.h
  • BlueprintReadOnly
  • Category="Modules"
ModularRigSettings FModularRigSettings   ControlRigBlueprint.h
  • EditAnywhere
  • Category="Modular Rig"
ModuleReferenceData TArray< FModuleReferenceData > Asset searchable information module references in this rig ControlRigBlueprint.h
  • AssetRegistrySearchable
RigModuleSettings FRigModuleSettings   ControlRigBlueprint.h
  • EditAnywhere
  • Category="Hierarchy"
  • AssetRegistrySearchable
ShapeLibraries TArray< TSoftObjectPtr< UControlRigShapeLibrary > >   ControlRigBlueprint.h
  • EditAnywhere
  • Category=Shapes
ShapeLibrariesToLoadOnPackageLoaded TArray< FString > Shape libraries to load during package load completed ControlRigBlueprint.h  

Protected

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

FName AddTransientControl ( const FRigElementKey& InElement
)

 Remove a transient / temporary control used to interact with a bone ControlRigBlueprint.h  

FName AddTransientControl ( const URigVMUnitNode* InNode,
const FRigDirectManipulationTarget& InTarget
)

 Remove a transient / temporary control used to interact with a pin ControlRigBlueprint.h  

bool CanTurnIntoControlRigModule ( bool InAutoConvertHierarchy,
FString* OutErrorMessage
) const

   ControlRigBlueprint.h  

bool CanTurnIntoControlRigModule_Blueprint ( bool InAutoConvertHierarchy
) const

   ControlRigBlueprint.h  

bool CanTurnIntoStandaloneRig ( FString* OutErrorMessage
) const

   ControlRigBlueprint.h  

bool CanTurnIntoStandaloneRig_Blueprint()

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

void ClearTransientControls()

 Removes all transient / temporary control used to interact with pins ControlRigBlueprint.h  

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

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

UControlRig * CreateControlRig()

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

TArray< FModuleReferenceData > FindReferencesToModule()

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

virtual TArray< FString > GeneratePythonCommands ( const FString InNewBlueprintName
)

   ControlRigBlueprint.h  

UClass * GetControlRigClass()

   ControlRigBlueprint.h
  • BlueprintCallable
  • Category="VM"

const FControlRigShapeDefinition * GetControlShapeByName ( const FName& InName
) const

   ControlRigBlueprint.h  

UControlRig * GetDebuggedControlRig()

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

virtual IRigVMEditorModule * GetEditorModule()

   ControlRigBlueprint.h  

virtual URigHierarchy * GetHierarchy()

 IRigHierarchyProvider interface. ControlRigBlueprint.h  

URigHierarchyController * GetHierarchyController()

   ControlRigBlueprint.h
  • BlueprintCallable
  • Category="Hierarchy"

virtual void GetInstanceActions ( FBlueprintActionDatabaseRegistrar& ActionRegistrar
) const

   ControlRigBlueprint.h  

UModularRigController * GetModularRigController()

   ControlRigBlueprint.h
  • BlueprintCallable
  • Category="Modules"

TArray< FOverrideStatusSubject > GetOverrideSubjects()

   ControlRigBlueprint.h  

uint32 GetOverrideSubjectsHash()

   ControlRigBlueprint.h  

virtual const FLazyName & GetPanelPinFactoryName()

   ControlRigBlueprint.h  

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

   ControlRigBlueprint.h  

UTexture2D * GetRigModuleIcon()

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

virtual UClass * GetRigVMBlueprintGeneratedClassPrototype()

   ControlRigBlueprint.h  

virtual UClass * GetRigVMEdGraphClass()

   ControlRigBlueprint.h  

virtual UClass * GetRigVMEdGraphNodeClass()

   ControlRigBlueprint.h  

virtual UClass * GetRigVMEdGraphSchemaClass()

   ControlRigBlueprint.h  

virtual UClass * GetRigVMEditorSettingsClass()

   ControlRigBlueprint.h  

virtual UScriptStruct * GetRigVMExecuteContextStruct()

   ControlRigBlueprint.h  

virtual UClass * GetRigVMSchemaClass()

 IRigVMClientHost interface ControlRigBlueprint.h  

virtual void GetTypeActions ( FBlueprintActionDatabaseRegistrar& ActionRegistrar
) const

   ControlRigBlueprint.h  

bool IsControlRigModule()

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

bool IsModularRig()

   ControlRigBlueprint.h  

virtual bool IsValidForBytecodeOnlyRecompile()

   ControlRigBlueprint.h  

FRigHierarchyModifiedEvent & OnHierarchyModified ()

 Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy. ControlRigBlueprint.h  

void OnModularDependencyChanged ( URigVMBlueprint* InBlueprint
)

   ControlRigBlueprint.h  

void OnModularDependencyVMCompiled ( UObject* InBlueprint,
URigVM* InVM,
FRigVMExtendedExecuteContext& InExecuteContext
)

   ControlRigBlueprint.h  

FOnRigVMRefreshEditorEvent & OnModularRigCompiled()

   ControlRigBlueprint.h  

FOnRigVMRefreshEditorEvent & OnModularRigPreCompiled()

   ControlRigBlueprint.h  

FOnRigTypeChanged & OnRigTypeChanged()

   ControlRigBlueprint.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   ControlRigBlueprint.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   ControlRigBlueprint.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   ControlRigBlueprint.h  

virtual void PostLoad()

   ControlRigBlueprint.h  

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

   ControlRigBlueprint.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   ControlRigBlueprint.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   ControlRigBlueprint.h  

void PropagateDrawInstructionsFromBPToInstances()

   ControlRigBlueprint.h  

void PropagateHierarchyFromBPToInstances()

   ControlRigBlueprint.h  

void PropagateModuleHierarchyFromBPToInstances()

   ControlRigBlueprint.h  

void PropagatePoseFromBPToInstances()

   ControlRigBlueprint.h  

void PropagatePoseFromInstanceToBP ( UControlRig* InControlRig
) const

   ControlRigBlueprint.h  

void PropagatePropertyFromBPToInstances ( FRigElementKey InRigElement,
const FProperty* InProperty
) const

   ControlRigBlueprint.h  

void PropagatePropertyFromInstanceToBP ( FRigElementKey InRigElement,
const FProperty* InProperty,
UControlRig* InInstance
) const

   ControlRigBlueprint.h  

void RecompileModularRig()

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

void RefreshModuleConnectors ( const FRigModuleReference* InModule,
bool bPropagateHierarchy
)

   ControlRigBlueprint.h  

void RefreshModuleVariables ( const FRigModuleReference* InModule
)

   ControlRigBlueprint.h  
  ControlRigBlueprint.h  

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

   ControlRigBlueprint.h  

FName RemoveTransientControl ( const URigVMUnitNode* InNode,
const FRigDirectManipulationTarget& InTarget
)

 Remove a transient / temporary control used to interact with a pin ControlRigBlueprint.h  

FName RemoveTransientControl ( const FRigElementKey& InElement
)

 Remove a transient / temporary control used to interact with a bone ControlRigBlueprint.h  

void RequestConstructionOnAllModules()

   ControlRigBlueprint.h  

virtual bool RequiresForceLoadMembers ( UObject* InObject
) const

   ControlRigBlueprint.h  

virtual void Serialize ( FArchive& Ar
)

   ControlRigBlueprint.h  

virtual void SetupPinRedirectorsForBackwardsCompatibility()

   ControlRigBlueprint.h  

virtual bool SupportedByDefaultBlueprintFactory()

   ControlRigBlueprint.h  

virtual bool SupportsEventGraphs()

   ControlRigBlueprint.h  

virtual bool SupportsFunctions()

   ControlRigBlueprint.h  

virtual bool SupportsGlobalVariables()

   ControlRigBlueprint.h  

virtual bool SupportsLocalVariables()

   ControlRigBlueprint.h  

bool TurnIntoControlRigModule ( bool InAutoConvertHierarchy,
FString* OutErrorMessage
)

   ControlRigBlueprint.h  

bool TurnIntoControlRigModule_Blueprint()

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

bool TurnIntoStandaloneRig ( FString* OutErrorMessage
)

   ControlRigBlueprint.h  

bool TurnIntoStandaloneRig_Blueprint()

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

void UpdateElementKeyRedirector ( UControlRig* InControlRig
) const

   ControlRigBlueprint.h  

void UpdateExposedModuleConnectors()

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

void UpdateModularDependencyDelegates()

   ControlRigBlueprint.h  

Overridden from IInterface_PreviewMeshProvider

Name Remarks Include Path Unreal Specifiers

virtual USkeletalMesh * GetPreviewMesh()

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

virtual void SetPreviewMesh ( USkeletalMesh* PreviewMesh,
bool bMarkAsDirty
)

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

Protected

Name Remarks Include Path Unreal Specifiers

virtual void CreateMemberVariablesOnLoad()

   ControlRigBlueprint.h  

TArray< FModuleReferenceData > GetModuleReferenceData()

   ControlRigBlueprint.h  

virtual void PatchVariableNodesOnLoad()

   ControlRigBlueprint.h  

bool ResolveConnector ( const FRigElementKey& DraggedKey,
const FRigElementKey& TargetKey,
bool bSetupUndoRedo
)

   ControlRigBlueprint.h  

bool ResolveConnectorToArray ( const FRigElementKey& DraggedKey,
const TArray< FRigElementKey >& TargetKeys,
bool bSetupUndoRedo
)

   ControlRigBlueprint.h  

virtual void SetupDefaultObjectDuringCompilation ( URigVMHost* InCDO
)

   ControlRigBlueprint.h  

void UpdateConnectionMapFromModel()

   ControlRigBlueprint.h  

Static

Name Remarks Include Path Unreal Specifiers

static TArray< UControlRigBlueprint * > GetCurrentlyOpenRigBlueprints()

   ControlRigBlueprint.h
  • BlueprintCallable
  • Category="VM"

static TArray< FSoftObjectPath > GetReferencesToRigModule ( const FAssetData& InModuleAsset
)

   ControlRigBlueprint.h  

static EControlRigType GetRigType ( const FAssetData& InAsset
)

   ControlRigBlueprint.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
ConnectionMap_DEPRECATED TMap< FRigElementKey, FRigElementKey >   ControlRigBlueprint.h  
GizmoLibrary_DEPRECATED TSoftObjectPtr< UControlRigShapeLibrary >   ControlRigBlueprint.h  
HierarchyContainer_DEPRECATED FRigHierarchyContainer   ControlRigBlueprint.h  
PublicFunctions_DEPRECATED TArray< FRigVMOldPublicFunctionData > Asset searchable information about exposed public functions on this rig ControlRigBlueprint.h
  • AssetRegistrySearchable
Statistics_DEPRECATED FRigVMStatistics   ControlRigBlueprint.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