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

find_link(link_pin_path_representation) → RigVMLink

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

Parameters

link_pin_path_representation (str) –

Returns

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) –

Returns

Return type

RigVMNode

find_node_by_name(node_name) → RigVMNode

Returns a Node given its name (or nullptr).

Parameters

node_name (Name) –

Returns

Return type

RigVMNode

find_pin(pin_path) → RigVMPin

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

Parameters

pin_path (str) –

Returns

Return type

RigVMPin

get_links()

Returns all of the Links within this Graph.

Returns

Return type

Array(RigVMLink)

get_nodes()

Returns all of the Nodes within this Graph.

Returns

Return type

Array(RigVMNode)

get_parameter_descriptions()

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

Returns

Return type

Array(RigVMGraphParameterDescription)

get_select_nodes()

Returns the names of all currently selected Nodes.

Returns

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.

Returns

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) –

Returns

Return type

bool