1. Epic GamesDeveloper
  3. UModularRigController

UModularRigController

API > API/Plugins > API/Plugins/ControlRig

   
Name UModularRigController
Type class
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/ModularRigController.h
Include Path #include "ModularRigController.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UModularRigController : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UModularRigController ( const FObjectInitializer& ObjectInitializer
)

   ModularRigController.h  
  ModularRigController.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bSuspendNotifications bool   ModularRigController.h  
Model FModularRigModel *   ModularRigController.h  
ModifiedEvent FModularRigModifiedEvent   ModularRigController.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bAutomaticReparenting bool   ModularRigController.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FName AddModule ( const FName& InModuleName,
TSubclassOf< UControlRig > InClass,
const FName& InParentModuleName,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool AddTargetToArrayConnector ( const FRigElementKey& InConnectorKey,
const FRigElementKey& InTargetKey,
bool bSetupUndo,
bool bAutoResolveOtherConnectors,
bool bCheckValidConnection
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool AutoConnectModules ( const TArray< FName >& InModuleNames,
bool bReplaceExistingConnections,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool AutoConnectSecondaryConnectors ( const TArray< FRigElementKey >& InConnectorKeys,
bool bReplaceExistingConnections,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool BindModuleVariable ( const FName& InModuleName,
const FName& InVariableName,
const FString& InSourcePath,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool CanBindModuleVariable ( const FName& InModuleName,
const FName& InVariableName,
const FString& InSourcePath,
FText& OutErrorMessage
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool CanConnectConnectorToElement ( const FRigElementKey& InConnectorKey,
const FRigElementKey& InTargetKey,
FText& OutErrorMessage
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool CanConnectConnectorToElements ( const FRigElementKey& InConnectorKey,
const TArray< FRigElementKey >& InTargetKeys,
FText& OutErrorMessage
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool CanRenameModule ( const FName& InModuleName,
const FName& InNewName,
FText& OutErrorMessage
) const

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool ConnectConnectorToElement ( const FRigElementKey& InConnectorKey,
const FRigElementKey& InTargetKey,
bool bSetupUndo,
bool bAutoResolveOtherConnectors,
bool bCheckValidConnection
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool ConnectConnectorToElements ( const FRigElementKey& InConnectorKey,
const TArray< FRigElementKey >& InTargetKeys,
bool bSetupUndo,
bool bAutoResolveOtherConnectors,
bool bCheckValidConnection
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool DeleteModule ( const FName& InModuleName,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool DeselectModule ( const FName& InModuleName
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool DisconnectConnector ( const FRigElementKey& InConnectorKey,
bool bDisconnectSubModules,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool DisconnectConnector_Internal ( const FRigElementKey& InConnectorKey,
bool bDisconnectSubModules,
TMap< FRigElementKey, TArray< FRigElementKey > >* OutRemovedConnections,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

TArray< FRigElementKey > DisconnectCyclicConnectors ( bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

FString ExportModuleSettingsToString ( TArray< FName > InModuleNames
) const

   ModularRigController.h
  • BlueprintPure
  • Category="ControlRig | Modules"

const FRigModuleReference * FindModule ( const FName& InModuleName
) const

   ModularRigController.h  

FRigModuleReference * FindModule ( const FName& InModuleName
)

   ModularRigController.h  

TArray< FName > GetAllModules()

   ModularRigController.h
  • BlueprintPure
  • Category="ControlRig | Modules"

TArray< FRigElementKey > GetConnectorsForModule ( FName InModuleName
) const

   ModularRigController.h
  • BlueprintPure
  • Category="ControlRig | Modules"

FRigModuleReference GetModuleReference ( FName InModuleName
) const

   ModularRigController.h
  • BlueprintPure
  • Category="ControlRig | Modules"

TArray< FString > GetPossibleBindings ( const FName& InModuleName,
const FName& InVariableName
)

   ModularRigController.h  

FRigName GetSafeNewName ( const FRigName& InDesiredName,
const FRigModuleReference* InModuleToSkip
) const

   ModularRigController.h  

TArray< FName > GetSelectedModules()

   ModularRigController.h
  • BlueprintPure
  • Category="ControlRig | Modules"

bool ImportModuleSettingsFromString ( FString InContent,
TArray< FName > InOptionalModuleNames,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool IsNameAvailable ( const FRigName& InDesiredName,
FString* OutErrorMessage,
const FRigModuleReference* InModuleToSkip
) const

   ModularRigController.h  

FName MirrorModule ( const FName& InModuleName,
const FRigVMMirrorSettings& InSettings,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

FModularRigModifiedEvent & OnModified()

   ModularRigController.h  

void RefreshModuleVariables ( bool bSetupUndo
)

   ModularRigController.h  

void RefreshModuleVariables ( const FRigModuleReference* InModule,
bool bSetupUndo
)

   ModularRigController.h  

FName RenameModule ( const FName& InModuleName,
const FName& InNewName,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool ReparentModule ( const FName& InModuleName,
const FName& InNewParentModuleName,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool ResetConfigValueInModule ( const FName& InModuleName,
const FString& InPath,
bool bClearOverride,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool SelectModule ( const FName& InModuleName,
const bool InSelected
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool SetConfigValueInModule ( const FName& InModuleName,
const FName& InVariableName,
const FString& InValue,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool SetConfigValueInModule ( const FName& InModuleName,
const FControlRigOverrideValue& InValue,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="Control Rig | Modules"

bool SetModuleSelection ( const TArray< FName >& InModuleNames
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool SwapModuleClass ( const FName& InModuleName,
TSubclassOf< UControlRig > InNewClass,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool SwapModulesOfClass ( TSubclassOf< UControlRig > InOldClass,
TSubclassOf< UControlRig > InNewClass,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

bool UnBindModuleVariable ( const FName& InModuleName,
const FName& InVariableName,
bool bSetupUndo
)

   ModularRigController.h
  • BlueprintCallable
  • Category="ControlRig | Modules"

Static

Name Remarks Include Path Unreal Specifiers

static int32 GetMaxNameLength()

   ModularRigController.h  

static FRigName GetSanitizedName ( const FRigName& InName,
bool bAllowNameSpaces
)

   ModularRigController.h  

static void SanitizeName ( FRigName& InOutName,
bool bAllowNameSpaces
)

   ModularRigController.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page