Navigation
API > API/Plugins > API/Plugins/ControlRigDeveloper
| Name | IControlRigAssetInterface |
| Type | class |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRigDeveloper/Public/ControlRigAsset.h |
| Include Path | #include "ControlRigAsset.h" |
Syntax
class IControlRigAssetInterface
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IControlRigAssetInterface() |
ControlRigAsset.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 | ControlRigAsset.h | |
| sCurrentlyOpenedRigBlueprints | TArray< FControlRigAssetInterfacePtr > | ControlRigAsset.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ShapeLibrariesToLoadOnPackageLoaded | TArray< FString > | Shape libraries to load during package load completed | ControlRigAsset.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 | ControlRigAsset.h | |
FName AddTransientControl
(
const URigVMUnitNode* InNode, |
Remove a transient / temporary control used to interact with a pin | ControlRigAsset.h | |
bool CanTurnIntoControlRigModule
(
bool InAutoConvertHierarchy, |
ControlRigAsset.h | ||
bool CanTurnIntoStandaloneRig
(
FString* OutErrorMessage |
ControlRigAsset.h | ||
void ClearTransientControls() |
Removes all transient / temporary control used to interact with pins | ControlRigAsset.h | |
| ControlRigAsset.h | |||
virtual UControlRig * CreateControlRig() |
ControlRigAsset.h | ||
TArray< FModuleReferenceData > FindReferencesToModule() |
ControlRigAsset.h | ||
| Virtual UClass* GetRigVMGeneratedClassPrototype() const override { return UControlRigBlueprintGeneratedClass::StaticClass(); } | ControlRigAsset.h | ||
bool & GetAllowMultipleInstances() |
If set to true, multiple control rig tracks can be created for the same rig in sequencer | ControlRigAsset.h | |
TMap< FRigElementKey, FRigElementKeyCollection > & GetArrayConnectionMap () |
ControlRigAsset.h | ||
const TMap< FRigElementKey, FRigElementKeyCollection > & GetArrayConnectionMap () |
ControlRigAsset.h | ||
virtual UClass * GetBlueprintClass() |
ControlRigAsset.h | ||
virtual UClass * GetControlRigClass() |
ControlRigAsset.h | ||
EControlRigType & GetControlRigType() |
ControlRigAsset.h | ||
const FControlRigShapeDefinition * GetControlShapeByName
(
const FName& InName |
ControlRigAsset.h | ||
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. | ControlRigAsset.h | |
virtual UControlRig * GetDebuggedControlRig() |
ControlRigAsset.h | ||
const FRigVMDrawContainer & GetDrawContainer () |
ControlRigAsset.h | ||
FRigVMDrawContainer & GetDrawContainer () |
ControlRigAsset.h | ||
virtual IRigVMEditorModule * GetEditorModule() |
ControlRigAsset.h | ||
virtual URigHierarchy * GetHierarchy () |
ControlRigAsset.h | ||
URigHierarchy * GetHierarchy () |
ControlRigAsset.h | ||
virtual URigHierarchyController * GetHierarchyController() |
ControlRigAsset.h | ||
const FRigHierarchySettings & GetHierarchySettings () |
ControlRigAsset.h | ||
FRigHierarchySettings & GetHierarchySettings () |
ControlRigAsset.h | ||
FRigInfluenceMapPerEvent & GetInfluences() |
ControlRigAsset.h | ||
virtual void GetInstanceActions
(
FBlueprintActionDatabaseRegistrar& ActionRegistrar |
ControlRigAsset.h | ||
FName & GetItemTypeDisplayName() |
ControlRigAsset.h | ||
virtual UModularRigController * GetModularRigController() |
ControlRigAsset.h | ||
FModularRigModel & GetModularRigModel () |
ControlRigAsset.h | ||
const FModularRigModel & GetModularRigModel () |
ControlRigAsset.h | ||
FModularRigSettings & GetModularRigSettings () |
ControlRigAsset.h | ||
const FModularRigSettings & GetModularRigSettings () |
ControlRigAsset.h | ||
TArray< FModuleReferenceData > & GetModuleReferenceData() |
Asset searchable information module references in this rig | ControlRigAsset.h | |
| ControlRigAsset.h | |||
const UObject * GetObjectBeingDebugged () |
ControlRigAsset.h | ||
TArray< FOverrideStatusSubject > GetOverrideSubjects() |
ControlRigAsset.h | ||
uint32 GetOverrideSubjectsHash() |
ControlRigAsset.h | ||
virtual const FLazyName & GetPanelPinFactoryName() |
ControlRigAsset.h | ||
| ControlRigAsset.h | |||
virtual USkeletalMesh * GetPreviewMesh() |
ControlRigAsset.h | ||
UTexture2D * GetRigModuleIcon() |
ControlRigAsset.h | ||
FRigModuleSettings & GetRigModuleSettings () |
ControlRigAsset.h | ||
virtual const FRigModuleSettings & GetRigModuleSettings () |
ControlRigAsset.h | ||
FRigVMAssetInterfacePtr GetRigVMAssetInterface () |
ControlRigAsset.h | ||
virtual const FRigVMAssetInterfacePtr GetRigVMAssetInterface () |
ControlRigAsset.h | ||
virtual FRigVMClient * GetRigVMClient() |
ControlRigAsset.h | ||
virtual UClass * GetRigVMEdGraphClass() |
ControlRigAsset.h | ||
virtual UClass * GetRigVMEdGraphNodeClass() |
ControlRigAsset.h | ||
virtual UClass * GetRigVMEdGraphSchemaClass() |
ControlRigAsset.h | ||
virtual UClass * GetRigVMEditorSettingsClass() |
ControlRigAsset.h | ||
virtual UScriptStruct * GetRigVMExecuteContextStruct() |
ControlRigAsset.h | ||
virtual UClass * GetRigVMSchemaClass() |
IRigVMClientHost interface | ControlRigAsset.h | |
const TArray< TSoftObjectPtr< UControlRigShapeLibrary > > & GetShapeLibraries () |
ControlRigAsset.h | ||
TArray< TSoftObjectPtr< UControlRigShapeLibrary > > & GetShapeLibraries () |
ControlRigAsset.h | ||
virtual void GetTypeActions
(
FBlueprintActionDatabaseRegistrar& ActionRegistrar |
ControlRigAsset.h | ||
virtual bool IsControlRigModule() |
ControlRigAsset.h | ||
bool IsModularRig() |
ControlRigAsset.h | ||
virtual bool IsValidForBytecodeOnlyRecompile() |
ControlRigAsset.h | ||
void Modify() |
ControlRigAsset.h | ||
FRigHierarchyModifiedEvent & OnHierarchyModified () |
Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy. | ControlRigAsset.h | |
void OnModularDependencyChanged
(
FRigVMAssetInterfacePtr InBlueprint |
ControlRigAsset.h | ||
void OnModularDependencyVMCompiled
(
UObject* InBlueprint, |
ControlRigAsset.h | ||
FOnRigVMRefreshEditorEvent & OnModularRigCompiled() |
ControlRigAsset.h | ||
FOnRigVMRefreshEditorEvent & OnModularRigPreCompiled() |
ControlRigAsset.h | ||
| ControlRigAsset.h | |||
FOnRigTypeChanged & OnRigTypeChanged() |
ControlRigAsset.h | ||
virtual void PostDuplicate
(
bool bDuplicateForPIE |
ControlRigAsset.h | ||
virtual void PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedEvent |
ControlRigAsset.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
ControlRigAsset.h | ||
virtual void PostLoad() |
ControlRigAsset.h | ||
| ControlRigAsset.h | |||
virtual void PostTransacted
(
const FTransactionObjectEvent& TransactionEvent |
ControlRigAsset.h | ||
virtual void PreSave
(
FObjectPreSaveContext ObjectSaveContext |
ControlRigAsset.h | ||
void PropagateDrawInstructionsFromBPToInstances() |
ControlRigAsset.h | ||
void PropagateHierarchyFromBPToInstances() |
ControlRigAsset.h | ||
void PropagateModuleHierarchyFromBPToInstances() |
ControlRigAsset.h | ||
void PropagatePoseFromBPToInstances() |
ControlRigAsset.h | ||
void PropagatePoseFromInstanceToBP
(
UControlRig* InControlRig |
ControlRigAsset.h | ||
void PropagatePropertyFromBPToInstances
(
FRigElementKey InRigElement, |
ControlRigAsset.h | ||
void PropagatePropertyFromInstanceToBP
(
FRigElementKey InRigElement, |
ControlRigAsset.h | ||
virtual void RecompileModularRig() |
ControlRigAsset.h | ||
void RefreshModuleConnectors () |
ControlRigAsset.h | ||
void RefreshModuleConnectors
(
const FRigModuleReference* InModule, |
ControlRigAsset.h | ||
void RefreshModuleVariables () |
ControlRigAsset.h | ||
void RefreshModuleVariables
(
const FRigModuleReference* InModule |
ControlRigAsset.h | ||
FName RemoveTransientControl
(
const FRigElementKey& InElement |
Remove a transient / temporary control used to interact with a bone | ControlRigAsset.h | |
FName RemoveTransientControl
(
const URigVMUnitNode* InNode, |
Remove a transient / temporary control used to interact with a pin | ControlRigAsset.h | |
void RequestConstructionOnAllModules() |
ControlRigAsset.h | ||
virtual bool RequiresForceLoadMembers
(
UObject* InObject |
ControlRigAsset.h | ||
virtual void Serialize
(
FArchive& Ar |
ControlRigAsset.h | ||
virtual void SetPreviewMesh
(
USkeletalMesh* PreviewMesh, |
IInterface_PreviewMeshProvider interface | ControlRigAsset.h | |
virtual void SetupPinRedirectorsForBackwardsCompatibility() |
ControlRigAsset.h | ||
virtual bool SupportedByDefaultBlueprintFactory() |
ControlRigAsset.h | ||
virtual bool SupportsEventGraphs() |
ControlRigAsset.h | ||
virtual bool SupportsFunctions() |
ControlRigAsset.h | ||
virtual bool SupportsGlobalVariables() |
ControlRigAsset.h | ||
virtual bool SupportsLocalVariables() |
ControlRigAsset.h | ||
bool TurnIntoControlRigModule
(
bool InAutoConvertHierarchy, |
ControlRigAsset.h | ||
bool TurnIntoStandaloneRig
(
FString* OutErrorMessage |
ControlRigAsset.h | ||
void UpdateElementKeyRedirector
(
UControlRig* InControlRig |
ControlRigAsset.h | ||
virtual void UpdateExposedModuleConnectors() |
ControlRigAsset.h | ||
void UpdateModularDependencyDelegates() |
ControlRigAsset.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CreateMemberVariablesOnLoad() |
ControlRigAsset.h | ||
FName FindHostMemberVariableUniqueName
(
TSharedPtr< FRigVMNameValidator > InNameValidator, |
ControlRigAsset.h | ||
| ControlRigAsset.h | |||
FControlRigAssetInterfacePtr GetControlRigAssetInterface() |
ControlRigAsset.h | ||
float & GetDebugBoneRadius() |
ControlRigAsset.h | ||
bool & GetExposesAnimatableControls() |
If set to true, this control rig has animatable controls | ControlRigAsset.h | |
TArray< FModuleReferenceData > GetModuleReferenceDataImpl() |
ControlRigAsset.h | ||
| ControlRigAsset.h | |||
| ControlRigAsset.h | |||
| The default skeletal mesh to use when previewing this asset | ControlRigAsset.h | ||
virtual const TSoftObjectPtr< USkeletalMesh > & GetPreviewSkeletalMesh () |
ControlRigAsset.h | ||
TSoftObjectPtr< UObject > & GetSourceCurveImport() |
The skeleton from import into a curve | ControlRigAsset.h | |
TSoftObjectPtr< UObject > & GetSourceHierarchyImport() |
The skeleton from import into a hierarchy | ControlRigAsset.h | |
bool & GetSupportsControls() |
Whether or not this rig has Controls on It | ControlRigAsset.h | |
bool & GetSupportsInversion() |
Whether or not this rig has an Inversion Event | ControlRigAsset.h | |
TObjectPtr< UControlRigValidator > & GetValidator() |
ControlRigAsset.h | ||
virtual void HandleConfigureRigVMController
(
const FRigVMClient* InClient, |
ControlRigAsset.h | ||
void HandleHierarchyComponentKeyChanged
(
const FRigComponentKey& InOldKey, |
ControlRigAsset.h | ||
void HandleHierarchyElementKeyChanged
(
const FRigElementKey& InOldKey, |
ControlRigAsset.h | ||
void HandleHierarchyModified
(
ERigHierarchyNotification InNotification, |
ControlRigAsset.h | ||
virtual void HandlePackageDone() |
ControlRigAsset.h | ||
void HandlePackageDoneSuper() |
ControlRigAsset.h | ||
void HandleRigModulesModified
(
EModularRigNotification InNotification, |
ControlRigAsset.h | ||
void PatchPropagateToChildren() |
ControlRigAsset.h | ||
void PatchRigElementKeyCacheOnLoad() |
ControlRigAsset.h | ||
virtual void PatchVariableNodesOnLoad() |
ControlRigAsset.h | ||
virtual void PathDomainSpecificContentOnLoad() |
ControlRigAsset.h | ||
bool RequiresForceLoadMembersSuper
(
UObject* InObject |
ControlRigAsset.h | ||
bool ResolveConnector
(
const FRigElementKey& DraggedKey, |
ControlRigAsset.h | ||
bool ResolveConnectorToArray
(
const FRigElementKey& DraggedKey, |
ControlRigAsset.h | ||
void SerializeSuper
(
FArchive& Ar |
ControlRigAsset.h | ||
void SetHierarchy
(
TObjectPtr< URigHierarchy > InHierarchy |
ControlRigAsset.h | ||
virtual void SetupDefaultObjectDuringCompilation
(
URigVMHost* InCDO |
ControlRigAsset.h | ||
void UpdateConnectionMapAfterRename
(
const FString& InOldModuleName |
ControlRigAsset.h | ||
void UpdateConnectionMapFromModel() |
ControlRigAsset.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void CommonInitialization
(
const FObjectInitializer& ObjectInitializer |
ControlRigAsset.h | ||
| ControlRigAsset.h | |||
static TArray< FControlRigAssetInterfacePtr > GetCurrentlyOpenRigAssets() |
ControlRigAsset.h | ||
static FControlRigAssetInterfacePtr GetInterfaceOuter
(
const UObject* InObject |
ControlRigAsset.h | ||
static TArray< FSoftObjectPath > GetReferencesToRigModule
(
const FAssetData& InModuleAsset |
ControlRigAsset.h | ||
static EControlRigType GetRigType
(
const FAssetData& InAsset |
ControlRigAsset.h |