GraphEdit

GraphEdit

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

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

Properties

bool	right_disconnects
Vector2	scroll_offset
int	snap_distance
bool	use_snap
float	zoom

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
int	bezier_len_neg
int	bezier_len_pos
StyleBox	bg
Color	grid_major
Color	grid_minor
Texture	minus
Texture	more
int	port_grab_distance_horizontal
int	port_grab_distance_vertical
Texture	reset
Texture	snap

Signals

_begin_node_move ( )

Signal sent at the beginning of a GraphNode movement.

_end_node_move ( )

Signal sent at the end of a GraphNode movement.

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

Signal sent to the GraphEdit when the connection between ‘from_slot’ slot of ‘from’ GraphNode and ‘to_slot’ slot of ‘to’ GraphNode is attempted to be created.

connection_to_empty ( String from, int from_slot, Vector2 release_position )

delete_nodes_request ( )

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

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

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

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

node_selected ( Node node )

Emitted when a GraphNode is selected.

popup_request ( Vector2 position )

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

scroll_offset_changed ( Vector2 ofs )

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 GraphNodes slots is disabled by default.

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

Property Descriptions

bool right_disconnects

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.

Vector2 scroll_offset

Setter	set_scroll_ofs(value)
Getter	get_scroll_ofs()

The scroll offset.

int snap_distance

Setter	set_snap(value)
Getter	get_snap()

The snapping distance in pixels.

bool use_snap

Setter	set_use_snap(value)
Getter	is_using_snap()

If true, enables snapping.

float zoom

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

Remove all connections between nodes.

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

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

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

Remove the connection between ‘from_port’ slot of ‘from’ GraphNode and ‘to_port’ slot of ‘to’ GraphNode, if connection exists.

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

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

Returns true if the ‘from_port’ slot of ‘from’ GraphNode is connected to the ‘to_port’ slot of ‘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 )

void set_selected ( Node node )

Sets the specified node as the one selected.