Bases: Object
The Node represents a single statement within a Graph.
Nodes can represent values such as Variables / Parameters,
they can represent Function Invocations or Control Flow
logic statements (such as If conditions of For loops).
Additionally Nodes are used to represent Comment statements.
Nodes contain Pins to represent parameters for Function
Invocations or Value access on Variables / Parameters.
C++ Source:
Module: RigVMDeveloper
File: RigVMNode.h
-
can_be_upgraded() → bool
returns true if the node can be upgraded
- Return type:
bool
-
can_only_exist_once() → bool
Returns true if this node can only exist once in a graph
- Return type:
bool
-
execution_is_halted_at_this_node() → bool
Execution Is Halted at This Node
- Return type:
bool
-
find_pin(pin_path) → RigVMPin
Returns a Pin given it’s partial pin path below
this node (for example: “Color.R”)
- Parameters:
pin_path (str) –
- Return type:
RigVMPin
-
get_aggregate_inputs() → Array[RigVMPin]
Get Aggregate Inputs
- Return type:
Array[RigVMPin]
-
get_aggregate_outputs() → Array[RigVMPin]
Get Aggregate Outputs
- Return type:
Array[RigVMPin]
-
get_all_pins_recursively() → Array[RigVMPin]
Returns all of the Pins of this Node (including SubPins).
- Return type:
Array[RigVMPin]
-
get_event_name() → Name
Returns the name of the event
- Return type:
Name
-
get_first_aggregate_pin() → RigVMPin
Get First Aggregate Pin
- Return type:
RigVMPin
-
get_graph() → RigVMGraph
Returns the Graph of this Node
- Return type:
RigVMGraph
-
get_injection_info() → RigVMInjectionInfo
Returns the injection info of this Node (or nullptr)
- Return type:
RigVMInjectionInfo
-
get_linked_source_nodes() → Array[RigVMNode]
Returns a list of Nodes connected as sources to
this Node as the target.
- Return type:
Array[RigVMNode]
-
get_linked_target_nodes() → Array[RigVMNode]
Returns a list of Nodes connected as targets to
this Node as the source.
- Return type:
Array[RigVMNode]
-
get_links() → Array[RigVMLink]
Returns all links to any pin on this node
- Return type:
Array[RigVMLink]
-
get_next_aggregate_name(last_aggregate_pin_name) → Name
Get Next Aggregate Name
- Parameters:
last_aggregate_pin_name (Name) –
- Return type:
Name
-
get_node_color() → LinearColor
Returns the color of this node - used for UI.
- Return type:
LinearColor
-
get_node_index() → int32
Returns the current index of the Node within the Graph.
- Return type:
int32
-
get_node_path(recursive=False) → str
Returns the a . separated string containing all of the
names used to reach this Node within the Graph.
(for now this is the same as the Node’s name)
- Parameters:
recursive (bool) –
- Return type:
str
-
get_node_title() → str
Returns the title of this Node - used for UI.
- Return type:
str
-
get_opposite_aggregate_pin() → RigVMPin
Get Opposite Aggregate Pin
- Return type:
RigVMPin
-
get_orphaned_pins() → Array[RigVMPin]
Returns all of the top-level orphaned Pins of this Node.
- Return type:
Array[RigVMPin]
-
get_pins() → Array[RigVMPin]
Returns all of the top-level Pins of this Node.
- Return type:
Array[RigVMPin]
-
get_position() → Vector2D
Returns the 2d position of this node - used for UI.
- Return type:
Vector2D
-
get_previous_f_name() → Name
Returns the name of the node prior to the renaming
- Return type:
Name
-
get_root_graph() → RigVMGraph
Returns the top level / root Graph of this Node
- Return type:
RigVMGraph
-
get_second_aggregate_pin() → RigVMPin
Get Second Aggregate Pin
- Return type:
RigVMPin
-
get_size() → Vector2D
Returns the 2d size of this node - used for UI.
- Return type:
Vector2D
-
get_supported_workflows(type, subject) → Array[RigVMUserWorkflow]
returns all supported workflows of the node
- Parameters:
-
- Return type:
Array[RigVMUserWorkflow]
-
get_tool_tip_text() → Text
Returns the tooltip of this node
- Return type:
Text
-
has_breakpoint() → bool
Has Breakpoint
- Return type:
bool
-
has_input_pin(include_io=True) → bool
Returns true if the node has any input pins
- Parameters:
include_io (bool) –
- Return type:
bool
-
has_io_pin() → bool
Returns true if the node has any io pins
- Return type:
bool
-
has_orphaned_pins() → bool
Returns true if the node has orphaned pins - which leads to a compiler error
- Return type:
bool
-
has_output_pin(include_io=True) → bool
Returns true if the node has any output pins
- Parameters:
include_io (bool) –
- Return type:
bool
-
has_pin_of_direction(direction) → bool
Returns true if the node has any pins of the provided direction
- Parameters:
direction (RigVMPinDirection) –
- Return type:
bool
-
is_aggregate() → bool
Is Aggregate
- Return type:
bool
-
is_defined_as_constant() → bool
Returns true if the node is defined as non-varying
- Return type:
bool
-
is_defined_as_varying() → bool
Returns true if the node is defined as non-varying
- Return type:
bool
-
is_event() → bool
Returns true if this Node is the beginning of a scope
- Return type:
bool
-
is_injected() → bool
Returns true if this is an injected node.
Injected nodes are managed by pins are are not visible to the user.
- Return type:
bool
-
is_input_aggregate() → bool
Is Input Aggregate
- Return type:
bool
-
is_linked_to(node) → bool
Returns true if this Node is linked to another
given node through any of the Nodes’ Pins.
- Parameters:
node (RigVMNode) –
- Return type:
bool
-
is_loop_node() → bool
return true if this node is a loop node
- Return type:
bool
-
is_mutable() → bool
Returns true if this Node has side effects or
internal state.
- Return type:
bool
-
is_pure() → bool
Returns true if this Node has no side-effects
and no internal state.
- Return type:
bool
-
is_selected() → bool
Returns true if this Node is currently selected.
- Return type:
bool
-
is_visible_in_ui() → bool
Returns true if this should be visible in the UI
- Return type:
bool
-
set_execution_is_halted_at_this_node(value) → None
Set Execution Is Halted at This Node
- Parameters:
value (bool) –
-
set_has_breakpoint(value) → None
Set Has Breakpoint
- Parameters:
value (bool) –