unreal.RigVMLink

class unreal.RigVMLink(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

The Link represents a connection between two Pins within a Graph. The Link can be accessed on the Graph itself - or through the URigVMPin::GetLinks() method.

C++ Source:

• Plugin: RigVM

• Module: RigVMDeveloper

• File: RigVMLink.h

get_graph() → RigVMGraph

Returns the Link’s owning Graph/

Return type:

RigVMGraph

get_graph_depth() → int32

Returns the graph nesting depth of this link

Return type:

int32

get_link_index() → int32

Returns the current index of this Link within its owning Graph.

Return type:

int32

get_opposite_pin(pin) → RigVMPin

Returns the opposite Pin of this Link given one of its edges (or nullptr)

Parameters:

pin (RigVMPin)

Return type:

RigVMPin

get_pin_path_representation() → str

Returns a string representation of the Link, for example: “NodeA.Color.R -> NodeB.Translation.X” note: can be split again using SplitPinPathRepresentation

Return type:

str

get_source_node() → RigVMNode

Returns the source Node of this Link (or nullptr)

Return type:

RigVMNode

get_source_pin() → RigVMPin

Returns the source Pin of this Link (or nullptr)

Return type:

RigVMPin

get_target_node() → RigVMNode

Returns the target Node of this Link (or nullptr)

Return type:

RigVMNode

get_target_pin() → RigVMPin

Returns the target Pin of this Link (or nullptr)

Return type:

RigVMPin