1. Epic GamesDeveloper
  3. UControlRigBlueprint

UControlRigBlueprint

Unreal Engine C++ API Reference > Plugins > ControlRigDeveloper

Inheritance Hierarchy

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 URigVMBlueprint ,  
    public IInterface_PreviewMeshProvider,  
    public IRigHierarchyProvider

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere assetregistrysearchable bool bAllowMultipleInstances If set to true, multiple control rig tracks can be created for the same rig in sequencer
Public variable UProperty TMap< FRigElementKey, FRigElementKey > ConnectionMap  
Public variable UProperty assetregistrysearchable EControlRigType ControlRigType  
Public variable UProperty Category, EditAnywhere assetregistrysearchable FString CustomThumbnail 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.
Public variable UProperty Category, EditAnywhere FRigVMDrawContainer DrawContainer  
Public variable UProperty Category BlueprintReadOnly TObjectPtr< URigHierarchy > Hierarchy  
Public variable UProperty Category, EditAnywhere FRigHierarchySettings HierarchySettings  
Public variable UProperty Category, EditAnywhere FRigInfluenceMapPerEvent Influences  
Public variable UProperty assetregistrysearchable FName ItemTypeDisplayName  
Public variable UProperty Category BlueprintReadOnly FModularRigModel ModularRigModel  
Public variable UProperty Category, EditAnywhere FModularRigSettings ModularRigSettings  
Public variable UProperty assetregistrysearchable TArray< FModuleReferenceData > ModuleReferenceData Asset searchable information module references in this rig
Protected variable FOnRigTypeChanged OnRigTypeChangedDelegate  
Public variable UProperty Category, EditAnywhere assetregistrysearchable FRigModuleSettings RigModuleSettings  
Public variable UProperty Category, EditAnywhere TArray< TSoftObjectPtr< UControlRigShapeLibrary > > ShapeLibraries  
Public variable TArray< FString > ShapeLibrariesToLoadOnPackageLoaded Shape libraries to load during package load completed

Constructors

  Type Name Description
Public function    
Public function  

UControlRigBlueprint ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function FName

AddTransientControl ( const FRigElementKey& InElement
)

 Remove a transient / temporary control used to interact with a bone
Public function FName Remove a transient / temporary control used to interact with a pin
Public function Const bool

CanTurnIntoControlRigModule ( bool InAutoConvertHierarchy,
FString* OutErrorMessage
)

  
Public function Const bool

CanTurnIntoControlRigModule_Blueprint ( bool InAutoConvertHierarchy
)

  
Public function Const bool

CanTurnIntoStandaloneRig ( FString* OutErrorMessage
)

  
Public function Const UFunction BlueprintPure, Category, Meta bool  
Public function void Removes all transient / temporary control used to interact with pins
Public function UFunction BlueprintCallable, Category TArray< URigVMNode * >

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

  
Public function UFunction BlueprintCallable, Category UControlRig *  
Public function Const UFunction BlueprintPure, Category TArray< FModuleReferenceData >  
Public function Const UFunction BlueprintCallable, Category UClass *  
Public function Const const FControlRigShapeDefinition *

GetControlShapeByName ( const FName& InName
)

  
Public function Static UFunction BlueprintCallable, Category TArray< UControlRigBlueprint * >  
Public function UFunction BlueprintCallable, Category UControlRig *  
Public function UFunction BlueprintCallable, Category URigHierarchyController *  
Public function UFunction BlueprintCallable, Category UModularRigController *  
Protected function Const TArray< FModuleReferenceData >  
Public function Virtual Const UFunction BlueprintCallable, Category USkeletalMesh *  
Public function Static TArray< FSoftObjectPath >

GetReferencesToRigModule ( const FAssetData& InModuleAsset
)

  
Public function Const UFunction BlueprintPure, Category UTexture2D *  
Public function Static EControlRigType

GetRigType ( const FAssetData& InAsset
)

  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const bool  
