GraphNode¶
Inherits: GraphElement < Container < Control < CanvasItem < Node < Object
A container with connection ports, representing a node in a GraphEdit.
Description¶
GraphNode allows to create nodes for a GraphEdit graph with customizable content based on its child controls. GraphNode is derived from Container and it is responsible for placing its children on screen. This works similar to VBoxContainer. Children, in turn, provide GraphNode with so-called slots, each of which can have a connection port on either side.
Each GraphNode slot is defined by its index and can provide the node with up to two ports: one on the left, and one on the right. By convention the left port is also referred to as the input port and the right port is referred to as the output port. Each port can be enabled and configured individually, using different type and color. The type is an arbitrary value that you can define using your own considerations. The parent GraphEdit will receive this information on each connect and disconnect request.
Slots can be configured in the Inspector dock once you add at least one child Control. The properties are grouped by each slot's index in the "Slot" section.
Note: While GraphNode is set up using slots and slot indices, connections are made between the ports which are enabled. Because of that GraphEdit uses the port's index and not the slot's index. You can use get_input_port_slot and get_output_port_slot to get the slot index from the port index.
Properties¶
mouse_filter |
|
|
|
Methods¶
void |
_draw_port ( int slot_index, Vector2i position, bool left, Color color ) virtual |
void |
clear_all_slots ( ) |
void |
clear_slot ( int slot_index ) |
get_input_port_color ( int port_idx ) |
|
get_input_port_position ( int port_idx ) |
|
get_input_port_slot ( int port_idx ) |
|
get_input_port_type ( int port_idx ) |
|
get_output_port_color ( int port_idx ) |
|
get_output_port_position ( int port_idx ) |
|
get_output_port_slot ( int port_idx ) |
|
get_output_port_type ( int port_idx ) |
|
get_slot_color_left ( int slot_index ) const |
|
get_slot_color_right ( int slot_index ) const |
|
get_slot_type_left ( int slot_index ) const |
|
get_slot_type_right ( int slot_index ) const |
|
is_slot_draw_stylebox ( int slot_index ) const |
|
is_slot_enabled_left ( int slot_index ) const |
|
is_slot_enabled_right ( int slot_index ) const |
|
void |
set_slot ( int slot_index, bool enable_left_port, int type_left, Color color_left, bool enable_right_port, int type_right, Color color_right, Texture2D custom_icon_left=null, Texture2D custom_icon_right=null, bool draw_stylebox=true ) |
void |