GraphEdit

Inherits: Control < CanvasItem < Node < Object

GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them.

Description

GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNode slots is disabled by default.

It is greatly advised to enable low-processor usage mode (see OS.low_processor_usage_mode) when using GraphEdits.

Properties

FocusMode

focus_mode

2 (overrides Control)

bool

minimap_enabled

true

float

minimap_opacity

0.65

Vector2

minimap_size

Vector2( 240, 160 )

bool

rect_clip_content

true (overrides Control)

bool

right_disconnects

false

Vector2

scroll_offset

Vector2( 0, 0 )

bool

show_zoom_label

false

int

snap_distance

20

bool

use_snap

true

float

zoom

1.0

float

zoom_max

2.0736

float

zoom_min

0.232568

float

zoom_step

1.2

Methods

void

add_valid_connection_type ( int from_type, int to_type )

void

add_valid_left_disconnect_type ( int type )

void

add_valid_right_disconnect_type ( int type )

void

clear_connections ( )

Error

connect_node ( String from, int from_port, String to, int to_port )

void

disconnect_node ( String from, int from_port, String to, int to_port )

Array

get_connection_list ( ) const

HBoxContainer

get_zoom_hbox ( )

bool

is_node_connected ( String from, int from_port, String to, int to_port )

bool

is_valid_connection_type ( int from_type, int to_type ) const

void

remove_valid_connection_type ( int from_type, int to_type )

void

remove_valid_left_disconnect_type ( int type )

void

remove_valid_right_disconnect_type ( int type )

void

set_connection_activity ( String from, int from_port, String to, int to_port, float amount )

void

set_selected ( Node node )

Theme Properties

Color

activity

Color( 1, 1, 1, 1 )

Color

grid_major

Color( 1, 1, 1, 0.2 )

Color

grid_minor

Color( 1, 1, 1, 0.05 )

Color

selection_fill

Color( 1, 1, 1, 0.3 )

Color

selection_stroke

Color( 1, 1, 1, 0.8 )

int

bezier_len_neg

160

int

bezier_len_pos

80

int

port_grab_distance_horizontal

24

int

port_grab_distance_vertical

26

Texture

minimap

Texture

minus

Texture

more

Texture

reset

Texture

snap

StyleBox

bg

Signals

_begin_node_move ( )

Emitted at the beginning of a GraphNode movement.

_end_node_move ( )

Emitted at the end of a GraphNode movement.

connection_from_empty ( String to, int to_slot, Vector2 release_position )

Emitted when user dragging connection from input port into empty space of the graph.

connection_request ( String from, int from_slot, String to, int to_slot )

Emitted to the GraphEdit when the connection between the from_slot slot of the from GraphNode and the to_slot slot of the to GraphNode is attempted to be created.

connection_to_empty ( String from, int from_slot, Vector2 release_position )

Emitted when user dragging connection from output port into empty space of the graph.

copy_nodes_request ( )

Emitted when the user presses Ctrl + C.

delete_nodes_request ( Array nodes )

Emitted when a GraphNode is attempted to be removed from the GraphEdit. Provides a list of node names to be removed (all selected nodes, excluding nodes without closing button).

disconnection_request ( String from, int from_slot, String to, int to_slot )

Emitted to the GraphEdit when the connection between from_slot slot of from GraphNode and to_slot slot of to GraphNode is attempted to be removed.

duplicate_nodes_request ( )

Emitted when a GraphNode is attempted to be duplicated in the GraphEdit.

node_selected ( Node node )

Emitted when a GraphNode is selected.

node_unselected ( Node node )

There is currently no description for this signal. Please help us by contributing one!

paste_nodes_request ( )

Emitted when the user presses Ctrl + V.

popup_request ( Vector2 position )

Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. position is the position of the mouse pointer when the signal is sent.

scroll_offset_changed ( Vector2 ofs )

Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code.

Property Descriptions

bool minimap_enabled = true

  • void set_minimap_enabled ( bool value )

  • bool is_minimap_enabled ( )

If true, the minimap is visible.

float minimap_opacity = 0.65

  • void set_minimap_opacity ( float value )

  • float get_minimap_opacity ( )

The opacity of the minimap rectangle.

Vector2 minimap_size = Vector2( 240, 160 )

  • void set_minimap_size ( Vector2 value )

  • Vector2 get_minimap_size ( )

