Navigation
API > API/Plugins > API/Plugins/RigVMDeveloper
Interface that allows an object to host a rig VM client. Used by graph edting code to interact with the controller.
| Name | IRigVMClientHost |
| Type | class |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMClient.h |
| Include Path | #include "RigVMModel/RigVMClient.h" |
Syntax
class IRigVMClientHost
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URigVMGraph * AddModel
(
FString InName, |
RigVMModel/RigVMClient.h | ||
void DecrementVMRecompileBracket() |
Helper to decrease recompile bracket on nested requests. When value == 1, if autorecompile is enabled, it triggers a VM recompilation. | RigVMModel/RigVMClient.h | |
| RigVMModel/RigVMClient.h | |||
TArray< URigVMGraph * > GetAllModels() |
RigVMModel/RigVMClient.h | ||
FString GetAssetName() |
Returns the expected schema class to use for this blueprint | RigVMModel/RigVMClient.h | |
bool GetAutoVMRecompile() |
Returns current state of automatic recompile flag. | RigVMModel/RigVMClient.h | |
URigVMController * GetController
(
const UEdGraph* InEdGraph |
RigVMModel/RigVMClient.h | ||
URigVMController * GetController
(
const URigVMGraph* InGraph |
RigVMModel/RigVMClient.h | ||
URigVMController * GetControllerByName
(
const FString InGraphName |
RigVMModel/RigVMClient.h | ||
URigVMGraph * GetDefaultModel() |
RigVMModel/RigVMClient.h | ||
UObject * GetEditorObjectForRigVMGraph
(
const URigVMGraph* InVMGraph |
Returns the editor object corresponding with the supplied RigVM graph. | RigVMModel/RigVMClient.h | |
URigVMGraph * GetFocusedModel() |
RigVMModel/RigVMClient.h | ||
URigVMFunctionLibrary * GetLocalFunctionLibrary() |
RigVMModel/RigVMClient.h | ||
URigVMGraph * GetModel
(
const UEdGraph* InEdGraph |
RigVMModel/RigVMClient.h | ||
URigVMGraph * GetModel
(
const FString& InNodePath |
RigVMModel/RigVMClient.h | ||
URigVMController * GetOrCreateController
(
URigVMGraph* InGraph |
RigVMModel/RigVMClient.h | ||
URigVMController * GetOrCreateController
(
const UEdGraph* InGraph |
RigVMModel/RigVMClient.h | ||
URigVMFunctionLibrary * GetOrCreateLocalFunctionLibrary
(
bool bSetupUndoRedo |
RigVMModel/RigVMClient.h | ||
| Returns the rigvm client for this host. | RigVMModel/RigVMClient.h | ||
const FRigVMClient * GetRigVMClient () |
Returns the rigvm client for this host. | RigVMModel/RigVMClient.h | |
UClass * GetRigVMEdGraphClass() |
Returns the expected ed graph class to use for this blueprint | RigVMModel/RigVMClient.h | |
UClass * GetRigVMEdGraphNodeClass() |
Returns the expected ed graph node class to use for this blueprint | RigVMModel/RigVMClient.h | |
UClass * GetRigVMEdGraphSchemaClass() |
Returns the expected ed graph schema class to use for this blueprint | RigVMModel/RigVMClient.h | |
UClass * GetRigVMEditorSettingsClass() |
Returns the class of the settings to use | RigVMModel/RigVMClient.h | |
UScriptStruct * GetRigVMExecuteContextStruct() |
Returns the expected execute context struct to use for this blueprint | RigVMModel/RigVMClient.h | |
URigVMGraph * GetRigVMGraphForEditorObject
(
UObject* InObject |
Returns the RigVM graph corresponding with the supplied editor object. | RigVMModel/RigVMClient.h | |
| Returns the rigvm function host. | RigVMModel/RigVMClient.h | ||
| Returns the rigvm function host. | RigVMModel/RigVMClient.h | ||
UClass * GetRigVMSchemaClass() |
Returns the expected schema class to use for this blueprint | RigVMModel/RigVMClient.h | |
void HandleConfigureRigVMController
(
const FRigVMClient* InClient, |
Reacts to a request to configure a controller. | RigVMModel/RigVMClient.h | |
void HandleRigVMGraphAdded
(
const FRigVMClient* InClient, |
Reacts to adding a graph. | RigVMModel/RigVMClient.h | |
void HandleRigVMGraphRemoved
(
const FRigVMClient* InClient, |
Reacts to removing a graph. | RigVMModel/RigVMClient.h | |
void HandleRigVMGraphRenamed
(
const FRigVMClient* InClient, |
Reacts to renaming a graph. | RigVMModel/RigVMClient.h | |
void IncrementVMRecompileBracket() |
Helper to increase recompile bracket on nested requests. | RigVMModel/RigVMClient.h | |
bool IsFunctionPublic
(
const FName& InFunctionName |
RigVMModel/RigVMClient.h | ||
void MarkFunctionPublic
(
const FName& InFunctionName, |
RigVMModel/RigVMClient.h | ||
FRigVMGetFocusedGraph & OnGetFocusedGraph () |
RigVMModel/RigVMClient.h | ||
const FRigVMGetFocusedGraph & OnGetFocusedGraph () |
RigVMModel/RigVMClient.h | ||
FRigVMGraphModifiedEvent & OnModified() |
RigVMModel/RigVMClient.h | ||
void OnRigVMRegistryChanged() |
RigVMModel/RigVMClient.h | ||
void RecompileVM() |
Recompiles the VM if not already being compiled. | RigVMModel/RigVMClient.h | |
void RecompileVMIfRequired() |
Recompiles VM if flagged for recompiling is set. | RigVMModel/RigVMClient.h | |
void RefreshAllModels
(
ERigVMLoadType InLoadType |
Regenerates model pins if data has changed while the RigVM Graph is not opened (i.e. user defined struct is changed) | RigVMModel/RigVMClient.h | |
bool RemoveModel
(
FString InName, |
RigVMModel/RigVMClient.h | ||
| RigVMModel/RigVMClient.h | |||
void RequestAutoVMRecompilation() |
Flags VM requires recompile, and if auto recompile is enabled and no compile bracket is active, requests a recompilation. | RigVMModel/RigVMClient.h | |
void RequestRigVMInit() |
RigVMModel/RigVMClient.h | ||
| Given a type name for a user-defined type, either struct or an enum, returns a pointer to the object definition or nullptr if the client host has no knowledge of such a type. | RigVMModel/RigVMClient.h | ||
void SetAutoVMRecompile
(
bool bAutoRecompile |
Sets flag for automatic recompile on model changes. | RigVMModel/RigVMClient.h | |
void SetupPinRedirectorsForBackwardsCompatibility() |
RigVMModel/RigVMClient.h |