From fdb962ba3b74bd17084b3b86afb84ddc0c642914 Mon Sep 17 00:00:00 2001
From: Variable <77773850+Variable-ind@users.noreply.github.com>
Date: Thu, 18 May 2023 15:58:41 +0500
Subject: [PATCH] Changes to PanelAPI (#858)

1) Added tab is now set by layout instead of specifying an "alongside_node"
2) Added tab is now shown in the Panels submenu
---
 src/Autoload/ExtensionsAPI.gd | 78 ++++++++++++++++++++++++++---------
 1 file changed, 59 insertions(+), 19 deletions(-)

diff --git a/src/Autoload/ExtensionsAPI.gd b/src/Autoload/ExtensionsAPI.gd
index 5eedf9f66..01ab0aed5 100644
--- a/src/Autoload/ExtensionsAPI.gd
+++ b/src/Autoload/ExtensionsAPI.gd
@@ -2,14 +2,14 @@
 extends Node
 
 # use these variables in your extension to access the api
-var general = GeneralAPI.new()
-var menu = MenuAPI.new()
-var dialog = DialogAPI.new()
-var panel = PanelAPI.new()
-var theme = ThemeAPI.new()
-var tools = ToolAPI.new()
-var project = ProjectAPI.new()
-var signals = SignalsAPI.new()
+var general := GeneralAPI.new()
+var menu := MenuAPI.new()
+var dialog := DialogAPI.new()
+var panel := PanelAPI.new()
+var theme := ThemeAPI.new()
+var tools := ToolAPI.new()
+var project := ProjectAPI.new()
+var signals := SignalsAPI.new()
 
 # This fail-safe below is designed to work ONLY if Pixelorama is launched in Godot Editor
 var _action_history: Dictionary = {}
@@ -51,6 +51,12 @@ func remove_action(action: String):
 			_action_history[extension_name].erase(action)
 
 
+func wait_frame():  # as yield is not available to classes below, so this is the solution
+	# use by yield(ExtensionsApi.wait_frame(), "completed")
+	yield(get_tree(), "idle_frame")
+	yield(get_tree(), "idle_frame")
+
+
 func _get_caller_extension_name() -> String:
 	var stack = get_stack()
 	for trace in stack:
@@ -158,30 +164,63 @@ class PanelAPI:
 		var dockable := _get_dockable_container_ui()
 		return dockable.get_tabs_visible()
 
-	func add_node_as_tab(node: Node, alongside_node: String) -> void:
+	func add_node_as_tab(node: Node) -> void:
 		var dockable := _get_dockable_container_ui()
-		dockable.add_child(node)
-		var tab = _find_tab_with_node(alongside_node, dockable)
-		if not tab:
-			push_error("Tab not found")
+		var top_menu_container = Global.top_menu_container
+		var panels_submenu: PopupMenu = top_menu_container.panels_submenu
+		# adding the node to the first tab we find, it'll be re-ordered by layout anyway
+		var tabs = _get_tabs_in_root(dockable.layout.root)
+		if tabs.size() != 0:
+			dockable.add_child(node)
+			tabs[0].insert_node(0, node)  # Insert at the beginning
+		else:
+			push_error("No Tabs Found!!!")
 			return
-		tab.insert_node(0, node)  # Insert at the beginning
+		top_menu_container.ui_elements.append(node)
+		# refreshing Panels submenu
+		var new_elements = top_menu_container.ui_elements
+		panels_submenu.clear()
+		for element in new_elements:
+			panels_submenu.add_check_item(element.name)
+			var is_hidden: bool = dockable.is_control_hidden(element)
+			panels_submenu.set_item_checked(new_elements.find(element), !is_hidden)
+		# re-assigning layout
+		top_menu_container.set_layout(top_menu_container.selected_layout)
+		# we must make tabs_visible = true for a few moments if it is false
+		if dockable.tabs_visible == false:
+			dockable.tabs_visible = true
+			yield(ExtensionsApi.wait_frame(), "completed")
+			dockable.tabs_visible = false
 		ExtensionsApi.add_action("add_tab")
-		# INSTRUCTION
-		# After this check if tabs are invisible, if they are, then make tabs visible
-		# and after doing yield(get_tree(), "idle_frame") twice make them invisible again
 
 	func remove_node_from_tab(node: Node) -> void:
+		var top_menu_container = Global.top_menu_container
+		var dockable = Global.control.find_node("DockableContainer")
+		var panels_submenu: PopupMenu = top_menu_container.panels_submenu
+		# find the tab that contains the node
 		if node == null:
 			return
-		var dockable = Global.control.find_node("DockableContainer")
 		var tab = _find_tab_with_node(node.name, dockable)
 		if not tab:
 			push_error("Tab not found")
 			return
+		# remove node from that tab
 		tab.remove_node(node)
 		node.get_parent().remove_child(node)
+		top_menu_container.ui_elements.erase(node)
 		node.queue_free()
+		# refreshing Panels submenu
+		var new_elements = top_menu_container.ui_elements
+		panels_submenu.clear()
+		for element in new_elements:
+			panels_submenu.add_check_item(element.name)
+			var is_hidden: bool = dockable.is_control_hidden(element)
+			panels_submenu.set_item_checked(new_elements.find(element), !is_hidden)
+		# we must make tabs_visible = true for a few moments if it is false
+		if dockable.tabs_visible == false:
+			dockable.tabs_visible = true
+			yield(ExtensionsApi.wait_frame(), "completed")
+			dockable.tabs_visible = false
 		ExtensionsApi.remove_action("add_tab")
 
 	# PRIVATE METHODS
@@ -197,7 +236,7 @@ class PanelAPI:
 				return tab
 		return null
 
-	func _get_tabs_in_root(parent_resource):
+	func _get_tabs_in_root(parent_resource) -> Array:
 		var parents := []  # Resources have no get_parent_resource() so this is an alternative
 		var scanned := []  # To keep track of already discovered layout_split resources
 		var child_number := 0
@@ -238,6 +277,7 @@ class PanelAPI:
 				# If there is no parent left to get scanned
 				if scan_target == null:
 					return tabs
+		return tabs
 
 
 class ThemeAPI: