virtualx-engine/doc/classes/GraphEdit.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GraphEdit" inherits="Control" is_experimental="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		An editor for graph-like structures, using [GraphNode]s.
	</brief_description>
	<description>
		[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 [GraphNode]s 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.
		[b]Performance:[/b] It is greatly advised to enable low-processor usage mode (see [member OS.low_processor_usage_mode]) when using GraphEdits.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="_get_connection_line" qualifiers="virtual const">
			<return type="PackedVector2Array" />
			<param index="0" name="from_position" type="Vector2" />
			<param index="1" name="to_position" type="Vector2" />
			<description>
				Virtual method which can be overridden to customize how connections are drawn.
			</description>
		</method>
		<method name="_is_in_input_hotzone" qualifiers="virtual">
			<return type="bool" />
			<param index="0" name="in_node" type="Object" />
			<param index="1" name="in_port" type="int" />
			<param index="2" name="mouse_position" type="Vector2" />
			<description>
				Returns whether the [param mouse_position] is in the input hot zone.
				By default, a hot zone is a [Rect2] positioned such that its center is at [param in_node].[method GraphNode.get_input_port_position]([param in_port]) (For output's case, call [method GraphNode.get_output_port_position] instead). The hot zone's width is twice the Theme Property [code]port_grab_distance_horizontal[/code], and its height is twice the [code]port_grab_distance_vertical[/code].
				Below is a sample code to help get started:
				[codeblock]
				func _is_in_input_hotzone(in_node, in_port, mouse_position):
				    var port_size: Vector2 = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical"))
				    var port_pos: Vector2 = 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)
				[/codeblock]
			</description>
		</method>
		<method name="_is_in_output_hotzone" qualifiers="virtual">
			<return type="bool" />
			<param index="0" name="in_node" type="Object" />
			<param index="1" name="in_port" type="int" />
			<param index="2" name="mouse_position" type="Vector2" />
			<description>
				Returns whether the [param mouse_position] is in the output hot zone. For more information on hot zones, see [method _is_in_input_hotzone].
				Below is a sample code to help get started:
				[codeblock]
				func _is_in_output_hotzone(in_node, in_port, mouse_position):
				    var port_size: Vector2 = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical"))
				    var port_pos: Vector2 = 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)
				[/codeblock]
			</description>
		</method>
		<method name="_is_node_hover_valid" qualifiers="virtual">
			<return type="bool" />
			<param index="0" name="from_node" type="StringName" />
			<param index="1" name="from_port" type="int" />
			<param index="2" name="to_node" type="StringName" />
			<param index="3" name="to_port" type="int" />
			<description>
				This virtual method can be used to insert additional error detection while the user is dragging a connection over a valid port.
				Return [code]true[/code] if the connection is indeed valid or return [code]false[/code] if the connection is impossible. If the connection is impossible, no snapping to the port and thus no connection request to that port will happen.
				In this example a connection to same node is suppressed:
				[codeblocks]
				[gdscript]
				func _is_node_hover_valid(from, from_port, to, to_port):
				    return from != to
				[/gdscript]
				[csharp]
				public override bool _IsNodeHoverValid(StringName fromNode, int fromPort, StringName toNode, int toPort)
				{
				    return fromNode != toNode;
				}
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="add_valid_connection_type">
			<return type="void" />
			<param index="0" name="from_type" type="int" />
			<param index="1" name="to_type" type="int" />
			<description>
				Allows the connection between two different port types. The port type is defined individually for the left and the right port of each slot with the [method GraphNode.set_slot] method.
				See also [method is_valid_connection_type] and [method remove_valid_connection_type].
			</description>
		</method>
		<method name="add_valid_left_disconnect_type">
			<return type="void" />
			<param index="0" name="type" type="int" />
			<description>
				Allows to disconnect nodes when dragging from the left port of the [GraphNode]'s slot if it has the specified type. See also [method remove_valid_left_disconnect_type].
			</description>
		</method>
		<method name="add_valid_right_disconnect_type">
			<return type="void" />
			<param index="0" name="type" type="int" />
			<description>
				Allows to disconnect nodes when dragging from the right port of the [GraphNode]'s slot if it has the specified type. See also [method remove_valid_right_disconnect_type].
			</description>
		</method>
		<method name="arrange_nodes">
			<return type="void" />
			<description>
				Rearranges selected nodes in a layout with minimum crossings between connections and uniform horizontal and vertical gap between nodes.
			</description>
		</method>
		<method name="clear_connections">
			<return type="void" />
			<description>
				Removes all connections between nodes.
			</description>
		</method>
		<method name="connect_node">
			<return type="int" enum="Error" />
			<param index="0" name="from_node" type="StringName" />
			<param index="1" name="from_port" type="int" />
			<param index="2" name="to_node" type="StringName" />
			<param index="3" name="to_port" type="int" />
			<description>
				Create a connection between the [param from_port] of the [param from_node] [GraphNode] and the [param to_port] of the [param to_node] [GraphNode]. If the connection already exists, no connection is created.
			</description>
		</method>
		<method name="disconnect_node">
			<return type="void" />
			<param index="0" name="from_node" type="StringName" />
			<param index="1" name="from_port" type="int" />
			<param index="2" name="to_node" type="StringName" />
			<param index="3" name="to_port" type="int" />
			<description>
				Removes the connection between the [param from_port] of the [param from_node] [GraphNode] and the [param to_port] of the [param to_node] [GraphNode]. If the connection does not exist, no connection is removed.
			</description>
		</method>
		<method name="force_connection_drag_end">
			<return type="void" />
			<description>
				Ends the creation of the current connection. In other words, if you are dragging a connection you can use this method to abort the process and remove the line that followed your cursor.
				This is best used together with [signal connection_drag_started] and [signal connection_drag_ended] to add custom behavior like node addition through shortcuts.
				[b]Note:[/b] This method suppresses any other connection request signals apart from [signal connection_drag_ended].
			</description>
		</method>
		<method name="get_closest_connection_at_point" qualifiers="const">
			<return type="Dictionary" />
			<param index="0" name="point" type="Vector2" />
			<param index="1" name="max_distance" type="float" default="4.0" />
			<description>
				Returns the closest connection to the given point in screen space. If no connection is found within [param max_distance] pixels, an empty [Dictionary] is returned.
				A connection consists in a structure of the form [code]{ from_port: 0, from_node: "GraphNode name 0", to_port: 1, to_node: "GraphNode name 1" }[/code].
				For example, getting a connection at a given mouse position can be achieved like this:
				[codeblocks]
				[gdscript]
				var connection = get_closest_connection_at_point(mouse_event.get_position())
				[/gdscript]
				[/codeblocks]
			</description>
		</method>
		<method name="get_connection_line" qualifiers="const">
			<return type="PackedVector2Array" />
			<param index="0" name="from_node" type="Vector2" />
			<param index="1" name="to_node" type="Vector2" />
			<description>
				Returns the points which would make up a connection between [param from_node] and [param to_node].
			</description>
		</method>
		<method name="get_connection_list" qualifiers="const">
			<return type="Dictionary[]" />
			<description>
				Returns an [Array] containing the list of connections. A connection consists in a structure of the form [code]{ from_port: 0, from_node: "GraphNode name 0", to_port: 1, to_node: "GraphNode name 1" }[/code].
			</description>
		</method>
		<method name="get_connections_intersecting_with_rect" qualifiers="const">
			<return type="Dictionary[]" />
			<param index="0" name="rect" type="Rect2" />
			<description>
				Returns an [Array] containing the list of connections that intersect with the given [Rect2]. A connection consists in a structure of the form [code]{ from_port: 0, from_node: "GraphNode name 0", to_port: 1, to_node: "GraphNode name 1" }[/code].
			</description>
		</method>
		<method name="get_menu_hbox">
			<return type="HBoxContainer" />
			<description>
				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.
				[b]Warning:[/b] 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 [member CanvasItem.visible] property.
			</description>
		</method>
		<method name="is_node_connected">
			<return type="bool" />
			<param index="0" name="from_node" type="StringName" />
			<param index="1" name="from_port" type="int" />
			<param index="2" name="to_node" type="StringName" />
			<param index="3" name="to_port" type="int" />
			<description>
				Returns [code]true[/code] if the [param from_port] of the [param from_node] [GraphNode] is connected to the [param to_port] of the [param to_node] [GraphNode].
			</description>
		</method>
		<method name="is_valid_connection_type" qualifiers="const">
			<return type="bool" />
			<param index="0" name="from_type" type="int" />
			<param index="1" name="to_type" type="int" />
			<description>
				Returns whether it's possible to make a connection between two different port types. The port type is defined individually for the left and the right port of each slot with the [method GraphNode.set_slot] method.
				See also [method add_valid_connection_type] and [method remove_valid_connection_type].
			</description>
		</method>
		<method name="remove_valid_connection_type">
			<return type="void" />
			<param index="0" name="from_type" type="int" />
			<param index="1" name="to_type" type="int" />
			<description>
				Disallows the connection between two different port types previously allowed by [method add_valid_connection_type]. The port type is defined individually for the left and the right port of each slot with the [method GraphNode.set_slot] method.
				See also [method is_valid_connection_type].
			</description>
		</method>
		<method name="remove_valid_left_disconnect_type">
			<return type="void" />
			<param index="0" name="type" type="int" />
			<description>
				Disallows to disconnect nodes when dragging from the left port of the [GraphNode]'s slot if it has the specified type. Use this to disable disconnection previously allowed with [method add_valid_left_disconnect_type].
			</description>
		</method>
		<method name="remove_valid_right_disconnect_type">
			<return type="void" />
			<param index="0" name="type" type="int" />
			<description>
				Disallows to disconnect nodes when dragging from the right port of the [GraphNode]'s slot if it has the specified type. Use this to disable disconnection previously allowed with [method add_valid_right_disconnect_type].
			</description>
		</method>
		<method name="set_connection_activity">
			<return type="void" />
			<param index="0" name="from_node" type="StringName" />
			<param index="1" name="from_port" type="int" />
			<param index="2" name="to_node" type="StringName" />
			<param index="3" name="to_port" type="int" />
			<param index="4" name="amount" type="float" />
			<description>
				Sets the coloration of the connection between [param from_node]'s [param from_port] and [param to_node]'s [param to_port] with the color provided in the [theme_item activity] theme property. The color is linearly interpolated between the connection color and the activity color using [param amount] as weight.
			</description>
		</method>
		<method name="set_selected">
			<return type="void" />
			<param index="0" name="node" type="Node" />
			<description>
				Sets the specified [param node] as the one selected.
			</description>
		</method>
	</methods>
	<members>
		<member name="clip_contents" type="bool" setter="set_clip_contents" getter="is_clipping_contents" overrides="Control" default="true" />
		<member name="connection_lines_antialiased" type="bool" setter="set_connection_lines_antialiased" getter="is_connection_lines_antialiased" default="true">
			If [code]true[/code], the lines between nodes will use antialiasing.
		</member>
		<member name="connection_lines_curvature" type="float" setter="set_connection_lines_curvature" getter="get_connection_lines_curvature" default="0.5">
			The curvature of the lines between the nodes. 0 results in straight lines.
		</member>
		<member name="connection_lines_thickness" type="float" setter="set_connection_lines_thickness" getter="get_connection_lines_thickness" default="4.0">
			The thickness of the lines between the nodes.
		</member>
		<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="2" />
		<member name="grid_pattern" type="int" setter="set_grid_pattern" getter="get_grid_pattern" enum="GraphEdit.GridPattern" default="0">
			The pattern used for drawing the grid.
		</member>
		<member name="minimap_enabled" type="bool" setter="set_minimap_enabled" getter="is_minimap_enabled" default="true">
			If [code]true[/code], the minimap is visible.
		</member>
		<member name="minimap_opacity" type="float" setter="set_minimap_opacity" getter="get_minimap_opacity" default="0.65">
			The opacity of the minimap rectangle.
		</member>
		<member name="minimap_size" type="Vector2" setter="set_minimap_size" getter="get_minimap_size" default="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.
		</member>
		<member name="panning_scheme" type="int" setter="set_panning_scheme" getter="get_panning_scheme" enum="GraphEdit.PanningScheme" default="0">
			Defines the control scheme for panning with mouse wheel.
		</member>
		<member name="right_disconnects" type="bool" setter="set_right_disconnects" getter="is_right_disconnects_enabled" default="false">
			If [code]true[/code], enables disconnection of existing connections in the GraphEdit by dragging the right end.
		</member>
		<member name="scroll_offset" type="Vector2" setter="set_scroll_offset" getter="get_scroll_offset" default="Vector2(0, 0)">
			The scroll offset.
		</member>
		<member name="show_arrange_button" type="bool" setter="set_show_arrange_button" getter="is_showing_arrange_button" default="true">
			If [code]true[/code], the button to automatically arrange graph nodes is visible.
		</member>
		<member name="show_grid" type="bool" setter="set_show_grid" getter="is_showing_grid" default="true">
			If [code]true[/code], the grid is visible.
		</member>
		<member name="show_grid_buttons" type="bool" setter="set_show_grid_buttons" getter="is_showing_grid_buttons" default="true">
			If [code]true[/code], buttons that allow to configure grid and snapping options are visible.
		</member>
		<member name="show_menu" type="bool" setter="set_show_menu" getter="is_showing_menu" default="true">
			If [code]true[/code], the menu toolbar is visible.
		</member>
		<member name="show_minimap_button" type="bool" setter="set_show_minimap_button" getter="is_showing_minimap_button" default="true">
			If [code]true[/code], the button to toggle the minimap is visible.
		</member>
		<member name="show_zoom_buttons" type="bool" setter="set_show_zoom_buttons" getter="is_showing_zoom_buttons" default="true">
			If [code]true[/code], buttons that allow to change and reset the zoom level are visible.
		</member>
		<member name="show_zoom_label" type="bool" setter="set_show_zoom_label" getter="is_showing_zoom_label" default="false">
			If [code]true[/code], the label with the current zoom level is visible. The zoom level is displayed in percents.
		</member>
		<member name="snapping_distance" type="int" setter="set_snapping_distance" getter="get_snapping_distance" default="20">
			The snapping distance in pixels, also determines the grid line distance.
		</member>
		<member name="snapping_enabled" type="bool" setter="set_snapping_enabled" getter="is_snapping_enabled" default="true">
			If [code]true[/code], enables snapping.
		</member>
		<member name="zoom" type="float" setter="set_zoom" getter="get_zoom" default="1.0">
			The current zoom value.
		</member>
		<member name="zoom_max" type="float" setter="set_zoom_max" getter="get_zoom_max" default="2.0736">
			The upper zoom limit.
		</member>
		<member name="zoom_min" type="float" setter="set_zoom_min" getter="get_zoom_min" default="0.232568">
			The lower zoom limit.
		</member>
		<member name="zoom_step" type="float" setter="set_zoom_step" getter="get_zoom_step" default="1.2">
			The step of each zoom level.
		</member>
	</members>
	<signals>
		<signal name="begin_node_move">
			<description>
				Emitted at the beginning of a GraphNode movement.
			</description>
		</signal>
		<signal name="connection_drag_ended">
			<description>
				Emitted at the end of a connection drag.
			</description>
		</signal>
		<signal name="connection_drag_started">
			<param index="0" name="from_node" type="StringName" />
			<param index="1" name="from_port" type="int" />
			<param index="2" name="is_output" type="bool" />
			<description>
				Emitted at the beginning of a connection drag.
			</description>
		</signal>
		<signal name="connection_from_empty">
			<param index="0" name="to_node" type="StringName" />
			<param index="1" name="to_port" type="int" />
			<param index="2" name="release_position" type="Vector2" />
			<description>
				Emitted when user drags a connection from an input port into the empty space of the graph.
			</description>
		</signal>
		<signal name="connection_request">
			<param index="0" name="from_node" type="StringName" />
			<param index="1" name="from_port" type="int" />
			<param index="2" name="to_node" type="StringName" />
			<param index="3" name="to_port" type="int" />
			<description>
				Emitted to the GraphEdit when the connection between the [param from_port] of the [param from_node] [GraphNode] and the [param to_port] of the [param to_node] [GraphNode] is attempted to be created.
			</description>
		</signal>
		<signal name="connection_to_empty">
			<param index="0" name="from_node" type="StringName" />
			<param index="1" name="from_port" type="int" />
			<param index="2" name="release_position" type="Vector2" />
			<description>
				Emitted when user drags a connection from an output port into the empty space of the graph.
			</description>
		</signal>
		<signal name="copy_nodes_request">
			<description>
				Emitted when the user presses [kbd]Ctrl + C[/kbd].
			</description>
		</signal>
		<signal name="delete_nodes_request">
			<param index="0" name="nodes" type="StringName[]" />
			<description>
				Emitted when attempting to remove a GraphNode from the GraphEdit. Provides a list of node names to be removed (all selected nodes, excluding nodes without closing button).
			</description>
		</signal>
		<signal name="disconnection_request">
			<param index="0" name="from_node" type="StringName" />
			<param index="1" name="from_port" type="int" />
			<param index="2" name="to_node" type="StringName" />
			<param index="3" name="to_port" type="int" />
			<description>
				Emitted to the GraphEdit when the connection between [param from_port] of [param from_node] [GraphNode] and [param to_port] of [param to_node] [GraphNode] is attempted to be removed.
			</description>
		</signal>
		<signal name="duplicate_nodes_request">
			<description>
				Emitted when a GraphNode is attempted to be duplicated in the GraphEdit.
			</description>
		</signal>
		<signal name="end_node_move">
			<description>
				Emitted at the end of a GraphNode movement.
			</description>
		</signal>
		<signal name="node_deselected">
			<param index="0" name="node" type="Node" />
			<description>
			</description>
		</signal>
		<signal name="node_selected">
			<param index="0" name="node" type="Node" />
			<description>
				Emitted when a GraphNode is selected.
			</description>
		</signal>
		<signal name="paste_nodes_request">
			<description>
				Emitted when the user presses [kbd]Ctrl + V[/kbd].
			</description>
		</signal>
		<signal name="popup_request">
			<param index="0" name="position" type="Vector2" />
			<description>
				Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. [param position] is the position of the mouse pointer when the signal is sent.
			</description>
		</signal>
		<signal name="scroll_offset_changed">
			<param index="0" name="offset" type="Vector2" />
			<description>
				Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code.
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="SCROLL_ZOOMS" value="0" enum="PanningScheme">
			[kbd]Mouse Wheel[/kbd] will zoom, [kbd]Ctrl + Mouse Wheel[/kbd] will move the view.
		</constant>
		<constant name="SCROLL_PANS" value="1" enum="PanningScheme">
			[kbd]Mouse Wheel[/kbd] will move the view, [kbd]Ctrl + Mouse Wheel[/kbd] will zoom.
		</constant>
		<constant name="GRID_PATTERN_LINES" value="0" enum="GridPattern">
			Draw the grid using solid lines.
		</constant>
		<constant name="GRID_PATTERN_DOTS" value="1" enum="GridPattern">
			Draw the grid using dots.
		</constant>
	</constants>
	<theme_items>
		<theme_item name="activity" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
			Color the connection line is interpolated to based on the activity value of a connection (see [method set_connection_activity]).
		</theme_item>
		<theme_item name="connection_hover_tint_color" data_type="color" type="Color" default="Color(0, 0, 0, 0.3)">
			Color which is blended with the connection line when the mouse is hovering over it.
		</theme_item>
		<theme_item name="connection_rim_color" data_type="color" type="Color" default="Color(0.1, 0.1, 0.1, 0.6)">
			Color of the rim around each connection line used for making intersecting lines more distinguishable.
		</theme_item>
		<theme_item name="connection_valid_target_tint_color" data_type="color" type="Color" default="Color(1, 1, 1, 0.4)">
			Color which is blended with the connection line when the currently dragged connection is hovering over a valid target port.
		</theme_item>
		<theme_item name="grid_major" data_type="color" type="Color" default="Color(1, 1, 1, 0.2)">
			Color of major grid lines/dots.
		</theme_item>
		<theme_item name="grid_minor" data_type="color" type="Color" default="Color(1, 1, 1, 0.05)">
			Color of minor grid lines/dots.
		</theme_item>
		<theme_item name="selection_fill" data_type="color" type="Color" default="Color(1, 1, 1, 0.3)">
			The fill color of the selection rectangle.
		</theme_item>
		<theme_item name="selection_stroke" data_type="color" type="Color" default="Color(1, 1, 1, 0.8)">
			The outline color of the selection rectangle.
		</theme_item>
		<theme_item name="port_hotzone_inner_extent" data_type="constant" type="int" default="22">
			The horizontal range within which a port can be grabbed (inner side).
		</theme_item>
		<theme_item name="port_hotzone_outer_extent" data_type="constant" type="int" default="26">
			The horizontal range within which a port can be grabbed (outer side).
		</theme_item>
		<theme_item name="grid_toggle" data_type="icon" type="Texture2D">
			The icon for the grid toggle button.
		</theme_item>
		<theme_item name="layout" data_type="icon" type="Texture2D">
			The icon for the layout button for auto-arranging the graph.
		</theme_item>
		<theme_item name="minimap_toggle" data_type="icon" type="Texture2D">
			The icon for the minimap toggle button.
		</theme_item>
		<theme_item name="snapping_toggle" data_type="icon" type="Texture2D">
			The icon for the snapping toggle button.
		</theme_item>
		<theme_item name="zoom_in" data_type="icon" type="Texture2D">
			The icon for the zoom in button.
		</theme_item>
		<theme_item name="zoom_out" data_type="icon" type="Texture2D">
			The icon for the zoom out button.
		</theme_item>
		<theme_item name="zoom_reset" data_type="icon" type="Texture2D">
			The icon for the zoom reset button.
		</theme_item>
		<theme_item name="menu_panel" data_type="style" type="StyleBox">
		</theme_item>
		<theme_item name="panel" data_type="style" type="StyleBox">
			The background drawn under the grid.
		</theme_item>
	</theme_items>
</class>