The size of the minimap rectangle. The map itself is based on the size of the grid area and is scaled to fit this rectangle.

bool right_disconnects = false

  • void set_right_disconnects ( bool value )

  • bool is_right_disconnects_enabled ( )

If true, enables disconnection of existing connections in the GraphEdit by dragging the right end.

Vector2 scroll_offset = Vector2( 0, 0 )

The scroll offset.

bool show_zoom_label = false

  • void set_show_zoom_label ( bool value )

  • bool is_showing_zoom_label ( )

If true, makes a label with the current zoom level visible. The zoom value is displayed in percents.

int snap_distance = 20

  • void set_snap ( int value )

  • int get_snap ( )

The snapping distance in pixels.

bool use_snap = true

  • void set_use_snap ( bool value )

  • bool is_using_snap ( )

If true, enables snapping.

float zoom = 1.0

  • void set_zoom ( float value )

  • float get_zoom ( )

The current zoom value.

float zoom_max = 2.0736

  • void set_zoom_max ( float value )

  • float get_zoom_max ( )

The upper zoom limit.

float zoom_min = 0.232568

  • void set_zoom_min ( float value )

  • float get_zoom_min ( )

The lower zoom limit.

float zoom_step = 1.2

  • void set_zoom_step ( float value )

  • float get_zoom_step ( )

The step of each zoom level.

Method Descriptions

void add_valid_connection_type ( int from_type, int to_type )

Makes possible the connection between two different slot types. The type is defined with the GraphNode.set_slot method.

void add_valid_left_disconnect_type ( int type )

Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type.

void add_valid_right_disconnect_type ( int type )

Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type.

void clear_connections ( )

Removes all connections between nodes.

Error connect_node ( String from, int from_port, String to, int to_port )

Create a connection between the from_port slot of the from GraphNode and the to_port slot of the to GraphNode. If the connection already exists, no connection is created.

void disconnect_node ( String from, int from_port, String to, int to_port )

Removes the connection between the from_port slot of the from GraphNode and the to_port slot of the to GraphNode. If the connection does not exist, no connection is removed.

Array get_connection_list ( ) const

Returns an Array containing the list of connections. A connection consists in a structure of the form { from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" }.

HBoxContainer get_zoom_hbox ( )

Gets the HBoxContainer that contains the zooming and grid snap controls in the top left of the graph. You can use this method to reposition the toolbar or to add your own custom controls to it.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.

bool is_node_connected ( String from, int from_port, String to, int to_port )

Returns true if the from_port slot of the from GraphNode is connected to the to_port slot of the to GraphNode.

bool is_valid_connection_type ( int from_type, int to_type ) const

Returns whether it's possible to connect slots of the specified types.

void remove_valid_connection_type ( int from_type, int to_type )

Makes it not possible to connect between two different slot types. The type is defined with the GraphNode.set_slot method.

void remove_valid_left_disconnect_type ( int type )

Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type.

void remove_valid_right_disconnect_type ( int type )

Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type.

void set_connection_activity ( String from, int from_port, String to, int to_port, float amount )

Sets the coloration of the connection between from's from_port and to's to_port with the color provided in the activity theme property.

void set_selected ( Node node )

Sets the specified node as the one selected.

Theme Property Descriptions

Color activity = Color( 1, 1, 1, 1 )

There is currently no description for this theme property. Please help us by contributing one!

Color grid_major = Color( 1, 1, 1, 0.2 )

Color of major grid lines.

Color grid_minor = Color( 1, 1, 1, 0.05 )

Color of minor grid lines.

Color selection_fill = Color( 1, 1, 1, 0.3 )

The fill color of the selection rectangle.

Color selection_stroke = Color( 1, 1, 1, 0.8 )

The outline color of the selection rectangle.

int bezier_len_neg = 160

There is currently no description for this theme property. Please help us by contributing one!

int bezier_len_pos = 80

There is currently no description for this theme property. Please help us by contributing one!

int port_grab_distance_horizontal = 24

The horizontal range within which a port can be grabbed (on both sides).

int port_grab_distance_vertical = 26

The vertical range within which a port can be grabbed (on both sides).

Texture minimap

There is currently no description for this theme property. Please help us by contributing one!

Texture minus

The icon for the zoom out button.

Texture more

The icon for the zoom in button.

Texture reset

The icon for the zoom reset button.

Texture snap

The icon for the snap toggle button.

StyleBox bg

The background drawn under the grid.