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 O: 2
bool rect_clip_content O: true
bool right_disconnects false
Vector2 scroll_offset Vector2( 0, 0 )
int snap_distance 20
bool use_snap true
float zoom 1.0

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 )
int bezier_len_neg 160
int bezier_len_pos 80
StyleBox bg  
Color grid_major Color( 1, 1, 1, 0.2 )
Color grid_minor Color( 1, 1, 1, 0.05 )
Texture minus  
Texture more  
int port_grab_distance_horizontal 48
int port_grab_distance_vertical 6
Texture reset  
Color selection_fill Color( 1, 1, 1, 0.3 )
Color selection_stroke Color( 1, 1, 1, 0.8 )
Texture snap  

Signals

  • _begin_node_move ( )

Emitted at the beginning of a GraphNode movement.

  • _end_node_move ( )

Emitted at the end of a GraphNode movement.

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

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.

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 ( )

Emitted when a GraphNode is attempted to be removed from the GraphEdit.

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.

  • 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 right_disconnects
Default false
Setter set_right_disconnects(value)
Getter is_right_disconnects_enabled()

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

Default Vector2( 0, 0 )
Setter set_scroll_ofs(value)
Getter get_scroll_ofs()

The scroll offset.

  • int snap_distance
Default 20
Setter set_snap(value)
Getter get_snap()

The snapping distance in pixels.

Default true
Setter set_use_snap(value)
Getter is_using_snap()

If true, enables snapping.

Default 1.0
Setter set_zoom(value)
Getter get_zoom()

The current zoom value.

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.

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.

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" }.

Gets the HBoxContainer that contains the zooming and grid snap controls in the top left of the graph.

Warning: The intended usage of this function is to allow you to reposition or add your own custom controls to the container. This is an internal control and as such should not be freed. If you wish to hide this or any of it’s children use their CanvasItem.visible property instead.

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.

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.