1. Epic GamesDeveloper
  3. URigVMGraph

URigVMGraph

The Graph represents a Function definition using Nodes as statements.

API > API/Plugins > API/Plugins/RigVMDeveloper

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.

   
Name URigVMGraph
Type class
Header File /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMGraph.h
Include Path #include "RigVMModel/RigVMGraph.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class URigVMGraph : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

URigVMGraph()

 Default constructor. RigVMModel/RigVMGraph.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bEditable bool   RigVMModel/RigVMGraph.h  
bSectionsEnabled bool   RigVMModel/RigVMGraph.h
  • Transient
DefaultFunctionLibraryPtr TWeakObjectPtr< URigVMGraph >   RigVMModel/RigVMGraph.h  
DetachedLinks TArray< TObjectPtr< URigVMLink > >   RigVMModel/RigVMGraph.h
  • Transient
DiagnosticsAST TSharedPtr< FRigVMParserAST >   RigVMModel/RigVMGraph.h  
ExecuteContextStruct TObjectPtr< UScriptStruct >   RigVMModel/RigVMGraph.h  
LastStructureHash uint32   RigVMModel/RigVMGraph.h  
Links TArray< TObjectPtr< URigVMLink > >   RigVMModel/RigVMGraph.h  
LocalVariables TArray< FRigVMGraphVariableDescription >   RigVMModel/RigVMGraph.h  
ModifiedEvent FRigVMGraphModifiedEvent   RigVMModel/RigVMGraph.h  
Nodes TArray< TObjectPtr< URigVMNode > >   RigVMModel/RigVMGraph.h  
ParameterNames TArray< TSharedPtr< FString > >   RigVMModel/RigVMGraph.h  
RuntimeAST TSharedPtr< FRigVMParserAST >   RigVMModel/RigVMGraph.h  
SchemaClass TSubclassOf< URigVMSchema >   RigVMModel/RigVMGraph.h  
SectionsMatchingTheSelection TArray< FRigVMGraphSection >   RigVMModel/RigVMGraph.h
  • Transient
SelectedNodes TArray< FName >   RigVMModel/RigVMGraph.h  
SelectedSections TArray< FRigVMGraphSection >   RigVMModel/RigVMGraph.h
  • Transient
VariableNames TArray< TSharedPtr< FString > >   RigVMModel/RigVMGraph.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AreSectionsEnabled()

   RigVMModel/RigVMGraph.h  

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

   RigVMModel/RigVMGraph.h  

void ClearAST ( bool bClearDiagnostics,
bool bClearRuntime
)

   RigVMModel/RigVMGraph.h  

bool ContainsLink ( const FString& InPinPathRepresentation
) const

 Returns true if the graph contains a link given its string representation. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

URigVMLink * FindLink ( const FString& InLinkPinPathRepresentation
) const

 Returns a link given its string representation, for example "NodeA.Color.R -> NodeB.Translation.X" RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

URigVMNode * FindNode ( const FString& InNodePath
) const

 Returns a Node given its path (or nullptr). RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

URigVMNode * FindNodeByName ( const FName& InNodeName
) const

 Returns a Node given its name (or nullptr). RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

URigVMPin * FindPin ( const FString& InPinPath
) const

 Returns a Pin given its path, for example "Node.Color.R". RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

TArray< URigVMGraph * > GetContainedGraphs ( bool bRecursive
) const

 Returns all of the contained graphs. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

virtual URigVMFunctionLibrary * GetDefaultFunctionLibrary()

 Returns the locally available function library. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

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

   RigVMModel/RigVMGraph.h  

URigVMFunctionEntryNode * GetEntryNode()

 Returns the entry node of this graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

TArray< FName > GetEventNames()

 Returns array of event names. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

UScriptStruct * GetExecuteContextStruct()

   RigVMModel/RigVMGraph.h  

TArray< FRigVMExternalVariable > GetExternalVariables()

   RigVMModel/RigVMGraph.h  

int32 GetGraphDepth()

 Returns the root / top level parent graph of this graph (or this if it is the root graph) RigVMModel/RigVMGraph.h
  • BlueprintPure
  • Category=RigVMGraph

FString GetGraphName()

 Returns the name of this graph (as defined by the node path) RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

TArray< FRigVMGraphVariableDescription > GetInputArguments()

 Returns the input arguments of this graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

const TArray< URigVMLink * > & GetLinks()

 Returns all of the Links within this Graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

TArray< FRigVMGraphVariableDescription > GetLocalVariables ( bool bIncludeInputArguments
) const

 Returns the local variables of this function. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

TArray< FRigVMGraphSection > GetMatchingSections ( const FRigVMGraphSection& InSection
) const

   RigVMModel/RigVMGraph.h  

virtual FString GetNodePath()

 Returns the path of this graph as defined by its invoking nodes. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

const TArray< URigVMNode * > & GetNodes()

 Returns all of the Nodes within this Graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

TArray< FRigVMGraphVariableDescription > GetOutputArguments()

 Returns the output arguments of this graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

URigVMGraph * GetParentGraph()

 Returns the parent graph of this graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

URigVMFunctionReturnNode * GetReturnNode()

 Returns the return node of this graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

URigVMGraph * GetRootGraph()

 Returns the root / top level parent graph of this graph (or this if it is the root graph) RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

TSharedPtr< FRigVMParserAST > GetRuntimeAST ( const FRigVMParserASTSettings& InSettings,
bool bForceRefresh
)

   RigVMModel/RigVMGraph.h  

URigVMSchema * GetSchema()

 Returns the schema used by this graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

TSubclassOf< URigVMSchema > GetSchemaClass()

 Returns the schema class used by this graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

const TArray< FRigVMGraphSection > & GetSectionsMatchingTheSelection()

   RigVMModel/RigVMGraph.h  

const TArray< FRigVMGraphSection > & GetSelectedSections()

   RigVMModel/RigVMGraph.h  

const TArray< FName > & GetSelectNodes()

 Returns the names of all currently selected Nodes. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

uint32 GetSerializedStructureHash()

   RigVMModel/RigVMGraph.h  

virtual uint32 GetStructureHash()

   RigVMModel/RigVMGraph.h  
Returns a list of unique Variable descriptions within this Graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

bool IsNodeHighlighted ( const FName& InNodeName
) const

 Returns true if a node matches the currently selected subset. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

bool IsNodeSelected ( const FName& InNodeName
) const

 Returns true if a Node with a given name is selected. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

bool IsRootGraph()

 Returns true if this graph is a root / top level graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

bool IsTopLevelGraph()

 Returns true if this graph is the top level graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

FRigVMGraphModifiedEvent & OnModified()

 Returns the modified event, which can be used to subscribe to changes happening within the Graph. RigVMModel/RigVMGraph.h  

void PrepareCycleChecking ( URigVMPin* InPin,
bool bAsInput
)

   RigVMModel/RigVMGraph.h  

void SetDefaultFunctionLibrary ( URigVMFunctionLibrary* InFunctionLibrary
)

   RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

void SetExecuteContextStruct ( UScriptStruct* InExecuteContextStruct
)

 Sets the execute context struct type to use. RigVMModel/RigVMGraph.h  

void SetSchemaClass ( TSubclassOf< URigVMSchema > InSchemaClass
)

 Sets the schema class on the graph. RigVMModel/RigVMGraph.h
  • BlueprintCallable
  • Category=RigVMGraph

void UpdateSections ( bool bForce
)

   RigVMModel/RigVMGraph.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   RigVMModel/RigVMGraph.h  

virtual void PreSave ( FObjectPreSaveContext SaveContext
)

   RigVMModel/RigVMGraph.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page