1. Epic GamesDeveloper
  3. UModularRig

UModularRig

Runs logic for mapping input data to transforms (the "Rig")

API > API/Plugins > API/Plugins/ControlRig

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable, Abstract, EditInlineNew)  
class UModularRig : public UControlRig

Remarks

Runs logic for mapping input data to transforms (the "Rig")

Variables

  Type Name Description
Public variable UProperty TArray< FRigModuleExecutionElement > ExecutionQueue  
Public variable UProperty int32 ExecutionQueueFront  
Public variable UProperty FModularRigModel ModularRigModel  
Public variable UProperty FModularRigSettings ModularRigSettings  
Public variable UProperty TArray< FRigModuleInstance > Modules  
Public variable UProperty TArray< FRigModuleInstance * > RootModules  
Public variable TArray< FName > SupportedEvents  

Constructors

  Type Name Description
Public function  

UModularRig ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

ExecuteConnectorEvent ( const FRigElementKey& InConnector,
const FRigModuleInstance* InModuleInstance,
const FRigElementKeyRedirector* InRedirector,
TArray< FRigElementResolveResult >& InOutCandidates
)

  
Public function void  
Public function Const const FRigModuleInstance *

FindModule ( const FRigBaseElement* InElement
)

  
Public function Const const FRigModuleInstance *

FindModule ( const FRigElementKey& InElementKey
)

  
Public function Const const FRigModuleInstance *

FindModule ( const UControlRig* InModuleInstance
)

  
Public function Const const FRigModuleInstance *

FindModule ( const FString& InPath
)

  
Public function Const void

ForEachModule ( TFunctionRef< bool(const FRigModuleInstance*)> PerModuleFunction
)

  
Public function void

ForEachModule ( TFunctionRef< bool(FRigModuleInstance*)> PerModuleFunction
)

  
Public function Const FModuleInstanceHandle

GetHandle ( const FString& InPath
)

 Returns a handle to an existing module
Public function Const const FModularRigModel &  
Public function Const const FModularRigSettings & Returns the settings of the modular rig.
Public function Const FString

GetParentPath ( const FString& InPath
)

  
Public function Const FString

GetShortestDisplayPathForElement ( const FRigElementKey& InElementKey,
bool bAlwaysShowNameSpace
)

  
Public function void

OnObjectsReplaced ( const TMap< UObject*, UObject* >& OldToNewInstanceMap
)

  
Public function Virtual void  
Public function void  
Public function void

ResetModules ( bool bDestroyModuleRigs
)

  
Public function void  
Public function void  
Public function Const void  

Overridden from UControlRig

  Type Name Description
Public function Virtual Const FRigElementKeyRedirector  
Public function Virtual FRigElementKeyRedirector & Returns the redirector from key to key for this rig.
Public function Virtual bool

InitializeVMs ( const FName& InEventName
)

  
Public function Virtual void

InitializeVMs ( bool bRequestInit
)

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

Overridden from URigVMHost

  Type Name Description
Public function Virtual void BEGIN UObject.
Public function Virtual void Evaluates the ControlRig
Public function Virtual bool

Execute_Internal ( const FName& InEventName
)

 ExecuteUnits
Public function Virtual Const const TArray< FName > &  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void BEGIN ControlRig.
Public function Virtual Const bool

SupportsEvent ( const FName& InEventName
)

  

Constants

Name Description
NamespaceSeparator  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page