GraphNode

Inherits: Container < Control < CanvasItem < Node < Object

A GraphNode is a container with potentially several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types.

Description

A GraphNode is a container. Each GraphNode can have several input and output slots, sometimes referred to as ports, allowing connections between GraphNodes. To add a slot to GraphNode, add any Control-derived child node to it.

After adding at least one child to GraphNode new sections will be automatically created in the Inspector called 'Slot'. When 'Slot' is expanded you will see list with index number for each slot. You can click on each of them to expand further.

In the Inspector you can enable (show) or disable (hide) slots. By default, all slots are disabled so you may not see any slots on your GraphNode initially. You can assign a type to each slot. Only slots of the same type will be able to connect to each other. You can also assign colors to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input connections are on the left and output connections are on the right side of GraphNode. Only enabled slots are counted as connections.

Properties

bool

comment

false

String

language

""

MouseFilter

mouse_filter

0 (parent override)

Overlay

overlay

0

Vector2

position_offset

Vector2(0, 0)

bool

resizable

false

bool

selected

false

bool

show_close

false

TextDirection

text_direction

0

String

title

""

Methods

void

clear_all_slots ( )

void

clear_opentype_features ( )

void

clear_slot ( int idx )

Color

get_connection_input_color ( int idx )

int

get_connection_input_count ( )

Vector2

get_connection_input_position ( int idx )

int

get_connection_input_type ( int idx )

Color

get_connection_output_color ( int idx )

int

get_connection_output_count ( )

Vector2

get_connection_output_position ( int idx )

int

get_connection_output_type ( int idx )

int

get_opentype_feature ( String tag ) const

Color

get_slot_color_left ( int idx ) const

Color

get_slot_color_right ( int idx ) const

int

get_slot_type_left ( int idx ) const

int

get_slot_type_right ( int idx ) const

bool

is_slot_enabled_left ( int idx ) const

bool

is_slot_enabled_right ( int idx ) const

void

set_opentype_feature ( String tag, int value )

void

set_slot ( int idx, bool enable_left, int type_left, Color color_left, bool enable_right, int type_right, Color color_right, Texture2D custom_left=null, Texture2D custom_right=null )

void

set_slot_color_left ( int idx, Color color_left )

void

set_slot_color_right ( int idx, Color color_right )

void

set_slot_enabled_left ( int idx, bool enable_left )

void

set_slot_enabled_right ( int idx, bool enable_right )

void

set_slot_type_left ( int idx, int type_left )

void

set_slot_type_right ( int idx, int type_right )

Signals

  • close_request ( )

Emitted when the GraphNode is requested to be closed. Happens on clicking the close button (see show_close).


Emitted when the GraphNode is dragged.


  • position_offset_changed ( )

Emitted when the GraphNode is moved.


  • raise_request ( )

Emitted when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.


  • resize_request ( Vector2 new_minsize )

Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see resizable).


  • slot_updated ( int idx )

Emitted when any GraphNode's slot is updated.

Enumerations

enum Overlay:

  • OVERLAY_DISABLED = 0 --- No overlay is shown.

  • OVERLAY_BREAKPOINT = 1 --- Show overlay set in the breakpoint theme property.

  • OVERLAY_POSITION = 2 --- Show overlay set in the position theme property.

Property Descriptions

Default

false

Setter

set_comment(value)

Getter

is_comment()

If true, the GraphNode is a comment node.


Default

""

Setter

set_language(value)

Getter

get_language()

Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.


Default

0

Setter

set_overlay(value)

Getter

get_overlay()

Sets the overlay shown above the GraphNode. See Overlay.


Default

Vector2(0, 0)

Setter

set_position_offset(value)

Getter

get_position_offset()

The offset of the GraphNode, relative to the scroll offset of the GraphEdit.

Note: You cannot use position offset directly, as GraphEdit is a Container.


Default

false

Setter

set_resizable(value)

Getter

is_resizable()

If true, the user can resize the GraphNode.

Note: Dragging the handle will only emit the resize_request signal, the GraphNode needs to be resized manually.


Default

false

Setter

set_selected(value)

Getter

is_selected()

If true, the GraphNode is selected.


Default

false

Setter

set_show_close_button(value)

Getter

is_close_button_visible()

If true, the close button will be visible.

Note: Pressing it will only emit the close_request signal, the GraphNode needs to be removed manually.


