Inheritance #

GraphEdit #

is_instantiable, Node, core, not_builtin_classes

An editor for graph-like structures, using GraphNodes.

GraphEdit provides tools for creation, manipulation, and display of various graphs. Its main purpose in the engine is to power the visual programming systems, such as visual shaders, but it is also available for use in user projects.

GraphEdit by itself is only an empty container, representing an infinite grid where GraphNodes can be placed. Each GraphNode represents a node in the graph, a single unit of data in the connected scheme. GraphEdit, in turn, helps to control various interactions with nodes and between nodes. When the user attempts to connect, disconnect, or delete a GraphNode, a signal is emitted in the GraphEdit, but no action is taken by default. It is the responsibility of the programmer utilizing this control to implement the necessary logic to determine how each request should be handled.

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

Note: Keep in mind that Node.get_children will also return the connection layer node named _connection_layer due to technical limitations. This behavior may change in future releases.

Members #

var clip_contents: bool = true#

var connection_lines_antialiased: bool = true#

If true, the lines between nodes will use antialiasing.

var connection_lines_curvature: float = 0.5#

The curvature of the lines between the nodes. 0 results in straight lines.

var connection_lines_thickness: float = 4.0#

The thickness of the lines between the nodes.

var connections: Dictionary[] = []#

The connections between GraphNodes.

A connection is represented as a Dictionary in the form of:

{
    from_node: StringName,
    from_port: int,
    to_node: StringName,
    to_port: int,
    keep_alive: bool
}

Connections with keep_alive set to false may be deleted automatically if invalid during a redraw.

var focus_mode = FOCUS_ALL#

var grid_pattern = GRID_PATTERN_LINES#

The pattern used for drawing the grid.

var minimap_enabled: bool = true#

If true, the minimap is visible.

var minimap_opacity: float = 0.65#

The opacity of the minimap rectangle.

var minimap_size: Vector2 = Vector2(240, 160)#

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.

var panning_scheme = SCROLL_ZOOMS#

Defines the control scheme for panning with mouse wheel.

var right_disconnects: bool = false#

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

var scroll_offset: Vector2 = Vector2(0, 0)#

The scroll offset.

var show_arrange_button: bool = true#

If true, the button to automatically arrange graph nodes is visible.

var show_grid: bool = true#

If true, the grid is visible.

var show_grid_buttons: bool = true#

If true, buttons that allow to configure grid and snapping options are visible.

var show_menu: bool = true#

If true, the menu toolbar is visible.

var show_minimap_button: bool = true#

If true, the button to toggle the minimap is visible.

var show_zoom_buttons: bool = true#

If true, buttons that allow to change and reset the zoom level are visible.

var show_zoom_label: bool = false#

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

var snapping_distance: int = 20#

The snapping distance in pixels, also determines the grid line distance.

var snapping_enabled: bool = true#

If true, enables snapping.

var zoom: float = 1.0#

The current zoom value.

var zoom_max: float = 2.0736#

The upper zoom limit.

var zoom_min: float = 0.232568#

The lower zoom limit.

var zoom_step: float = 1.2#

The step of each zoom level.

Methods #

func _is_in_input_hotzone(in_node, in_port, mouse_position):
    var port_size = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical"))
    var port_pos = in_node.get_position() + in_node.get_input_port_position(in_port) - port_size / 2
    var rect = Rect2(port_pos, port_size)

    return rect.has_point(mouse_position)

func _is_in_output_hotzone(in_node, in_port, mouse_position):
    var port_size = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical"))
    var port_pos = in_node.get_position() + in_node.get_output_port_position(in_port) - port_size / 2
    var rect = Rect2(port_pos, port_size)

    return rect.has_point(mouse_position)

func _is_node_hover_valid(from, from_port, to, to_port):
    return from != to

public override bool _IsNodeHoverValid(StringName fromNode, int fromPort, StringName toNode, int toPort)
{
    return fromNode != toNode;
}

{
    from_node: StringName,
    from_port: int,
    to_node: StringName,
    to_port: int,
    keep_alive: bool
}

var connection = get_closest_connection_at_point(mouse_event.get_position())

{
    from_node: StringName,
    from_port: int,
    to_node: StringName,
    to_port: int,
    keep_alive: bool
}

Annotations #

Constants #

const SCROLL_ZOOMS = 0 enum PanningScheme#

Mouse Wheel will zoom, Ctrl + Mouse Wheel will move the view.

const SCROLL_PANS = 1 enum PanningScheme#

Mouse Wheel will move the view, Ctrl + Mouse Wheel will zoom.

const GRID_PATTERN_LINES = 0 enum GridPattern#

Draw the grid using solid lines.

const GRID_PATTERN_DOTS = 1 enum GridPattern#

Draw the grid using dots.

Constructors #

Enums #

PanningScheme#

GridPattern#

Operators #

Signals #

signal begin_node_move()#

Emitted at the beginning of a GraphElement's movement.

signal connection_drag_ended()#

