asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/GraphEdit.xml

405 lines
19 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 14:18:53 +01:00
<class name="GraphEdit" inherits="Control" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them.
</brief_description>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
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 [member OS.low_processor_usage_mode]) when using GraphEdits.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
Entirely removes BIND_VMETHOD in favor of GDVIRTUAL * `_gui_input`, `_input`, `_unhandled_input` and `_unhandled_key_input` are now regular C++ virutal functions. * Everything else converted to GDVIRTUAL * BIND_VMETHOD is gone, always use the new syntax from now on. Creating `_gui_input` method and using the binder to register events will no longer work, simply override the virtual function now.
2021-08-22 17:37:22 +02:00
<method name="_get_connection_line" qualifiers="virtual const">
Refactor GraphEdit connections Remove duplicate bezier code and use Curve instead. Add an overridable method for retrieving the points of a connection line, which makes it posible to create custom connections lines.
2020-07-19 19:11:02 +02:00
<return type="PackedVector2Array" />
<argument index="0" name="from" type="Vector2" />
<argument index="1" name="to" type="Vector2" />
<description>
Virtual method which can be overridden to customize how connections are drawn.
</description>
</method>
Expose connection hot zones in GraphNode
2021-08-23 14:04:18 +02:00
<method name="_is_in_input_hotzone" qualifiers="virtual">
<return type="bool" />
<argument index="0" name="graph_node" type="Object" />
<argument index="1" name="slot_index" type="int" />
<argument index="2" name="mouse_position" type="Vector2" />
<description>
Returns whether the [code]mouse_position[/code] is in the input hot zone.
By default, a hot zone is a [Rect2] positioned such that its center is at [code]graph_node[/code].[method GraphNode.get_connection_input_position]([code]slot_index[/code]) (For output's case, call [method GraphNode.get_connection_output_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(graph_node, slot_index, mouse_position):
var slot_size : Vector2 = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical"))
var slot_pos : Vector2 = graph_node.get_position() + graph_node.get_connection_input_position(slot_index) - slot_size / 2
var rect = Rect2(slot_pos, slot_size)
return rect.has_point(mouse_position)
[/codeblock]
</description>
</method>
<method name="_is_in_output_hotzone" qualifiers="virtual">
<return type="bool" />
<argument index="0" name="graph_node" type="Object" />
<argument index="1" name="slot_index" type="int" />
<argument index="2" name="mouse_position" type="Vector2" />
<description>
Returns whether the [code]mouse_position[/code] 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(graph_node, slot_index, mouse_position):
var slot_size : Vector2 = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical"))
var slot_pos : Vector2 = graph_node.get_position() + graph_node.get_connection_output_position(slot_index) - slot_size / 2
var rect = Rect2(slot_pos, slot_size)
return rect.has_point(mouse_position)
[/codeblock]
</description>
</method>
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<method name="add_valid_connection_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="from_type" type="int" />
<argument index="1" name="to_type" type="int" />
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<description>
Makes possible the connection between two different slot types. The type is defined with the [method GraphNode.set_slot] method.
</description>
</method>
<method name="add_valid_left_disconnect_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="type" type="int" />
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<description>
Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type.
</description>
</method>
<method name="add_valid_right_disconnect_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="type" type="int" />
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<description>
Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type.
</description>
</method>
Automatic arrangement of nodes in VisualScript/VisualShaders editors This PR and commit adds the functionality to arrange nodes in VisualScript/VisualShader editor. The layout generated by this feature is compact, with minimum crossings between connections & uniform horizontal & vertical gaps between the nodes. This work has been sponsored by GSoC '21. Full list of additions/changes: • Added arrange_nodes() method in GraphEdit module. • This method computes new positions for all the selected nodes by forming blocks and compressing them. The nodes are moved to these new positions. • Adding this method to GraphEdit makes it available for use in VisualScript/VisualShaders editors and its other subclasses. • Button with an icon has been added to call arrange_nodes() in GraphEdit. • This button is inherited by VisualScript/VisualShaders editors to invoke the method. • Undo/redo is functional with this method. • By using signals in arrange_nodes(), position changes are registered in undo/redo stack of the subclass that is using the method. • Metadata of the method has been updated in ClassDB • Method description has been added to class reference of GraphEdit
2021-08-10 21:14:19 +02:00
<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>
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<method name="clear_connections">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Removes all connections between nodes.
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="connect_node">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" enum="Error" />
<argument index="0" name="from" type="StringName" />
<argument index="1" name="from_port" type="int" />
<argument index="2" name="to" type="StringName" />
<argument index="3" name="to_port" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Create a connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection already exists, no connection is created.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="disconnect_node">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="from" type="StringName" />
<argument index="1" name="from_port" type="int" />
<argument index="2" name="to" type="StringName" />
<argument index="3" name="to_port" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Removes the connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection does not exist, no connection is removed.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Add `GraphEdit` drag notifications This commit adds two signals: * connection_drag_begun, which is emitted when a connection is started to be created by the user and * `connection_drag_ended`, which is emitted when no longer a connection is created. Additionally `force_connection_drag_end()` adds the possibility to end the connection dragging. If called from user code, no other connection request signals are invoked. This is useful to add `GraphNode`s via shortcuts while the user is dragging a connection to directly connect the newly added node.
2021-07-26 16:31:31 +02:00
<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.
Rename GraphEdit connection_drag_begun to connection_drag_started
2022-01-06 22:01:01 +01:00
This is best used together with [signal connection_drag_started] and [signal connection_drag_ended] to add custom behavior like node addition through shortcuts.
Add `GraphEdit` drag notifications This commit adds two signals: * connection_drag_begun, which is emitted when a connection is started to be created by the user and * `connection_drag_ended`, which is emitted when no longer a connection is created. Additionally `force_connection_drag_end()` adds the possibility to end the connection dragging. If called from user code, no other connection request signals are invoked. This is useful to add `GraphNode`s via shortcuts while the user is dragging a connection to directly connect the newly added node.
2021-07-26 16:31:31 +02:00
[b]Note:[/b] This method suppresses any other connection request signals apart from [signal connection_drag_ended].
</description>
</method>
Refactor GraphEdit connections Remove duplicate bezier code and use Curve instead. Add an overridable method for retrieving the points of a connection line, which makes it posible to create custom connections lines.
2020-07-19 19:11:02 +02:00
<method name="get_connection_line">
<return type="PackedVector2Array" />
<argument index="0" name="from" type="Vector2" />
<argument index="1" name="to" type="Vector2" />
<description>
Returns the points which would make up a connection between [code]from[/code] and [code]to[/code].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="get_connection_list" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Array" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Returns an Array containing the list of connections. A connection consists in a structure of the form [code]{ from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" }[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<method name="get_zoom_hbox">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="HBoxContainer" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
Add warnings to methods that give access to internal nodes
2021-10-10 21:28:56 +02:00
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.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="is_node_connected">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="from" type="StringName" />
<argument index="1" name="from_port" type="int" />
<argument index="2" name="to" type="StringName" />
<argument index="3" name="to_port" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Returns [code]true[/code] if the [code]from_port[/code] slot of the [code]from[/code] GraphNode is connected to the [code]to_port[/code] slot of the [code]to[/code] GraphNode.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<method name="is_valid_connection_type" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="from_type" type="int" />
<argument index="1" name="to_type" type="int" />
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<description>
Returns whether it's possible to connect slots of the specified types.
</description>
</method>
<method name="remove_valid_connection_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="from_type" type="int" />
<argument index="1" name="to_type" type="int" />
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<description>
Makes it not possible to connect between two different slot types. The type is defined with the [method GraphNode.set_slot] method.
</description>
</method>
<method name="remove_valid_left_disconnect_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="type" type="int" />
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<description>
Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type.
</description>
</method>
<method name="remove_valid_right_disconnect_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="type" type="int" />
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
<description>
Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type.
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<method name="set_connection_activity">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="from" type="StringName" />
<argument index="1" name="from_port" type="int" />
<argument index="2" name="to" type="StringName" />
<argument index="3" name="to_port" type="int" />
<argument index="4" name="amount" type="float" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
Add [theme_item] tag to editor help
2021-11-18 15:03:03 +01:00
Sets the coloration of the connection between [code]from[/code]'s [code]from_port[/code] and [code]to[/code]'s [code]to_port[/code] with the color provided in the [theme_item activity] theme property.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="set_selected">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="node" type="Node" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Expose a few GraphEdit methods to script languages
2018-01-31 01:09:41 +01:00
Sets the specified [code]node[/code] as the one selected.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
<members>
Rename Control's Rect properties to exclude rect_ part
2022-01-23 18:14:31 +01:00
<member name="clip_contents" type="bool" setter="set_clip_contents" getter="is_clipping_contents" overrides="Control" default="true" />
Added GraphEdit properties to control lines thickness and antialiasing
2020-12-18 14:13:28 +01:00
<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_thickness" type="float" setter="set_connection_lines_thickness" getter="get_connection_lines_thickness" default="2.0">
The thickness of the lines between the nodes.
</member>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 20:38:49 +01:00
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="2" />
Add a minimap to the GraphEdit
2020-11-06 20:16:45 +01:00
<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>
FIx visual issues with GraphEdit minimap
2020-12-17 18:40:32 +01:00
<member name="minimap_opacity" type="float" setter="set_minimap_opacity" getter="get_minimap_opacity" default="0.65">
Add a minimap to the GraphEdit
2020-11-06 20:16:45 +01:00
The opacity of the minimap rectangle.
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02:00
<member name="minimap_size" type="Vector2" setter="set_minimap_size" getter="get_minimap_size" default="Vector2(240, 160)">
Add a minimap to the GraphEdit
2020-11-06 20:16:45 +01:00
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>
Unify panning in sub-editors and make it configurable
2021-09-28 18:00:16 +02:00
<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>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="right_disconnects" type="bool" setter="set_right_disconnects" getter="is_right_disconnects_enabled" default="false">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
If [code]true[/code], enables disconnection of existing connections in the GraphEdit by dragging the right end.
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02:00
<member name="scroll_offset" type="Vector2" setter="set_scroll_ofs" getter="get_scroll_ofs" default="Vector2(0, 0)">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
The scroll offset.
</member>
Make zoom limits and step adjustable in GraphEdit
2021-06-16 15:14:25 +02:00
<member name="show_zoom_label" type="bool" setter="set_show_zoom_label" getter="is_showing_zoom_label" default="false">
If [code]true[/code], makes a label with the current zoom level visible. The zoom value is displayed in percents.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="snap_distance" type="int" setter="set_snap" getter="get_snap" default="20">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
The snapping distance in pixels.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="use_snap" type="bool" setter="set_use_snap" getter="is_using_snap" default="true">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
If [code]true[/code], enables snapping.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="zoom" type="float" setter="set_zoom" getter="get_zoom" default="1.0">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
The current zoom value.
</member>
Make zoom limits and step adjustable in GraphEdit
2021-06-16 15:14:25 +02:00
<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>
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<signals>
Removed underscore from GraphEdit begin/end_node_move signals
2020-10-20 08:22:40 +02:00
<signal name="begin_node_move">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted at the beginning of a GraphNode movement.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</signal>
Rename GraphEdit connection_drag_begun to connection_drag_started
2022-01-06 22:01:01 +01:00
<signal name="connection_drag_ended">
<description>
Emitted at the end of a connection drag.
</description>
</signal>
<signal name="connection_drag_started">
Add `GraphEdit` drag notifications This commit adds two signals: * connection_drag_begun, which is emitted when a connection is started to be created by the user and * `connection_drag_ended`, which is emitted when no longer a connection is created. Additionally `force_connection_drag_end()` adds the possibility to end the connection dragging. If called from user code, no other connection request signals are invoked. This is useful to add `GraphNode`s via shortcuts while the user is dragging a connection to directly connect the newly added node.
2021-07-26 16:31:31 +02:00
<argument index="0" name="from" type="String" />
<argument index="1" name="slot" type="String" />
<argument index="2" name="is_output" type="bool" />
<description>
Emitted at the beginning of a connection drag.
</description>
</signal>
doc: Sync classref with current source
2019-06-29 12:24:18 +02:00
<signal name="connection_from_empty">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<argument index="0" name="to" type="StringName" />
<argument index="1" name="to_slot" type="int" />
<argument index="2" name="release_position" type="Vector2" />
doc: Sync classref with current source
2019-06-29 12:24:18 +02:00
<description>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted when user dragging connection from input port into empty space of the graph.
doc: Sync classref with current source
2019-06-29 12:24:18 +02:00
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<signal name="connection_request">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<argument index="0" name="from" type="StringName" />
<argument index="1" name="from_slot" type="int" />
<argument index="2" name="to" type="StringName" />
<argument index="3" name="to_slot" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted to the GraphEdit when the connection between the [code]from_slot[/code] slot of the [code]from[/code] GraphNode and the [code]to_slot[/code] slot of the [code]to[/code] GraphNode is attempted to be created.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</signal>
<signal name="connection_to_empty">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<argument index="0" name="from" type="StringName" />
<argument index="1" name="from_slot" type="int" />
<argument index="2" name="release_position" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted when user dragging connection from output port into empty space of the graph.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</signal>
Implement copy/paste in visual shaders
2019-07-12 19:36:33 +02:00
<signal name="copy_nodes_request">
doc: Sync classref with current source
2019-08-05 15:21:03 +02:00
<description>
Improve shortcut formatting in docs
2020-03-10 11:41:36 +01:00
Emitted when the user presses [kbd]Ctrl + C[/kbd].
doc: Sync classref with current source
2019-08-05 15:21:03 +02:00
</description>
Implement copy/paste in visual shaders
2019-07-12 19:36:33 +02:00
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<signal name="delete_nodes_request">
<description>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted when a GraphNode is attempted to be removed from the GraphEdit.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</signal>
<signal name="disconnection_request">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<argument index="0" name="from" type="StringName" />
<argument index="1" name="from_slot" type="int" />
<argument index="2" name="to" type="StringName" />
<argument index="3" name="to_slot" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Emitted to the GraphEdit when the connection between [code]from_slot[/code] slot of [code]from[/code] GraphNode and [code]to_slot[/code] slot of [code]to[/code] GraphNode is attempted to be removed.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</signal>
<signal name="duplicate_nodes_request">
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Emitted when a GraphNode is attempted to be duplicated in the GraphEdit.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</signal>
Removed underscore from GraphEdit begin/end_node_move signals
2020-10-20 08:22:40 +02:00
<signal name="end_node_move">
<description>
Emitted at the end of a GraphNode movement.
</description>
</signal>
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<signal name="node_deselected">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<argument index="0" name="node" type="Node" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
</description>
</signal>
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<signal name="node_selected">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<argument index="0" name="node" type="Node" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<description>
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
Emitted when a GraphNode is selected.
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</description>
</signal>
Implement copy/paste in visual shaders
2019-07-12 19:36:33 +02:00
<signal name="paste_nodes_request">
doc: Sync classref with current source
2019-08-05 15:21:03 +02:00
<description>
Improve shortcut formatting in docs
2020-03-10 11:41:36 +01:00
Emitted when the user presses [kbd]Ctrl + V[/kbd].
doc: Sync classref with current source
2019-08-05 15:21:03 +02:00
</description>
Implement copy/paste in visual shaders
2019-07-12 19:36:33 +02:00
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<signal name="popup_request">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<argument index="0" name="position" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. [code]position[/code] is the position of the mouse pointer when the signal is sent.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</signal>
<signal name="scroll_offset_changed">
Rename theme properties to include underscores - check_vadjust -> check_v_adjust - close_h_ofs -> close_h_offset - close_v_ofs -> close_v_offset - commentfocus -> comment_focus - hseparation -> h_separation - ofs -> offset - selectedframe -> selected_frame - state_machine_selectedframe -> state_machine_selected_frame - table_hseparation -> table_h_separation - table_vseparation -> table_v_separation - vseparation -> v_separation
2022-04-14 23:20:28 +02:00
<argument index="0" name="offset" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</signal>
</signals>
Unify panning in sub-editors and make it configurable
2021-09-28 18:00:16 +02:00
<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>
</constants>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<theme_items>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="activity" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="grid_major" data_type="color" type="Color" default="Color(1, 1, 1, 0.2)">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
Color of major grid lines.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="grid_minor" data_type="color" type="Color" default="Color(1, 1, 1, 0.05)">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
Color of minor grid lines.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="selection_fill" data_type="color" type="Color" default="Color(1, 1, 1, 0.3)">
The fill color of the selection rectangle.
Automatic arrangement of nodes in VisualScript/VisualShaders editors This PR and commit adds the functionality to arrange nodes in VisualScript/VisualShader editor. The layout generated by this feature is compact, with minimum crossings between connections & uniform horizontal & vertical gaps between the nodes. This work has been sponsored by GSoC '21. Full list of additions/changes: • Added arrange_nodes() method in GraphEdit module. • This method computes new positions for all the selected nodes by forming blocks and compressing them. The nodes are moved to these new positions. • Adding this method to GraphEdit makes it available for use in VisualScript/VisualShaders editors and its other subclasses. • Button with an icon has been added to call arrange_nodes() in GraphEdit. • This button is inherited by VisualScript/VisualShaders editors to invoke the method. • Undo/redo is functional with this method. • By using signals in arrange_nodes(), position changes are registered in undo/redo stack of the subclass that is using the method. • Metadata of the method has been updated in ClassDB • Method description has been added to class reference of GraphEdit
2021-08-10 21:14:19 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="selection_stroke" data_type="color" type="Color" default="Color(1, 1, 1, 0.8)">
The outline color of the selection rectangle.
Added GraphEdit properties to control lines thickness and antialiasing
2020-12-18 14:13:28 +01:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="bezier_len_neg" data_type="constant" type="int" default="160">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="bezier_len_pos" data_type="constant" type="int" default="80">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Better port handling connection for `GraphEdit`
2021-08-11 16:43:05 +02:00
<theme_item name="port_grab_distance_horizontal" data_type="constant" type="int" default="24">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The horizontal range within which a port can be grabbed (on both sides).
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</theme_item>
Update default port_grab_distance_vertical
2021-12-29 18:53:11 +01:00
<theme_item name="port_grab_distance_vertical" data_type="constant" type="int" default="26">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The vertical range within which a port can be grabbed (on both sides).
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="layout" data_type="icon" type="Texture2D">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="minimap" data_type="icon" type="Texture2D">
Make possible to edit the GraphEdit's selection rect colors
2020-01-08 03:09:40 +01:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="minus" data_type="icon" type="Texture2D">
The icon for the zoom out button.
</theme_item>
<theme_item name="more" data_type="icon" type="Texture2D">
The icon for the zoom in button.
</theme_item>
<theme_item name="reset" data_type="icon" type="Texture2D">
The icon for the zoom reset button.
Make possible to edit the GraphEdit's selection rect colors
2020-01-08 03:09:40 +01:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="snap" data_type="icon" type="Texture2D">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The icon for the snap toggle button.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="bg" data_type="style" type="StyleBox">
The background drawn under the grid.
</theme_item>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_items>
</class>
Reference in a new issue Copy permalink