URigVMGraph

The Graph represents a Function definition using Nodes as statements.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

RigVMDeveloper

Header

/Engine/Source/Developer/RigVMDeveloper/Public/RigVMModel/RigVMGraph.h

Include

#include "RigVMModel/RigVMGraph.h"

Syntax

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

Name Description

Public function

URigVMGraph()

Default constructor.

Functions

Name Description

Public function Virtual

bool

 

CanLink

(
    URigVMPin* InSourcePin,
    URigVMPin* InTargetPin,
    FString* OutFailureReason,
    const FRigVMByteCode* InByteCo...
)

Public function

void

 

ClearAST

(
    bool bClearDiagnostics,
    bool bClearRuntime
)

Public function Const

URigVMLink &...

 

FindLink

(
    const FString& InLinkPinPathRepres...
)

Returns a link given its string representation, for example "NodeA.Color.R -> NodeB.Translation.X"

Public function Const

URigVMNode &...

 

FindNode

(
    const FString& InNodePath
)

Returns a Node given its path (or nullptr).

Public function Const

URigVMNode &...

 

FindNodeByName

(
    const FName& InNodeName
)

Returns a Node given its name (or nullptr).

Public function Const

URigVMPin &#...

 

FindPin

(
    const FString& InPinPath
)

Returns a Pin given its path, for example "Node.Color.R".

Public function Const

TArray< URig...

 

GetContainedGraphs

(
    bool bRecursive
)

Returns all of the contained graphs.

Public function Virtual Const

URigVMFuncti...

 

GetDefaultFunctionLibrary()

Returns the locally available function library.

Public function

TSharedPtr< ...

 

GetDiagnosticsAST

(
    bool bForceRefresh,
    TArray< URigVMLink* > InLinksT...
)

Public function Const

URigVMFuncti...

 

GetEntryNode()

Returns the entry node of this graph.

Public function Const

TArray< FRig...

 

GetExternalVariables()

Public function Const

FString

 

GetGraphName()

Returns the name of this graph (as defined by the node path)

Public function Const

TArray< FRig...

 

GetInputArguments()

Returns the input arguments of this graph.

Public function Const

const TArray...

 

GetLinks()

Returns all of the Links within this Graph.

Public function Const

TArray< FRig...

 

GetLocalVariables

(
    bool bIncludeInputArguments
)

Returns the local variables of this function.

Public function Virtual Const

FString

 

GetNodePath()

Returns the path of this graph as defined by its invoking nodes.

Public function Const

const TArray...

 

GetNodes()

Returns all of the Nodes within this Graph.

Public function Const

TArray< FRig...

 

GetParameterDescriptions()

Returns a list of unique Parameter descriptions within this Graph.

Public function Const

URigVMGraph ...

 

GetParentGraph()

Returns the parent graph of this graph.

Public function Const

URigVMFuncti...

 

GetReturnNode()

Returns the return node of this graph.

Public function Const

URigVMGraph ...

 

GetRootGraph()

Returns the root / top level parent graph of this graph (or this if it is the root graph)

Public function

TSharedPtr< ...

 

GetRuntimeAST

(
    const FRigVMParserASTSettings& InS...,
    bool bForceRefresh
)

Public function Const

const TArray...

 

GetSelectNodes()

Returns the names of all currently selected Nodes.

Public function Const

TArray< FRig...

 

GetVariableDescriptions()

Returns a list of unique Variable descriptions within this Graph.

Public function Const

bool

 

IsNodeSelected

(
    const FName& InNodeName
)

Returns true if a Node with a given name is selected.

Public function Const

bool

 

IsRootGraph()

Returns true if this graph is a root / top level graph.

Public function Const

bool

 

IsTopLevelGraph()

Returns true if this graph is the top level graph.

Public function

FRigVMGraphM...

 

OnModified()

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

void

 

SetDefaultFunctionLibrary

(
    URigVMFunctionLibrary* InFunct...
)