Emitted at the end of a connection drag.

signal connection_drag_started(is_output: bool)#

Emitted at the beginning of a connection drag.

signal connection_from_empty(release_position: Vector2)#

Emitted when user drags a connection from an input port into the empty space of the graph.

signal connection_request(to_port: int)#

Emitted to the GraphEdit when the connection between the from_port of the from_node GraphNode and the to_port of the to_node GraphNode is attempted to be created.

signal connection_to_empty(release_position: Vector2)#

Emitted when user drags a connection from an output port into the empty space of the graph.

signal copy_nodes_request()#

Emitted when this GraphEdit captures a ui_copy action (Ctrl + C by default). In general, this signal indicates that the selected GraphElements should be copied.

signal cut_nodes_request()#

Emitted when this GraphEdit captures a ui_cut action (Ctrl + X by default). In general, this signal indicates that the selected GraphElements should be cut.

signal delete_nodes_request(nodes: StringName[])#

Emitted when this GraphEdit captures a ui_graph_delete action (Delete by default).

nodes is an array of node names that should be removed. These usually include all selected nodes.

signal disconnection_request(to_port: int)#

Emitted to the GraphEdit when the connection between from_port of from_node GraphNode and to_port of to_node GraphNode is attempted to be removed.

signal duplicate_nodes_request()#

Emitted when this GraphEdit captures a ui_graph_duplicate action (Ctrl + D by default). In general, this signal indicates that the selected GraphElements should be duplicated.

signal end_node_move()#

Emitted at the end of a GraphElement's movement.

signal frame_rect_changed(new_rect: Rect2)#

Emitted when the GraphFrame frame is resized to new_rect.

signal graph_elements_linked_to_frame_request(frame: StringName)#

Emitted when one or more GraphElements are dropped onto the GraphFrame named frame, when they were not previously attached to any other one.

elements is an array of GraphElements to be attached.

signal node_deselected(node: Node)#

Emitted when the given GraphElement node is deselected.

signal node_selected(node: Node)#

Emitted when the given GraphElement node is selected.

signal paste_nodes_request()#

Emitted when this GraphEdit captures a ui_paste action (Ctrl + V by default). In general, this signal indicates that previously copied GraphElements should be pasted.

signal popup_request(at_position: Vector2)#

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

signal scroll_offset_changed(offset: Vector2)#

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

Theme Items #

self["theme_override_colors/activity"] = Color(1, 1, 1, 1) as Color#

Color the connection line is interpolated to based on the activity value of a connection (see set_connection_activity).

self["theme_override_colors/connection_hover_tint_color"] = Color(0, 0, 0, 0.3) as Color#

Color which is blended with the connection line when the mouse is hovering over it.

self["theme_override_colors/connection_rim_color"] = Color(0.1, 0.1, 0.1, 0.6) as Color#

Color of the rim around each connection line used for making intersecting lines more distinguishable.

self["theme_override_colors/connection_valid_target_tint_color"] = Color(1, 1, 1, 0.4) as Color#

Color which is blended with the connection line when the currently dragged connection is hovering over a valid target port.

self["theme_override_colors/grid_major"] = Color(1, 1, 1, 0.2) as Color#

Color of major grid lines/dots.

self["theme_override_colors/grid_minor"] = Color(1, 1, 1, 0.05) as Color#

Color of minor grid lines/dots.

self["theme_override_colors/selection_fill"] = Color(1, 1, 1, 0.3) as Color#

The fill color of the selection rectangle.

self["theme_override_colors/selection_stroke"] = Color(1, 1, 1, 0.8) as Color#

The outline color of the selection rectangle.

self["theme_override_constants/connection_hover_thickness"] = 0 as int#

Widen the line of the connection when the mouse is hovering over it by a percentage factor. A value of 0 disables the highlight. A value of 100 doubles the line width.

self["theme_override_constants/port_hotzone_inner_extent"] = 22 as int#

The horizontal range within which a port can be grabbed (inner side).

self["theme_override_constants/port_hotzone_outer_extent"] = 26 as int#

The horizontal range within which a port can be grabbed (outer side).

self["theme_override_icons/grid_toggle"] = icon as Texture2D#

The icon for the grid toggle button.

self["theme_override_icons/layout"] = icon as Texture2D#

The icon for the layout button for auto-arranging the graph.

self["theme_override_icons/minimap_toggle"] = icon as Texture2D#

The icon for the minimap toggle button.

self["theme_override_icons/snapping_toggle"] = icon as Texture2D#

The icon for the snapping toggle button.

self["theme_override_icons/zoom_in"] = icon as Texture2D#

The icon for the zoom in button.

self["theme_override_icons/zoom_out"] = icon as Texture2D#

The icon for the zoom out button.

self["theme_override_icons/zoom_reset"] = icon as Texture2D#

The icon for the zoom reset button.

self["theme_override_styles/menu_panel"] = style as StyleBox#

self["theme_override_styles/panel"] = style as StyleBox#

The background drawn under the grid.

Tutorials #