1. Epic GamesDeveloper
  3. UControlRigBlueprint

UControlRigBlueprint

API > API/Plugins > API/Plugins/ControlRigDeveloper

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, Meta&61;&40;IgnoreClassThumbnail&41;&41;  
class UControlRigBlueprint :  
    public URigVMBlueprint,  
    public IInterface_PreviewMeshProvider

Variables

  Type Name Description
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 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 Remove a transient / temporary control used to interact with a pin
Public function FName

AddTransientControl ( const FRigElementKey& InElement
)

 Remove a transient / temporary control used to interact with a bone
Public function void Removes all transient / temporary control used to interact with pins
Public function UFunction BlueprintCallable, Category UControlRig *  
Public function 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 URigHierarchyController *  
Public function FRigHierarchyModifiedEvent & Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy.
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 FName

RemoveTransientControl ( 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

Overridden from URigVMBlueprint

  Type Name Description
Protected function Virtual void  
Public function Virtual TArray< FString >

GeneratePythonCommands ( const FString InNewBlueprintName
)

  
Public function Virtual Const IRigVMEditorModule * Returns the editor module to be used for this blueprint
Public function Virtual Const const FName & Returns true if a given panel pin factory is compatible this blueprint
Public function Virtual Const UClass * Returns the class used as the super class for all generated classes
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 * Returns the expected schema class to use for this blueprint
Protected function Virtual void  
Protected function Virtual void  
Public function Virtual void  

Overridden from UBlueprint

  Type Name Description
Public function Virtual Const void Allow each blueprint instance to add specific UBlueprintNodeSpawners pertaining to the sub-class type.
Public function Virtual Const void Allow each blueprint type (AnimBlueprint or ControlRigBlueprint) to add specific UBlueprintNodeSpawners pertaining to the sub-class type.
Public function Virtual Const bool Whether or not this blueprint can be considered for a bytecode only compile
Public function Virtual Const bool  
Public function Virtual Const bool Should the generic blueprint factory work for this blueprint?

Overridden from UObject

  Type Name Description
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

 Called after the object has been transacted in some way.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual UClass *

RegenerateClass ( UClass* ClassToRegenerate,
UObject* PreviousCDO
)

 Called on the target when a class is loaded with ClassGeneratedBy is loaded.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_PreviewMeshProvider

  Type Name Description
Public function Virtual Const UFunction BlueprintCallable, Category USkeletalMesh * Get the preview mesh for this asset
Public function Virtual UFunction BlueprintCallable, Category void

SetPreviewMesh ( USkeletalMesh* PreviewMesh,
bool bMarkAsDirty
)

 IInterface_PreviewMeshProvider interface

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