GaeaGraph deep duplication + Duplicate button (#431)

* Added a custom _duplicate method for to GaeaGraph

Still needs to be set up to properly duplicate collections

* Added a duplicate button to the Gaea editor panel; used GaeaGraph.duplicate and a file dialog to duplicate the graph.

* Light tweaks to GaeaGraph (added _get_unique_resources method), added duplicate_test (just a copy of generate_test for now).

* Gave the Duplicate button an icon

* GaeaGraph now properly initializes (by calling _setup_local_to_scene) when assigned to a generator.

* Removed (incomplete) duplicate test

* Simplified GaeaGraph's _duplicate method to only what actually gets saved to it's resource file.

* Added a class name to walker_demo

* Added a series of graph tests (assign_to_generator, duplicate, assign_duplicate)

* Added github workflow for new Graph testing

* Added the contents of testing\graph\graph_test.gd into testing\other\gaea_graph.gd

* generator.gd is no longer calling GaeaGraph's private _refresh method. Instead _refresh gets called upon setting the generator property.

* Using duplicate_deep for duplication of GaeaGraph.

* Added tooltip for the Duplicate button, and elaborated the Load button.

* Added compare_dictionaries helper method to gaea_graph testing class

* Added proper assertions to duplicate and assign_to_generator methods. Deleted assign_duplicate test (it was redundant).

* Renamed "duplicate" stuff to "duplicate_graph" for clarity, in case other kinds of duplication appear later.

* Naming, typos and formatting tweaks.

* Added get_raw_connections and get_all_node_data as getters for _connections and _node_data respectively

* Fixed trailing whitespace

---------

Co-authored-by: BenjaTK <73806216+BenjaTK@users.noreply.github.com>

Author: cullumi

addons/gaea/editor/panel.gd

@@ -28,9 +28,11 @@ var _dragged_from_left: bool = false
 @onready var _search_bar: LineEdit = %SearchBar
 @onready var _save_button: Button = %SaveButton
 @onready var _load_button: Button = %LoadButton
+@onready var _duplicate_graph_button: Button = %DuplicateGraphButton
 @onready var _reload_node_tree_button: Button = %ReloadNodeTreeButton
 @onready var _reload_parameters_list_button: Button = %ReloadParametersListButton
-@onready var _file_dialog: FileDialog = $FileDialog
+@onready var _file_open_dialog: FileDialog = $OpenFileDialog
+@onready var _file_save_dialog: FileDialog = $SaveFileDialog
 @onready var _online_docs_button: Button = %OnlineDocsButton
 @onready var _window_popout_separator: VSeparator = %WindowPopoutSeparator
 @onready var _window_popout_button: Button = %WindowPopoutButton
@@ -52,6 +54,9 @@ func _ready() -> void:
 	_reload_parameters_list_button.icon = preload("uid://cwg7oy4i2cbwq")
 	_save_button.icon = EditorInterface.get_base_control().get_theme_icon(&"Save", &"EditorIcons")
 	_load_button.icon = EditorInterface.get_base_control().get_theme_icon(&"Load", &"EditorIcons")
+	_duplicate_graph_button.icon = EditorInterface.get_base_control().get_theme_icon(
+		&"Duplicate", &"EditorIcons"
+	)
 	_window_popout_button.icon = EditorInterface.get_base_control().get_theme_icon(
 		&"MakeFloating", &"EditorIcons"
 	)
@@ -539,6 +544,10 @@ func _on_graph_edit_connection_from_empty(
 
 
 #region Buttons
+func _on_duplicate_graph_button_pressed() -> void:
+	_file_save_dialog.popup_centered()
+
+
 func _on_generate_button_pressed() -> void:
 	_selected_generator.generate()
 
@@ -547,13 +556,18 @@ func _on_reload_node_tree_button_pressed() -> void:
 	_create_node_tree.populate()
 
 func _on_load_button_pressed() -> void:
-	_file_dialog.popup_centered()
+	_file_open_dialog.popup_centered()
 
 
-func _on_file_dialog_file_selected(path: String) -> void:
+func _on_open_file_dialog_selected(path: String) -> void:
 	_selected_generator.data = load(path)
 
 
+func _on_save_file_dialog_selected(path: String) -> void:
+	var copy: GaeaGraph = _selected_generator.data.duplicate_deep(Resource.DEEP_DUPLICATE_INTERNAL)
+	ResourceSaver.save(copy, path)
+
+
 func _on_reload_parameters_list_button_pressed() -> void:
 	if (
 		not is_instance_valid(_selected_generator)

addons/gaea/editor/panel.tscn

@@ -128,14 +128,19 @@ flat = true
 
 [node name="LoadButton" type="Button" parent="Editor/VBoxContainer/HBoxContainer"]
 unique_name_in_owner = true
-visible = false
 layout_mode = 2
-tooltip_text = "Load data."
+tooltip_text = "Assign a graph to this generator."
 icon = SubResource("ImageTexture_ve3i7")
 flat = true
 
+[node name="DuplicateGraphButton" type="Button" parent="Editor/VBoxContainer/HBoxContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+size_flags_horizontal = 8
+tooltip_text = "Duplicate this graph."
+flat = true
+
 [node name="VSeparator" type="VSeparator" parent="Editor/VBoxContainer/HBoxContainer"]
-visible = false
 layout_mode = 2
 
 [node name="ReloadNodeTreeButton" type="Button" parent="Editor/VBoxContainer/HBoxContainer"]
@@ -373,19 +378,25 @@ item_0/id = 0
 script = ExtResource("7_dhpru")
 graph_edit = NodePath("../VBoxContainer/GraphEdit")
 
-[node name="FileDialog" type="FileDialog" parent="."]
+[node name="OpenFileDialog" type="FileDialog" parent="."]
 title = "Open a File"
 ok_button_text = "Open"
 file_mode = 0
 filters = PackedStringArray("*.tres,*.res;Resources")
 
+[node name="SaveFileDialog" type="FileDialog" parent="."]
+auto_translate_mode = 1
+title = "Save a Copy"
+filters = PackedStringArray("*.tres,*.res;Resources")
+
 [node name="AboutWindow" parent="." instance=ExtResource("9_affj1")]
 visible = false
 exclusive = true
 
 [connection signal="pressed" from="NoData/NewDataButton" to="." method="_on_new_data_button_pressed"]
 [connection signal="pressed" from="Editor/VBoxContainer/HBoxContainer/SaveButton" to="." method="_on_save_button_pressed"]
 [connection signal="pressed" from="Editor/VBoxContainer/HBoxContainer/LoadButton" to="." method="_on_load_button_pressed"]
+[connection signal="pressed" from="Editor/VBoxContainer/HBoxContainer/DuplicateGraphButton" to="." method="_on_duplicate_graph_button_pressed"]
 [connection signal="pressed" from="Editor/VBoxContainer/HBoxContainer/ReloadNodeTreeButton" to="." method="_on_reload_node_tree_button_pressed"]
 [connection signal="pressed" from="Editor/VBoxContainer/HBoxContainer/ReloadParametersListButton" to="." method="_on_reload_parameters_list_button_pressed"]
 [connection signal="pressed" from="Editor/VBoxContainer/HBoxContainer/GenerateButton" to="." method="_on_generate_button_pressed"]
@@ -419,4 +430,5 @@ exclusive = true
 [connection signal="pressed" from="Editor/CreateNodePopup/MainContentContainer/VBox/HBoxContainer/CreateButton" to="Editor/CreateNodePopup/MainContentContainer/VBox/CreateNodeTree" method="_on_create_button_pressed"]
 [connection signal="create_node_popup_requested" from="Editor/ContextMenu" to="." method="_popup_create_node_menu_at_mouse"]
 [connection signal="new_reroute_requested" from="Editor/LinkPopup" to="." method="_on_new_reroute_requested"]
-[connection signal="file_selected" from="FileDialog" to="." method="_on_file_dialog_file_selected"]
+[connection signal="file_selected" from="OpenFileDialog" to="." method="_on_open_file_dialog_selected"]
+[connection signal="file_selected" from="SaveFileDialog" to="." method="_on_save_file_dialog_selected"]

addons/gaea/resources/gaea_graph.gd

@@ -44,14 +44,17 @@ const CURRENT_SAVE_VERSION := 5
 ## "from_node-from_port-to_node-to_port" (ex.: 1-0-2-1). That format
 ## can be converted into a connections dictionary using various methods in this class.[br]
 ## [br][color=yellow][b]Warning:[/b][/color] Setting this directly can break your saved graph.
-@export_storage var _connections: Array[StringName]
+@export_storage var _connections: Array[StringName] :
+	get = get_raw_connections
 ## Saved data for each [GaeaNodeResource] such as position in the graph and changed arguments.
 ## [br][color=yellow][b]Warning:[/b][/color] Setting this directly can break your saved graph.
-@export_storage var _node_data: Dictionary[int, Dictionary]
+@export_storage var _node_data: Dictionary[int, Dictionary] :
+	get = get_all_node_data
 ## List of parameters created with [GaeaNodeParameter].
 ## [br][color=yellow][b]Warning:[/b][/color] Setting this directly can break your saved graph.
 ## Use [method set_parameter] instead.
-@export_storage var _parameters: Dictionary[StringName, Variant] : get = get_parameter_list
+@export_storage var _parameters: Dictionary[StringName, Variant] :
+	get = get_parameter_list
 
 ## @deprecated: Kept for migration of old save data.
 var connections: Array[Dictionary]
@@ -73,7 +76,10 @@ var scroll_offset: Vector2 = Vector2(NAN, NAN)
 ## in the current session.
 var zoom: float = 1.0
 ## The currently related generator.
-var generator: GaeaGenerator
+var generator: GaeaGenerator :
+	set(value):
+		generator = value
+		_refresh()
 ## Cache used during generation to avoid recalculating data unnecessarily.
 ## The inner dictionary keys are the slot output port names, and the values are the cached data.
 var cache: Dictionary[GaeaNodeResource, Dictionary] = {}
@@ -84,7 +90,12 @@ var _resources: Dictionary[int, GaeaNodeResource]
 
 
 func _init() -> void:
+	_refresh()
+
+
+func _refresh() -> void:
 	resource_local_to_scene = true
+	_setup_local_to_scene()
 	notify_property_list_changed()
 
 
@@ -293,6 +304,11 @@ func get_ids() -> Array[int]:
 	return _node_data.keys()
 
 
+## Returns all node data.
+func get_all_node_data() -> Dictionary[int, Dictionary]:
+	return _node_data
+
+
 ## Returns an available id.
 func get_next_available_id() -> int:
 	var ids := get_ids()
@@ -356,6 +372,11 @@ func get_all_connections() -> Array[Dictionary]:
 	return all_connections
 
 
+## Returns all connections in the graph in the form "from_node-from_port-to_node-to_port" (ex.: 1-0-2-1)
+func get_raw_connections() -> Array[StringName]:
+	return _connections
+
+
 ## Returns all connections to and from the specified node as dictionaries.
 func get_node_connections(id: int) -> Array[Dictionary]:
 	return get_connections_to(id) + get_connections_from(id)
@@ -487,6 +508,13 @@ func _setup_local_to_scene() -> void:
 		GaeaGraphMigration.migrate(self)
 
 	_resources.clear()
+	var uniques = _get_unique_resources()
+	for id in uniques.keys():
+		_resources.set(id, uniques[id])
+
+
+func _get_unique_resources() -> Dictionary[Variant, GaeaNodeResource]:
+	var uniques: Dictionary[Variant, GaeaNodeResource] = {}
 	for id in _node_data.keys():
 		var base_uid: String = get_node_data(id).get(&"uid", "")
 		if base_uid.is_empty():
@@ -495,6 +523,7 @@ func _setup_local_to_scene() -> void:
 		var resource: GaeaNodeResource = load(base_uid).new()
 		if not resource is GaeaNodeResource:
 			push_error("Something went wrong, the resource at %s is not a GaeaNodeResource" % base_uid)
-			return
+			return uniques
 		resource._load_save_data(data)
-		_resources.set(id, resource)
+		uniques.set(id, resource)
+	return uniques

scenes/walker_demo/walker_demo.gd

@@ -1,13 +1,11 @@
 extends Node2D
-
+class_name GaeaWalkerDemo
 
 @onready var gaea_generator: GaeaGenerator = $GaeaGenerator
 
 var last_grid: GaeaGrid
 
 
-
-
 ## Used for integration testing.
 func test_generation(fixed_seed: int = 0) -> void:
 	gaea_generator.world_size = Vector3i(45, 45, 1)