Make bottom panel into available dock slot

Author: KoBeWi

doc/classes/EditorDock.xml

@@ -63,9 +63,9 @@
 		</method>
 	</methods>
 	<members>
-		<member name="available_layouts" type="int" setter="set_available_layouts" getter="get_available_layouts" enum="EditorDock.DockLayout" is_bitfield="true" default="1">
-			The available layouts for this dock, as a bitmask.
-			If you want to make all layouts available, use [code]available_layouts = DOCK_LAYOUT_VERTICAL | DOCK_LAYOUT_HORIZONTAL[/code].
+		<member name="available_layouts" type="int" setter="set_available_layouts" getter="get_available_layouts" enum="EditorDock.DockLayout" is_bitfield="true" default="5">
+			The available layouts for this dock, as a bitmask. By default, the dock allows vertical and floating layouts.
+			If you want to make all layouts available, use [code]available_layouts = DOCK_LAYOUT_VERTICAL | DOCK_LAYOUT_HORIZONTAL | DOCK_LAYOUT_FLOATING[/code].
 		</member>
 		<member name="clip_contents" type="bool" setter="set_clip_contents" getter="is_clipping_contents" overrides="Control" default="true" />
 		<member name="default_slot" type="int" setter="set_default_slot" getter="get_default_slot" enum="EditorPlugin.DockSlot" default="-1">
@@ -78,6 +78,12 @@
 		<member name="dock_shortcut" type="Shortcut" setter="set_dock_shortcut" getter="get_dock_shortcut">
 			The shortcut used to open the dock. This property can only be set before this dock is added via [method EditorPlugin.add_dock].
 		</member>
