godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-11 13:10:58 +00:00
Code Releases Wiki Activity

Merge pull request #52015 from mechPenSketch/expose_hotzones2

Browse Source 
Expose connection hot zones in `GraphNode`
This commit is contained in:
Rémi Verschelde
2021-12-15 20:23:07 +01:00
committed by GitHub
parent 1cbf3947d6 0449b30bbc
commit deb30a4108
3 changed files with 68 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
doc/classes/GraphEdit.xml
View File

@@ -18,6 +18,43 @@
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" />
<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>
<method name="add_valid_connection_type">
<return type="void" />
<argument index="0" name="from_type" type="int" />