Public function FRigHierarchyModifiedEvent & Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy.
Public function void  
Public function void

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

  
Public function FOnRigVMRefreshEditorEvent &  
Public function FOnRigVMRefreshEditorEvent &  
Public function FOnRigTypeChanged &  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void

PropagatePropertyFromBPToInstances ( FRigElementKey InRigElement,
const FProperty* InProperty
)

  
Public function Const void

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

  
Public function UFunction BlueprintCallable, Category void  
Public function void  
Public function void

RefreshModuleConnectors ( const FRigModuleReference* InModule,
bool bPropagateHierarchy
)

  
Public function void  
Public function void  
Public function FName Remove a transient / temporary control used to interact with a pin
Public function FName

RemoveTransientControl ( const FRigElementKey& InElement
)

 Remove a transient / temporary control used to interact with a bone
Public function void  
Protected function bool

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

  
Public function Virtual UFunction BlueprintCallable, Category void

SetPreviewMesh ( USkeletalMesh* PreviewMesh,
bool bMarkAsDirty
)

 IInterface_PreviewMeshProvider interface
Public function bool

TurnIntoControlRigModule ( bool InAutoConvertHierarchy,
FString* OutErrorMessage
)

  
Public function UFunction BlueprintCallable, Category, Meta bool  
Public function bool

TurnIntoStandaloneRig ( FString* OutErrorMessage
)

  
Public function UFunction BlueprintCallable, Category, Meta bool  
Protected function void  
Public function Const void  
Protected function Const void  
Public function void  

Overridden from URigVMBlueprint

  Type Name Description
Protected function Virtual void  
Public function Virtual Const IRigVMEditorModule * Returns the editor module to be used for this blueprint
Public function Virtual Const void  
Public function Virtual Const const FLazyName & Returns true if a given panel pin factory is compatible this blueprint
Public function Virtual void Called during cooking.
Public function Virtual Const UClass * Returns the class used as the super class for all generated classes
Public function Virtual Const void  
Public function Virtual Const bool  
Protected function Virtual void  
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

PostRename ( UObject* OldOuter,
const FName OldName
)

  
Public function Virtual void

PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

  
Public function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

  
Public function Virtual UClass *

RegenerateClass ( UClass* ClassToRegenerate,
UObject* PreviousCDO
)

  
Public function Virtual Const bool  
Public function Virtual void  
Protected function Virtual void  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  

Overridden from IRigVMClientHost

  Type Name Description
Public function Virtual TArray< FString >

GeneratePythonCommands ( const FString InNewBlueprintName
)

  
Public function Virtual Const UClass * Returns the expected ed graph class to use for this blueprint
Public function Virtual Const UClass * Returns the expected ed graph node class to use for this blueprint
Public function Virtual Const UClass * Returns the expected ed graph schema class to use for this blueprint
Public function Virtual Const UClass * Returns the class of the settings to use
Public function Virtual Const UScriptStruct * Returns the expected execute context struct to use for this blueprint
Public function Virtual Const UClass * IRigVMClientHost interface
Public function Virtual void  

Overridden from IRigHierarchyProvider

  Type Name Description
Public function Virtual Const URigHierarchy * IRigHierarchyProvider interface.

Classes

  Type Name Description
Public class FOnRigTypeChanged    

Constants

Name Description
ControlRigPanelNodeFactoryName  
sCurrentlyOpenedRigBlueprints  

Deprecated Variables

  Type Name Description
Public variable UProperty TSoftObjectPtr< UControlRigShapeLibrary > GizmoLibrary_DEPRECATED  
Public variable UProperty FRigHierarchyContainer HierarchyContainer_DEPRECATED  
Protected variable UProperty assetregistrysearchable TArray< FRigVMOldPublicFunctionData > PublicFunctions_DEPRECATED Asset searchable information about exposed public functions on this rig
Public variable UProperty Meta Transient duplicatetransient FRigVMStatistics Statistics_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page