+		<member name="global" type="bool" setter="set_global" getter="is_global" default="true">
+			If [code]true[/code], the dock appears in the Editor &gt; Editor Docks menu and can be closed.
+		</member>
+		<member name="hidden" type="bool" setter="set_hidden" getter="is_hidden" default="false">
+			If [code]true[/code], the dock's tab will be hidden. If [member global] is [code]true[/code], the dock will not appear in the dock menu.
+		</member>
 		<member name="icon_name" type="StringName" setter="set_icon_name" getter="get_icon_name" default="&amp;&quot;&quot;">
 			The icon for the dock, as a name from the [code]EditorIcons[/code] theme type in the editor theme. You can find the list of available icons [url=https://godot-editor-icons.github.io/]here[/url].
 		</member>
@@ -87,14 +93,19 @@
 		<member name="title" type="String" setter="set_title" getter="get_title" default="&quot;&quot;">
 			The title of the dock's tab. If empty, the dock's [member Node.name] will be used. If the name is auto-generated (contains [code]@[/code]), the first child's name will be used instead.
 		</member>
+		<member name="title_color" type="Color" setter="set_title_color" getter="get_title_color" default="Color(0, 0, 0, 0)">
+			Color of the dock tab's title. If transparent, default color will be used.
+		</member>
 	</members>
 	<constants>
 		<constant name="DOCK_LAYOUT_VERTICAL" value="1" enum="DockLayout" is_bitfield="true">
 			Allows placing the dock in the vertical dock slots on either side of the editor.
-			[b]Note:[/b] Currently this flag has no effect because the bottom panel is not a proper dock slot. This means that the dock can always be vertical.
 		</constant>
 		<constant name="DOCK_LAYOUT_HORIZONTAL" value="2" enum="DockLayout" is_bitfield="true">
-			Allows placing the dock in the editor's bottom panel. Implement [method _update_layout] to handle changing layouts.
+			Allows placing the dock in the editor's bottom panel.
+		</constant>
+		<constant name="DOCK_LAYOUT_FLOATING" value="4" enum="DockLayout" is_bitfield="true">
+			Allows making the dock float (open in a separate window).
 		</constant>
 	</constants>
 </class>

doc/classes/EditorPlugin.xml

@@ -424,7 +424,7 @@
 				[b]Note:[/b] A plugin instance can belong only to a single context menu slot.
 			</description>
 		</method>
-		<method name="add_control_to_bottom_panel">
+		<method name="add_control_to_bottom_panel" deprecated="Use [method add_dock] instead, with [member EditorDock.default_slot] set to [constant DOCK_SLOT_BOTTOM].">
 			<return type="Button" />
 			<param index="0" name="control" type="Control" />
 			<param index="1" name="title" type="String" />
@@ -662,7 +662,7 @@
 				Removes the specified context menu plugin.
 			</description>
 		</method>
-		<method name="remove_control_from_bottom_panel">
+		<method name="remove_control_from_bottom_panel" deprecated="Use [method remove_dock] instead.">
 			<return type="void" />
 			<param index="0" name="control" type="Control" />
 			<description>
@@ -910,7 +910,10 @@
 		<constant name="DOCK_SLOT_RIGHT_BR" value="7" enum="DockSlot">
 			Dock slot, right side, bottom-right (empty in default layout).
 		</constant>
-		<constant name="DOCK_SLOT_MAX" value="8" enum="DockSlot">
+		<constant name="DOCK_SLOT_BOTTOM" value="8" enum="DockSlot">
+			Bottom panel.
+		</constant>
+		<constant name="DOCK_SLOT_MAX" value="9" enum="DockSlot">
 			Represents the size of the [enum DockSlot] enum.
 		</constant>
 		<constant name="AFTER_GUI_INPUT_PASS" value="0" enum="AfterGUIInput">

editor/debugger/editor_debugger_node.cpp

@@ -65,12 +65,6 @@ EditorDebuggerNode::EditorDebuggerNode() {
 		singleton = this;
 	}
 
-	Ref<StyleBox> bottom_panel_margins = EditorNode::get_singleton()->get_editor_theme()->get_stylebox(SNAME("BottomPanel"), EditorStringName(EditorStyles));
-	add_theme_constant_override("margin_top", -bottom_panel_margins->get_margin(SIDE_TOP));
-	add_theme_constant_override("margin_left", -bottom_panel_margins->get_margin(SIDE_LEFT));
-	add_theme_constant_override("margin_right", -bottom_panel_margins->get_margin(SIDE_RIGHT));
-	add_theme_constant_override("margin_bottom", -bottom_panel_margins->get_margin(SIDE_BOTTOM));
-
 	tabs = memnew(TabContainer);
 	tabs->set_tabs_visible(false);
 	tabs->connect("tab_changed", callable_mp(this, &EditorDebuggerNode::_debugger_changed));
@@ -332,17 +326,19 @@ void EditorDebuggerNode::_notification(int p_what) {
 			if (tabs->get_tab_count() > 1) {
 				tabs->add_theme_style_override(SceneStringName(panel), EditorNode::get_singleton()->get_editor_theme()->get_stylebox(SNAME("DebuggerPanel"), EditorStringName(EditorStyles)));
 			}
-
-			Ref<StyleBox> bottom_panel_margins = EditorNode::get_singleton()->get_editor_theme()->get_stylebox(SNAME("BottomPanel"), EditorStringName(EditorStyles));
-			add_theme_constant_override("margin_top", -bottom_panel_margins->get_margin(SIDE_TOP));
-			add_theme_constant_override("margin_left", -bottom_panel_margins->get_margin(SIDE_LEFT));
-			add_theme_constant_override("margin_right", -bottom_panel_margins->get_margin(SIDE_RIGHT));
-			add_theme_constant_override("margin_bottom", -bottom_panel_margins->get_margin(SIDE_BOTTOM));
+			_update_margins();
 
 			remote_scene_tree->update_icon_max_width();
 		} break;
 
 		case NOTIFICATION_READY: {
+			// TODO: Replace this hack once EditorDebuggerNode is converted to a dock. It should be in the constructor.
+			EditorDock *parent = Object::cast_to<EditorDock>(get_parent());
+			if (parent) {
+				parent->set_clip_contents(false);
+				_update_margins();
+			}
+
 			_update_debug_options();
 			initializing = false;
 		} break;
@@ -444,35 +440,41 @@ void EditorDebuggerNode::_update_errors() {
 		last_error_count = error_count;
 		last_warning_count = warning_count;
 
-		// TODO: Replace logic when EditorDock class is merged to be more flexible.
-		TabContainer *parent = Object::cast_to<TabContainer>(get_parent());
+		// TODO: Replace this hack once EditorDebuggerNode is converted to a dock.
+		EditorDock *parent = Object::cast_to<EditorDock>(get_parent());
 		if (!parent) {
 			return;
 		}
 
-		int idx = parent->get_tab_idx_from_control(this);
-
 		if (error_count == 0 && warning_count == 0) {
 			set_name(TTR("Debugger"));
-			parent->set_tab_icon(idx, Ref<Texture2D>());
-			parent->get_tab_bar()->set_font_color_override_all(idx, Color(0, 0, 0, 0));
+			parent->set_dock_icon(Ref<Texture2D>());
+			parent->set_title_color(Color(0, 0, 0, 0));
 		} else {
 			set_name(TTR("Debugger") + " (" + itos(error_count + warning_count) + ")");
 			if (error_count >= 1 && warning_count >= 1) {
-				parent->set_tab_icon(idx, get_editor_theme_icon(SNAME("ErrorWarning")));
+				parent->set_dock_icon(get_editor_theme_icon(SNAME("ErrorWarning")));
 				// Use error color to represent the highest level of severity reported.
-				parent->get_tab_bar()->set_font_color_override_all(idx, get_theme_color(SNAME("error_color"), EditorStringName(Editor)));
+				parent->set_title_color(get_theme_color(SNAME("error_color"), EditorStringName(Editor)));
 			} else if (error_count >= 1) {
-				parent->set_tab_icon(idx, get_editor_theme_icon(SNAME("Error")));
-				parent->get_tab_bar()->set_font_color_override_all(idx, get_theme_color(SNAME("error_color"), EditorStringName(Editor)));
+				parent->set_dock_icon(get_editor_theme_icon(SNAME("Error")));
+				parent->set_title_color(get_theme_color(SNAME("error_color"), EditorStringName(Editor)));
 			} else {
-				parent->set_tab_icon(idx, get_editor_theme_icon(SNAME("Warning")));
-				parent->get_tab_bar()->set_font_color_override_all(idx, get_theme_color(SNAME("warning_color"), EditorStringName(Editor)));
+				parent->set_dock_icon(get_editor_theme_icon(SNAME("Warning")));
+				parent->set_title_color(get_theme_color(SNAME("warning_color"), EditorStringName(Editor)));
 			}
 		}
 	}
 }
 
