1. Epic GamesDeveloper
  3. URigVMGraph

URigVMGraph

The Graph represents a Function definition using Nodes as statements.

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

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType&41;  
class URigVMGraph : public UObject

Remarks

The Graph represents a Function definition using Nodes as statements. Graphs can be compiled into a URigVM using the FRigVMCompiler. Graphs provide access to its Nodes, Pins and Links.

Constructors

  Type Name Description
Public function   Default constructor.

Functions

  Type Name Description
Public function Virtual bool

CanLink ( URigVMPin* InSourcePin,
URigVMPin* InTargetPin,
FString* OutFailureReason,
const FRigVMByteCode* InByteCode,
ERigVMPinDirection InUserLinkDirection,
bool bEnableTypeCasting
)

  
Public function void

ClearAST ( bool bClearDiagnostics,
bool bClearRuntime
)

  
Public function Const UFunction BlueprintCallable, Category bool

ContainsLink ( const FString& InPinPathRepresentation
)

 Returns true if the graph contains a link given its string representation.
Public function Const UFunction BlueprintCallable, Category URigVMLink *

FindLink ( const FString& InLinkPinPathRepresentation
)

 Returns a link given its string representation, for example "NodeA.Color.R -> NodeB.Translation.X"
Public function Const UFunction BlueprintCallable, Category URigVMNode *

FindNode ( const FString& InNodePath
)

 Returns a Node given its path (or nullptr).
Public function Const UFunction BlueprintCallable, Category URigVMNode *

FindNodeByName ( const FName& InNodeName
)

 Returns a Node given its name (or nullptr).
Public function Const UFunction BlueprintCallable, Category URigVMPin *

FindPin ( const FString& InPinPath
)

 Returns a Pin given its path, for example "Node.Color.R".
Public function Const UFunction BlueprintCallable, Category TArray< URigVMGraph * >

GetContainedGraphs ( bool bRecursive
)

 Returns all of the contained graphs.
Public function Virtual Const UFunction BlueprintCallable, Category URigVMFunctionLibrary * Returns the locally available function library.
Public function TSharedPtr< FRigVMParserAST >

GetDiagnosticsAST ( bool bForceRefresh,
TArray< URigVMLink* > InLinksToSkip
)

  
Public function Const UFunction BlueprintCallable, Category URigVMFunctionEntryNode * Returns the entry node of this graph.
Public function Const UFunction BlueprintCallable, Category TArray< FName > Returns array of event names.
Public function Const UScriptStruct *  
Public function Const TArray< FRigVMExternalVariable >  
Public function Const UFunction BlueprintPure, Category int32 Returns the root / top level parent graph of this graph (or this if it is the root graph)
Public function Const UFunction BlueprintCallable, Category FString Returns the name of this graph (as defined by the node path)
Public function Const UFunction BlueprintCallable, Category TArray< FRigVMGraphVariableDescription > Returns the input arguments of this graph.
Public function Const UFunction BlueprintCallable, Category const TArray< URigVMLink * > & Returns all of the Links within this Graph.
Public function Const UFunction BlueprintCallable, Category TArray< FRigVMGraphVariableDescription >

GetLocalVariables ( bool bIncludeInputArguments
)

 Returns the local variables of this function.
Public function Virtual Const UFunction BlueprintCallable, Category FString Returns the path of this graph as defined by its invoking nodes.
Public function Const UFunction BlueprintCallable, Category const TArray< URigVMNode * > & Returns all of the Nodes within this Graph.
Public function Const UFunction BlueprintCallable, Category TArray< FRigVMGraphVariableDescription > Returns the output arguments of this graph.
Public function Const UFunction BlueprintCallable, Category URigVMGraph * Returns the parent graph of this graph.
Public function Const UFunction BlueprintCallable, Category URigVMFunctionReturnNode * Returns the return node of this graph.
Public function Const UFunction BlueprintCallable, Category URigVMGraph * Returns the root / top level parent graph of this graph (or this if it is the root graph)
Public function TSharedPtr< FRigVMParserAST >

GetRuntimeAST ( const FRigVMParserASTSettings& InSettings,
bool bForceRefresh
)

  
Public function Const UFunction BlueprintCallable, Category const TArray< FName > & Returns the names of all currently selected Nodes.
Public function Const uint32  
Public function Virtual Const uint32  
Public function Const UFunction BlueprintCallable, Category TArray< FRigVMGraphVariableDescription > Returns a list of unique Variable descriptions within this Graph.
Public function Const UFunction BlueprintCallable, Category bool

IsNodeSelected ( const FName& InNodeName
)

 Returns true if a Node with a given name is selected.
Public function Const UFunction BlueprintCallable, Category bool Returns true if this graph is a root / top level graph.
Public function Const UFunction BlueprintCallable, Category bool Returns true if this graph is the top level graph.
Public function FRigVMGraphModifiedEvent & Returns the modified event, which can be used to subscribe to changes happening within the Graph.
Public function void

PrepareCycleChecking ( URigVMPin* InPin,
bool bAsInput
)

  
Public function UFunction BlueprintCallable, Category void  
Public function void

SetExecuteContextStruct ( UScriptStruct* InExecuteContextStruct
)

 Sets the execute context struct type to use.

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page