1. Epic GamesDeveloper
  3. IRigVMClientHost

IRigVMClientHost

Interface that allows an object to host a rig VM client. Used by graph edting code to interact with the controller.

API > API/Plugins > API/Plugins/RigVMDeveloper > API/Plugins/RigVMDeveloper/RigVMModel

Inheritance Hierarchy

References

   
Module RigVMDeveloper
Header /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMClient.h
Include #include "RigVMModel/RigVMClient.h"

Syntax

class IRigVMClientHost

Remarks

Interface that allows an object to host a rig VM client. Used by graph edting code to interact with the controller.

Functions

  Type Name Description
Public function URigVMGraph *

AddModel ( FString InName,
bool bSetupUndoRedo,
bool bPrintPythonCommand
)

  
Public function void Helper to decrease recompile bracket on nested requests. When value == 1, if autorecompile is enabled, it triggers a VM recompilation.
Public function TArray< FString >

GeneratePythonCommands ( const FString InNewBlueprintName
)

  
Public function Const TArray< URigVMGraph * >  
Public function Const bool Returns current state of automatic recompile flag.
Public function Const URigVMController *

GetController ( const UEdGraph* InEdGraph
)

  
Public function Const URigVMController *

GetController ( const URigVMGraph* InGraph
)

  
Public function Const URigVMController *

GetControllerByName ( const FString InGraphName
)

  
Public function Const URigVMGraph *  
Public function Const UObject * Returns the editor object corresponding with the supplied RigVM graph.
Public function Const URigVMGraph *  
Public function Const URigVMFunctionLibrary *  
Public function Const URigVMGraph *

GetModel ( const UEdGraph* InEdGraph
)

  
Public function Const URigVMGraph *

GetModel ( const FString& InNodePath
)

  
Public function URigVMController *  
Public function URigVMController *

GetOrCreateController ( const UEdGraph* InGraph
)

  
Public function FRigVMClient * Returns the rigvm client for this host.
Public function Const const FRigVMClient * Returns the rigvm client for this host.
Public function Const URigVMGraph *

GetRigVMGraphForEditorObject ( UObject* InObject
)

 Returns the RigVM graph corresponding with the supplied editor object.
Public function Const const IRigVMGraphFunctionHost * Returns the rigvm function host.
Public function IRigVMGraphFunctionHost * Returns the rigvm function host.
Public function void

HandleConfigureRigVMController ( const FRigVMClient* InClient,
URigVMController* InControllerToConfigure
)

 Reacts to a request to configure a controller.
Public function void

HandleRigVMGraphAdded ( const FRigVMClient* InClient,
const FString& InNodePathOrName
)

 Reacts to adding a graph.
Public function void

HandleRigVMGraphRemoved ( const FRigVMClient* InClient,
const FString& InNodePathOrName
)

 Reacts to removing a graph.
Public function void

HandleRigVMGraphRenamed ( const FRigVMClient* InClient,
const FString& InOldNodePath,
const FString& InNewNodePath
)

 Reacts to renaming a graph.
Public function void Helper to increase recompile bracket on nested requests.
Public function Const const FRigVMGetFocusedGraph &  
Public function FRigVMGetFocusedGraph &  
Public function void  
Public function void Recompiles the VM if not already being compiled.
Public function void Recompiles VM if flagged for recompiling is set.
Public function void Regenerates model pins if data has changed while the RigVM Graph is not opened (i.e. user defined struct is changed)
Public function bool

RemoveModel ( FString InName,
bool bSetupUndoRedo,
bool bPrintPythonCommand
)

  
Public function void Flags VM requires recompile, and if auto recompile is enabled and no compile bracket is active, requests a recompilation.
Public function void  
Public function Virtual Const UObject *

ResolveUserDefinedTypeById ( const FString& InTypeName
)

 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.
Public function void

SetAutoVMRecompile ( bool bAutoRecompile
)

 Sets flag for automatic recompile on model changes.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page