+void EditorDebuggerNode::_update_margins() {
+	Ref<StyleBox> bottom_panel_margins = EditorNode::get_singleton()->get_editor_theme()->get_stylebox(SNAME("BottomPanel"), EditorStringName(EditorStyles));
+	add_theme_constant_override("margin_top", -bottom_panel_margins->get_margin(SIDE_TOP));
+	add_theme_constant_override("margin_left", -bottom_panel_margins->get_margin(SIDE_LEFT));
+	add_theme_constant_override("margin_right", -bottom_panel_margins->get_margin(SIDE_RIGHT));
+	add_theme_constant_override("margin_bottom", -bottom_panel_margins->get_margin(SIDE_BOTTOM));
+}
+
 void EditorDebuggerNode::_debugger_stopped(int p_id) {
 	ScriptEditorDebugger *dbg = get_debugger(p_id);
 	ERR_FAIL_NULL(dbg);

editor/debugger/editor_debugger_node.h

@@ -121,6 +121,7 @@ class EditorDebuggerNode : public MarginContainer {
 
 	ScriptEditorDebugger *_add_debugger();
 	void _update_errors();
+	void _update_margins();
 
 	friend class DebuggerEditorPlugin;
 	friend class DebugAdapterParser;

editor/docks/dock_constants.h

@@ -0,0 +1,55 @@
+/**************************************************************************/
+/*  dock_constants.h                                                      */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* Permission is hereby granted, free of charge, to any person obtaining  */
+/* a copy of this software and associated documentation files (the        */
+/* "Software"), to deal in the Software without restriction, including    */
+/* without limitation the rights to use, copy, modify, merge, publish,    */
+/* distribute, sublicense, and/or sell copies of the Software, and to     */
+/* permit persons to whom the Software is furnished to do so, subject to  */
+/* the following conditions:                                              */
+/*                                                                        */
+/* The above copyright notice and this permission notice shall be         */
+/* included in all copies or substantial portions of the Software.        */
+/*                                                                        */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
+/**************************************************************************/
+
+#pragma once
+
+namespace DockConstants {
+
+enum DockSlot {
+	DOCK_SLOT_NONE = -1,
+	DOCK_SLOT_LEFT_UL,
+	DOCK_SLOT_LEFT_BL,
+	DOCK_SLOT_LEFT_UR,
+	DOCK_SLOT_LEFT_BR,
+	DOCK_SLOT_RIGHT_UL,
+	DOCK_SLOT_RIGHT_BL,
+	DOCK_SLOT_RIGHT_UR,
+	DOCK_SLOT_RIGHT_BR,
+	DOCK_SLOT_BOTTOM,
+	DOCK_SLOT_MAX
+};
+
+enum DockLayout {
+	DOCK_LAYOUT_VERTICAL = 1,
+	DOCK_LAYOUT_HORIZONTAL = 2,
+	DOCK_LAYOUT_FLOATING = 4,
+};
+
+}; //namespace DockConstants

editor/docks/editor_dock.cpp

@@ -35,7 +35,7 @@
 
 void EditorDock::_set_default_slot_bind(EditorPlugin::DockSlot p_slot) {
 	ERR_FAIL_COND(p_slot < EditorPlugin::DOCK_SLOT_NONE || p_slot >= EditorPlugin::DOCK_SLOT_MAX);
-	default_slot = (EditorDockManager::DockSlot)p_slot;
+	default_slot = (DockConstants::DockSlot)p_slot;
 }
 
 void EditorDock::_bind_methods() {
@@ -47,6 +47,14 @@ void EditorDock::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("get_layout_key"), &EditorDock::get_layout_key);
 	ADD_PROPERTY(PropertyInfo(Variant::STRING, "layout_key"), "set_layout_key", "get_layout_key");
 
+	ClassDB::bind_method(D_METHOD("set_global", "global"), &EditorDock::set_global);
+	ClassDB::bind_method(D_METHOD("is_global"), &EditorDock::is_global);
+	ADD_PROPERTY(PropertyInfo(Variant::BOOL, "global"), "set_global", "is_global");
+
+	ClassDB::bind_method(D_METHOD("set_hidden", "hidden"), &EditorDock::set_hidden);
+	ClassDB::bind_method(D_METHOD("is_hidden"), &EditorDock::is_hidden);
+	ADD_PROPERTY(PropertyInfo(Variant::BOOL, "hidden"), "set_hidden", "is_hidden");
+
 	ClassDB::bind_method(D_METHOD("set_icon_name", "icon_name"), &EditorDock::set_icon_name);
 	ClassDB::bind_method(D_METHOD("get_icon_name"), &EditorDock::get_icon_name);
 	ADD_PROPERTY(PropertyInfo(Variant::STRING_NAME, "icon_name"), "set_icon_name", "get_icon_name");
@@ -55,6 +63,10 @@ void EditorDock::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("get_dock_icon"), &EditorDock::get_dock_icon);
 	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "dock_icon", PROPERTY_HINT_RESOURCE_TYPE, "Texture2D"), "set_dock_icon", "get_dock_icon");
 