Default

0

Setter

set_text_direction(value)

Getter

get_text_direction()

Base text writing direction.


Default

""

Setter

set_title(value)

Getter

get_title()

The text displayed in the GraphNode's title bar.

Method Descriptions

  • void clear_all_slots ( )

Disables all input and output slots of the GraphNode.


  • void clear_opentype_features ( )

Removes all OpenType features.


  • void clear_slot ( int idx )

Disables input and output slot whose index is idx.


  • Color get_connection_input_color ( int idx )

Returns the Color of the input connection idx.


  • int get_connection_input_count ( )

Returns the number of enabled input slots (connections) to the GraphNode.


  • Vector2 get_connection_input_position ( int idx )

Returns the position of the input connection idx.


  • int get_connection_input_type ( int idx )

Returns the type of the input connection idx.


  • Color get_connection_output_color ( int idx )

Returns the Color of the output connection idx.


  • int get_connection_output_count ( )

Returns the number of enabled output slots (connections) of the GraphNode.


  • Vector2 get_connection_output_position ( int idx )

Returns the position of the output connection idx.


  • int get_connection_output_type ( int idx )

Returns the type of the output connection idx.


  • int get_opentype_feature ( String tag ) const

Returns OpenType feature tag.


  • Color get_slot_color_left ( int idx ) const

Returns the left (input) Color of the slot idx.


  • Color get_slot_color_right ( int idx ) const

Returns the right (output) Color of the slot idx.


  • int get_slot_type_left ( int idx ) const

Returns the left (input) type of the slot idx.


  • int get_slot_type_right ( int idx ) const

Returns the right (output) type of the slot idx.


  • bool is_slot_enabled_left ( int idx ) const

Returns true if left (input) side of the slot idx is enabled.


  • bool is_slot_enabled_right ( int idx ) const

Returns true if right (output) side of the slot idx is enabled.


  • void set_opentype_feature ( String tag, int value )

Sets OpenType feature tag. More info: OpenType feature tags.


Sets properties of the slot with ID idx.

If enable_left/right, a port will appear and the slot will be able to be connected from this side.

type_left/right is an arbitrary type of the port. Only ports with the same type values can be connected.

color_left/right is the tint of the port's icon on this side.

custom_left/right is a custom texture for this side's port.

Note: This method only sets properties of the slot. To create the slot, add a Control-derived child to the GraphNode.

Individual properties can be set using one of the set_slot_* methods. You must enable at least one side of the slot to do so.


  • void set_slot_color_left ( int idx, Color color_left )

Sets the Color of the left (input) side of the slot idx to color_left.


  • void set_slot_color_right ( int idx, Color color_right )

Sets the Color of the right (output) side of the slot idx to color_right.


  • void set_slot_enabled_left ( int idx, bool enable_left )

Toggles the left (input) side of the slot idx. If enable_left is true, a port will appear on the left side and the slot will be able to be connected from this side.


  • void set_slot_enabled_right ( int idx, bool enable_right )

Toggles the right (output) side of the slot idx. If enable_right is true, a port will appear on the right side and the slot will be able to be connected from this side.


  • void set_slot_type_left ( int idx, int type_left )

Sets the left (input) type of the slot idx to type_left.


  • void set_slot_type_right ( int idx, int type_right )

Sets the right (output) type of the slot idx to type_right.

Theme Property Descriptions

The background used when overlay is set to OVERLAY_BREAKPOINT.


The icon for the close button, visible when show_close is enabled.


Default

Color(0, 0, 0, 1)

The color modulation applied to the close button icon.


  • int close_offset

Default

18

The vertical offset of the close button.


The StyleBox used when comment is enabled.


The StyleBox used when comment is enabled and the GraphNode is focused.




The default background for GraphNode.


The icon used for representing ports.


  • int port_offset

Default

3

Horizontal offset for the ports.


The background used when overlay is set to OVERLAY_POSITION.


The icon used for resizer, visible when resizable is enabled.


Default

Color(0, 0, 0, 1)

The color modulation applied to the resizer icon.


The background used when the GraphNode is selected.


  • int separation

Default

1

The vertical distance between ports.


Default

Color(0, 0, 0, 1)

Color of the title text.


Font used for the title text.


  • int title_offset

Default

20

Vertical offset of the title text.