unreal.RigVMGraph

class unreal.RigVMGraph(outer=None, name='None')

Bases: unreal.Object

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.

C++ Source:

  • Module: RigVMDeveloper

  • File: RigVMGraph.h

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

Parameters

link_pin_path_representation (str) –

Return type

RigVMLink

find_node(node_path) RigVMNode

Returns a Node given its path (or nullptr). (for now this is the same as finding a node by its name.)

Parameters

node_path (str) –

Return type

RigVMNode

find_node_by_name(node_name) RigVMNode

Returns a Node given its name (or nullptr).

Parameters

node_name (Name) –

Return type

RigVMNode

find_pin(pin_path) RigVMPin

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

Parameters

pin_path (str) –

Return type

RigVMPin

get_contained_graphs(recursive=False)

Returns all of the contained graphs

Parameters

recursive (bool) –

Return type

Array(RigVMGraph)

get_default_function_library() RigVMFunctionLibrary

Returns the locally available function library

Return type

RigVMFunctionLibrary

get_entry_node() RigVMFunctionEntryNode

Returns the entry node of this graph

Return type

RigVMFunctionEntryNode

get_graph_name() str

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

Return type

str

get_input_arguments()

Returns the input arguments of this graph

Return type

Array(RigVMGraphVariableDescription)

Returns all of the Links within this Graph.

Return type

Array(RigVMLink)

get_local_variables(include_input_arguments=False)

Returns the local variables of this function

Parameters

include_input_arguments (bool) –

Return type

Array(RigVMGraphVariableDescription)

get_node_path() str

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

Return type

str

get_nodes()

Returns all of the Nodes within this Graph.

Return type

Array(RigVMNode)

get_output_arguments()

Returns the output arguments of this graph

Return type

Array(RigVMGraphVariableDescription)

get_parameter_descriptions()

Returns a list of unique Parameter descriptions within this Graph. Multiple Parameter Nodes can share the same description.

Return type

Array(RigVMGraphParameterDescription)

get_parent_graph() RigVMGraph

Returns the parent graph of this graph

Return type

RigVMGraph

get_return_node() RigVMFunctionReturnNode

Returns the return node of this graph

Return type

RigVMFunctionReturnNode

get_root_graph() RigVMGraph

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

Return type

RigVMGraph

get_select_nodes()

Returns the names of all currently selected Nodes.

Return type

Array(Name)

get_variable_descriptions()

Returns a list of unique Variable descriptions within this Graph. Multiple Variable Nodes can share the same description.

Return type

Array(RigVMGraphVariableDescription)

is_node_selected(node_name) bool

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

Parameters

node_name (Name) –

Return type

bool

is_root_graph() bool

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

Return type

bool

is_top_level_graph() bool

Returns true if this graph is the top level graph

Return type

bool

set_default_function_library(function_library) None

Set Default Function Library

Parameters

function_library (RigVMFunctionLibrary) –