+	ClassDB::bind_method(D_METHOD("set_title_color", "color"), &EditorDock::set_title_color);
+	ClassDB::bind_method(D_METHOD("get_title_color"), &EditorDock::get_title_color);
+	ADD_PROPERTY(PropertyInfo(Variant::COLOR, "title_color"), "set_title_color", "get_title_color");
+
 	ClassDB::bind_method(D_METHOD("set_dock_shortcut", "shortcut"), &EditorDock::set_dock_shortcut);
 	ClassDB::bind_method(D_METHOD("get_dock_shortcut"), &EditorDock::get_dock_shortcut);
 	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "dock_shortcut", PROPERTY_HINT_RESOURCE_TYPE, "ShortCut"), "set_dock_shortcut", "get_dock_shortcut");
@@ -69,6 +81,7 @@ void EditorDock::_bind_methods() {
 
 	BIND_BITFIELD_FLAG(DOCK_LAYOUT_VERTICAL);
 	BIND_BITFIELD_FLAG(DOCK_LAYOUT_HORIZONTAL);
+	BIND_BITFIELD_FLAG(DOCK_LAYOUT_FLOATING);
 
 	GDVIRTUAL_BIND(_update_layout, "layout");
 	GDVIRTUAL_BIND(_save_layout_to_config, "config", "section");
@@ -88,6 +101,24 @@ void EditorDock::set_title(const String &p_title) {
 	emit_signal("tab_style_changed");
 }
 
+void EditorDock::set_global(bool p_global) {
+	if (global == p_global) {
+		return;
+	}
+	global = p_global;
+	if (is_inside_tree()) {
+		EditorDockManager::get_singleton()->update_docks_menu();
+	}
+}
+
+void EditorDock::set_hidden(bool p_hidden) {
+	if (hidden == p_hidden) {
+		return;
+	}
+	hidden = p_hidden;
+	emit_signal("tab_style_changed");
+}
+
 void EditorDock::set_icon_name(const StringName &p_name) {
 	if (icon_name == p_name) {
 		return;
@@ -104,8 +135,23 @@ void EditorDock::set_dock_icon(const Ref<Texture2D> &p_icon) {
 	emit_signal("tab_style_changed");
 }
 
-void EditorDock::set_default_slot(EditorDockManager::DockSlot p_slot) {
-	ERR_FAIL_INDEX(p_slot, EditorDockManager::DOCK_SLOT_MAX);
+void EditorDock::set_title_color(const Color &p_color) {
+	if (title_color == p_color) {
+		return;
+	}
+	title_color = p_color;
+	emit_signal("tab_style_changed");
+}
+
+void EditorDock::set_dock_shortcut(const Ref<Shortcut> &p_shortcut) {
+	shortcut = p_shortcut;
+	if (global && is_inside_tree()) {
+		EditorDockManager::get_singleton()->update_docks_menu();
+	}
+}
+
+void EditorDock::set_default_slot(DockConstants::DockSlot p_slot) {
+	ERR_FAIL_INDEX(p_slot, DockConstants::DOCK_SLOT_MAX);
 	default_slot = p_slot;
 }
 

editor/docks/editor_dock.h

@@ -43,8 +43,10 @@ class EditorDock : public MarginContainer {
 
 public:
 	enum DockLayout {
-		DOCK_LAYOUT_VERTICAL = 1,
-		DOCK_LAYOUT_HORIZONTAL = 2,
+		DOCK_LAYOUT_VERTICAL = DockConstants::DOCK_LAYOUT_VERTICAL,
+		DOCK_LAYOUT_HORIZONTAL = DockConstants::DOCK_LAYOUT_HORIZONTAL,
+		DOCK_LAYOUT_FLOATING = DockConstants::DOCK_LAYOUT_FLOATING,
+		DOCK_LAYOUT_ALL = DOCK_LAYOUT_VERTICAL | DOCK_LAYOUT_HORIZONTAL | DOCK_LAYOUT_FLOATING,
 	};
 
 private:
@@ -55,18 +57,19 @@ class EditorDock : public MarginContainer {
 	String layout_key;
 	StringName icon_name;
 	Ref<Texture2D> dock_icon;
+	Color title_color = Color(0, 0, 0, 0);
 	Ref<Shortcut> shortcut;
-	EditorDockManager::DockSlot default_slot = EditorDockManager::DOCK_SLOT_NONE;
+	DockConstants::DockSlot default_slot = DockConstants::DOCK_SLOT_NONE;
+	bool global = true;
 
-	BitField<DockLayout> available_layouts = DOCK_LAYOUT_VERTICAL;
+	BitField<DockLayout> available_layouts = DOCK_LAYOUT_VERTICAL | DOCK_LAYOUT_FLOATING;
 
 	bool open = false;
+	bool hidden = false;
 	bool enabled = true;
-	bool at_bottom = false;
 	int previous_tab_index = -1;
-	bool previous_at_bottom = false;
 	WindowWrapper *dock_window = nullptr;
-	int dock_slot_index = EditorDockManager::DOCK_SLOT_NONE;
+	int dock_slot_index = DockConstants::DOCK_SLOT_NONE;
 
 	void _set_default_slot_bind(EditorPlugin::DockSlot p_slot);
 	EditorPlugin::DockSlot _get_default_slot_bind() const { return (EditorPlugin::DockSlot)default_slot; }
@@ -87,17 +90,26 @@ class EditorDock : public MarginContainer {
 	void set_layout_key(const String &p_key) { layout_key = p_key; }
 	String get_layout_key() const { return layout_key; }
 
+	void set_global(bool p_global);
+	bool is_global() const { return global; }
+
+	void set_hidden(bool p_hidden);
+	bool is_hidden() const { return hidden; }
+
 	void set_icon_name(const StringName &p_name);
 	StringName get_icon_name() const { return icon_name; }
 
 	void set_dock_icon(const Ref<Texture2D> &p_icon);
 	Ref<Texture2D> get_dock_icon() const { return dock_icon; }
 
-	void set_dock_shortcut(const Ref<Shortcut> &p_shortcut) { shortcut = p_shortcut; }
+	void set_title_color(const Color &p_color);
+	Color get_title_color() const { return title_color; }
+
+	void set_dock_shortcut(const Ref<Shortcut> &p_shortcut);
 	Ref<Shortcut> get_dock_shortcut() const { return shortcut; }
 
-	void set_default_slot(EditorDockManager::DockSlot p_slot);
-	EditorDockManager::DockSlot get_default_slot() const { return default_slot; }
+	void set_default_slot(DockConstants::DockSlot p_slot);
+	DockConstants::DockSlot get_default_slot() const { return default_slot; }
 
 	void set_available_layouts(BitField<DockLayout> p_layouts) { available_layouts = p_layouts; }
 	BitField<DockLayout> get_available_layouts() const { return available_layouts; }