godot/editor/editor_dock_manager.cpp
2024-05-13 23:41:07 +02:00

1131 lines
40 KiB
C++

/**************************************************************************/
/* editor_dock_manager.cpp */
/**************************************************************************/
/* 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. */
/**************************************************************************/
#include "editor_dock_manager.h"
#include "scene/gui/box_container.h"
#include "scene/gui/button.h"
#include "scene/gui/label.h"
#include "scene/gui/split_container.h"
#include "scene/gui/tab_container.h"
#include "scene/main/window.h"
#include "editor/editor_node.h"
#include "editor/editor_settings.h"
#include "editor/editor_string_names.h"
#include "editor/filesystem_dock.h"
#include "editor/gui/editor_bottom_panel.h"
#include "editor/themes/editor_scale.h"
#include "editor/window_wrapper.h"
enum class TabStyle {
TEXT_ONLY,
ICON_ONLY,
TEXT_AND_ICON,
};
EditorDockManager *EditorDockManager::singleton = nullptr;
void DockSplitContainer::_update_visibility() {
if (is_updating) {
return;
}
is_updating = true;
bool any_visible = false;
for (int i = 0; i < 2; i++) {
Control *split = get_containable_child(i);
if (split && split->is_visible()) {
any_visible = true;
break;
}
}
set_visible(any_visible);
is_updating = false;
}
void DockSplitContainer::add_child_notify(Node *p_child) {
SplitContainer::add_child_notify(p_child);
Control *child_control = nullptr;
for (int i = 0; i < 2; i++) {
Control *split = get_containable_child(i);
if (p_child == split) {
child_control = split;
break;
}
}
if (!child_control) {
return;
}
child_control->connect(SceneStringName(visibility_changed), callable_mp(this, &DockSplitContainer::_update_visibility));
_update_visibility();
}
void DockSplitContainer::remove_child_notify(Node *p_child) {
SplitContainer::remove_child_notify(p_child);
Control *child_control = nullptr;
for (int i = 0; i < 2; i++) {
Control *split = get_containable_child(i);
if (p_child == split) {
child_control = split;
break;
}
}
if (!child_control) {
return;
}
child_control->disconnect(SceneStringName(visibility_changed), callable_mp(this, &DockSplitContainer::_update_visibility));
_update_visibility();
}
void EditorDockManager::_dock_split_dragged(int p_offset) {
EditorNode::get_singleton()->save_editor_layout_delayed();
}
void EditorDockManager::_dock_container_gui_input(const Ref<InputEvent> &p_input, TabContainer *p_dock_container) {
Ref<InputEventMouseButton> mb = p_input;
if (mb.is_valid() && mb->get_button_index() == MouseButton::RIGHT && mb->is_pressed()) {
int tab_id = p_dock_container->get_tab_bar()->get_hovered_tab();
if (tab_id < 0) {
return;
}
// Right click context menu.
dock_context_popup->set_dock(p_dock_container->get_tab_control(tab_id));
dock_context_popup->set_position(p_dock_container->get_screen_position() + mb->get_position());
dock_context_popup->popup();
}
}
void EditorDockManager::_bottom_dock_button_gui_input(const Ref<InputEvent> &p_input, Control *p_dock, Button *p_bottom_button) {
Ref<InputEventMouseButton> mb = p_input;
if (mb.is_valid() && mb->get_button_index() == MouseButton::RIGHT && mb->is_pressed()) {
// Right click context menu.
dock_context_popup->set_dock(p_dock);
dock_context_popup->set_position(p_bottom_button->get_screen_position() + mb->get_position());
dock_context_popup->popup();
}
}
void EditorDockManager::_dock_container_update_visibility(TabContainer *p_dock_container) {
if (!docks_visible) {
return;
}
// Hide the dock container if there are no tabs.
p_dock_container->set_visible(p_dock_container->get_tab_count() > 0);
}
void EditorDockManager::_update_layout() {
if (!dock_context_popup->is_inside_tree() || EditorNode::get_singleton()->is_exiting()) {
return;
}
dock_context_popup->docks_updated();
_update_docks_menu();
EditorNode::get_singleton()->save_editor_layout_delayed();
}
void EditorDockManager::_update_docks_menu() {
docks_menu->clear();
docks_menu->reset_size();
const Ref<Texture2D> default_icon = docks_menu->get_editor_theme_icon(SNAME("Window"));
const Color closed_icon_color_mod = Color(1, 1, 1, 0.5);
// Add docks.
docks_menu_docks.clear();
int id = 0;
for (const KeyValue<Control *, DockInfo> &dock : all_docks) {
if (dock.value.shortcut.is_valid()) {
docks_menu->add_shortcut(dock.value.shortcut, id);
docks_menu->set_item_text(id, dock.value.title);
} else {
docks_menu->add_item(dock.value.title, id);
}
const Ref<Texture2D> icon = dock.value.icon_name ? docks_menu->get_editor_theme_icon(dock.value.icon_name) : dock.value.icon;
docks_menu->set_item_icon(id, icon.is_valid() ? icon : default_icon);
if (!dock.value.open) {
docks_menu->set_item_icon_modulate(id, closed_icon_color_mod);
}
docks_menu->set_item_disabled(id, !dock.value.enabled);
docks_menu_docks.push_back(dock.key);
id++;
}
}
void EditorDockManager::_docks_menu_option(int p_id) {
Control *dock = docks_menu_docks[p_id];
ERR_FAIL_NULL(dock);
ERR_FAIL_COND_MSG(!all_docks.has(dock), vformat("Menu option for unknown dock '%s'.", dock->get_name()));
if (all_docks[dock].enabled && all_docks[dock].open) {
PopupMenu *parent_menu = Object::cast_to<PopupMenu>(docks_menu->get_parent());
ERR_FAIL_NULL(parent_menu);
parent_menu->hide();
}
focus_dock(dock);
}
void EditorDockManager::_window_close_request(WindowWrapper *p_wrapper) {
// Give the dock back to the original owner.
Control *dock = _close_window(p_wrapper);
ERR_FAIL_COND(!all_docks.has(dock));
if (all_docks[dock].previous_at_bottom || all_docks[dock].dock_slot_index != DOCK_SLOT_NONE) {
all_docks[dock].open = false;
open_dock(dock);
focus_dock(dock);
} else {
close_dock(dock);
}
}
Control *EditorDockManager::_close_window(WindowWrapper *p_wrapper) {
p_wrapper->set_block_signals(true);
Control *dock = p_wrapper->release_wrapped_control();
p_wrapper->set_block_signals(false);
ERR_FAIL_COND_V(!all_docks.has(dock), nullptr);
all_docks[dock].dock_window = nullptr;
dock_windows.erase(p_wrapper);
p_wrapper->queue_free();
return dock;
}
void EditorDockManager::_open_dock_in_window(Control *p_dock, bool p_show_window, bool p_reset_size) {
ERR_FAIL_NULL(p_dock);
Size2 borders = Size2(4, 4) * EDSCALE;
// Remember size and position before removing it from the main window.
Size2 dock_size = p_dock->get_size() + borders * 2;
Point2 dock_screen_pos = p_dock->get_screen_position();
WindowWrapper *wrapper = memnew(WindowWrapper);
wrapper->set_window_title(vformat(TTR("%s - Godot Engine"), all_docks[p_dock].title));
wrapper->set_margins_enabled(true);
EditorNode::get_singleton()->get_gui_base()->add_child(wrapper);
_move_dock(p_dock, nullptr);
wrapper->set_wrapped_control(p_dock);
all_docks[p_dock].dock_window = wrapper;
all_docks[p_dock].open = true;
p_dock->show();
wrapper->connect("window_close_requested", callable_mp(this, &EditorDockManager::_window_close_request).bind(wrapper));
dock_windows.push_back(wrapper);
if (p_show_window) {
wrapper->restore_window(Rect2i(dock_screen_pos, dock_size), EditorNode::get_singleton()->get_gui_base()->get_window()->get_current_screen());
_update_layout();
if (p_reset_size) {
// Use a default size of one third the current window size.
Size2i popup_size = EditorNode::get_singleton()->get_window()->get_size() / 3.0;
p_dock->get_window()->set_size(popup_size);
p_dock->get_window()->move_to_center();
}
p_dock->get_window()->grab_focus();
}
}
void EditorDockManager::_restore_dock_to_saved_window(Control *p_dock, const Dictionary &p_window_dump) {
if (!all_docks[p_dock].dock_window) {
_open_dock_in_window(p_dock, false);
}
all_docks[p_dock].dock_window->restore_window_from_saved_position(
p_window_dump.get("window_rect", Rect2i()),
p_window_dump.get("window_screen", -1),
p_window_dump.get("window_screen_rect", Rect2i()));
}
void EditorDockManager::_dock_move_to_bottom(Control *p_dock) {
_move_dock(p_dock, nullptr);
all_docks[p_dock].at_bottom = true;
all_docks[p_dock].previous_at_bottom = false;
p_dock->call("_set_dock_horizontal", true);
// Force docks moved to the bottom to appear first in the list, and give them their associated shortcut to toggle their bottom panel.
Button *bottom_button = EditorNode::get_bottom_panel()->add_item(all_docks[p_dock].title, p_dock, all_docks[p_dock].shortcut, true);
bottom_button->connect(SceneStringName(gui_input), callable_mp(this, &EditorDockManager::_bottom_dock_button_gui_input).bind(bottom_button).bind(p_dock));
EditorNode::get_bottom_panel()->make_item_visible(p_dock);
}
void EditorDockManager::_dock_remove_from_bottom(Control *p_dock) {
all_docks[p_dock].at_bottom = false;
all_docks[p_dock].previous_at_bottom = true;
EditorNode::get_bottom_panel()->remove_item(p_dock);
p_dock->call("_set_dock_horizontal", false);
}
bool EditorDockManager::_is_dock_at_bottom(Control *p_dock) {
ERR_FAIL_COND_V(!all_docks.has(p_dock), false);
return all_docks[p_dock].at_bottom;
}
void EditorDockManager::_move_dock_tab_index(Control *p_dock, int p_tab_index, bool p_set_current) {
TabContainer *dock_tab_container = Object::cast_to<TabContainer>(p_dock->get_parent());
if (!dock_tab_container) {
return;
}
dock_tab_container->set_block_signals(true);
int target_index = CLAMP(p_tab_index, 0, dock_tab_container->get_tab_count() - 1);
dock_tab_container->move_child(p_dock, dock_tab_container->get_tab_control(target_index)->get_index(false));
all_docks[p_dock].previous_tab_index = target_index;
if (p_set_current) {
dock_tab_container->set_current_tab(target_index);
}
dock_tab_container->set_block_signals(false);
}
void EditorDockManager::_move_dock(Control *p_dock, Control *p_target, int p_tab_index, bool p_set_current) {
ERR_FAIL_NULL(p_dock);
ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot move unknown dock '%s'.", p_dock->get_name()));
Node *parent = p_dock->get_parent();
if (parent == p_target) {
if (p_tab_index >= 0 && parent) {
// Only change the tab index.
_move_dock_tab_index(p_dock, p_tab_index, p_set_current);
}
return;
}
// Remove dock from its existing parent.
if (parent) {
if (all_docks[p_dock].dock_window) {
_close_window(all_docks[p_dock].dock_window);
} else if (all_docks[p_dock].at_bottom) {
_dock_remove_from_bottom(p_dock);
} else {
all_docks[p_dock].previous_at_bottom = false;
TabContainer *parent_tabs = Object::cast_to<TabContainer>(parent);
if (parent_tabs) {
all_docks[p_dock].previous_tab_index = parent_tabs->get_tab_idx_from_control(p_dock);
}
parent->set_block_signals(true);
parent->remove_child(p_dock);
parent->set_block_signals(false);
if (parent_tabs) {
_dock_container_update_visibility(parent_tabs);
}
}
}
// Add dock to its new parent, at the given tab index.
if (!p_target) {
return;
}
p_target->set_block_signals(true);
p_target->add_child(p_dock);
p_target->set_block_signals(false);
TabContainer *dock_tab_container = Object::cast_to<TabContainer>(p_target);
if (dock_tab_container) {
if (dock_tab_container->is_inside_tree()) {
_update_tab_style(p_dock);
}
if (p_tab_index >= 0) {
_move_dock_tab_index(p_dock, p_tab_index, p_set_current);
}
_dock_container_update_visibility(dock_tab_container);
}
}
void EditorDockManager::_update_tab_style(Control *p_dock) {
const DockInfo &dock_info = all_docks[p_dock];
if (!dock_info.enabled || !dock_info.open) {
return; // Disabled by feature profile or manually closed by user.
}
if (dock_info.dock_window || dock_info.at_bottom) {
return; // Floating or sent to bottom.
}
TabContainer *tab_container = get_dock_tab_container(p_dock);
ERR_FAIL_NULL(tab_container);
int index = tab_container->get_tab_idx_from_control(p_dock);
ERR_FAIL_COND(index == -1);
const TabStyle style = (TabStyle)EDITOR_GET("interface/editor/dock_tab_style").operator int();
switch (style) {
case TabStyle::TEXT_ONLY: {
tab_container->set_tab_title(index, dock_info.title);
tab_container->set_tab_icon(index, Ref<Texture2D>());
tab_container->set_tab_tooltip(index, String());
} break;
case TabStyle::ICON_ONLY: {
const Ref<Texture2D> icon = dock_info.icon_name ? tab_container->get_editor_theme_icon(dock_info.icon_name) : dock_info.icon;
tab_container->set_tab_title(index, icon.is_valid() ? String() : dock_info.title);
tab_container->set_tab_icon(index, icon);
tab_container->set_tab_tooltip(index, icon.is_valid() ? dock_info.title : String());
} break;
case TabStyle::TEXT_AND_ICON: {
const Ref<Texture2D> icon = dock_info.icon_name ? tab_container->get_editor_theme_icon(dock_info.icon_name) : dock_info.icon;
tab_container->set_tab_title(index, dock_info.title);
tab_container->set_tab_icon(index, icon);
tab_container->set_tab_tooltip(index, String());
} break;
}
}
void EditorDockManager::save_docks_to_config(Ref<ConfigFile> p_layout, const String &p_section) const {
// Save docks by dock slot.
for (int i = 0; i < DOCK_SLOT_MAX; i++) {
String names;
for (int j = 0; j < dock_slot[i]->get_tab_count(); j++) {
String name = dock_slot[i]->get_tab_control(j)->get_name();
if (!names.is_empty()) {
names += ",";
}
names += name;
}
String config_key = "dock_" + itos(i + 1);
if (p_layout->has_section_key(p_section, config_key)) {
p_layout->erase_section_key(p_section, config_key);
}
if (!names.is_empty()) {
p_layout->set_value(p_section, config_key, names);
}
int selected_tab_idx = dock_slot[i]->get_current_tab();
if (selected_tab_idx >= 0) {
p_layout->set_value(p_section, "dock_" + itos(i + 1) + "_selected_tab_idx", selected_tab_idx);
}
}
if (p_layout->has_section_key(p_section, "dock_0")) {
// Clear the keys where the dock has no slot so it is overridden.
p_layout->erase_section_key(p_section, "dock_0");
}
// Save docks in windows.
Dictionary floating_docks_dump;
for (WindowWrapper *wrapper : dock_windows) {
Control *dock = wrapper->get_wrapped_control();
Dictionary window_dump;
window_dump["window_rect"] = wrapper->get_window_rect();
int screen = wrapper->get_window_screen();
window_dump["window_screen"] = wrapper->get_window_screen();
window_dump["window_screen_rect"] = DisplayServer::get_singleton()->screen_get_usable_rect(screen);
String name = dock->get_name();
floating_docks_dump[name] = window_dump;
// Append to regular dock section so we know where to restore it to.
int dock_slot_id = all_docks[dock].dock_slot_index;
String config_key = "dock_" + itos(dock_slot_id + 1);
String names = p_layout->get_value(p_section, config_key, "");
if (names.is_empty()) {
names = name;
} else {
names += "," + name;
}
p_layout->set_value(p_section, config_key, names);
}
p_layout->set_value(p_section, "dock_floating", floating_docks_dump);
// Save closed and bottom docks.
Array bottom_docks_dump;
Array closed_docks_dump;
for (const KeyValue<Control *, DockInfo> &d : all_docks) {
if (!d.value.at_bottom && d.value.open && (!d.value.previous_at_bottom || !d.value.dock_window)) {
continue;
}
// Use the name of the Control since it isn't translated.
String name = d.key->get_name();
if (d.value.at_bottom || (d.value.previous_at_bottom && d.value.dock_window)) {
bottom_docks_dump.push_back(name);
}
if (!d.value.open) {
closed_docks_dump.push_back(name);
}
int dock_slot_id = all_docks[d.key].dock_slot_index;
String config_key = "dock_" + itos(dock_slot_id + 1);
String names = p_layout->get_value(p_section, config_key, "");
if (names.is_empty()) {
names = name;
} else {
names += "," + name;
}
p_layout->set_value(p_section, config_key, names);
}
p_layout->set_value(p_section, "dock_bottom", bottom_docks_dump);
p_layout->set_value(p_section, "dock_closed", closed_docks_dump);
// Save SplitContainer offsets.
for (int i = 0; i < vsplits.size(); i++) {
if (vsplits[i]->is_visible_in_tree()) {
p_layout->set_value(p_section, "dock_split_" + itos(i + 1), vsplits[i]->get_split_offset());
}
}
for (int i = 0; i < hsplits.size(); i++) {
p_layout->set_value(p_section, "dock_hsplit_" + itos(i + 1), hsplits[i]->get_split_offset());
}
FileSystemDock::get_singleton()->save_layout_to_config(p_layout, p_section);
}
void EditorDockManager::load_docks_from_config(Ref<ConfigFile> p_layout, const String &p_section) {
Dictionary floating_docks_dump = p_layout->get_value(p_section, "dock_floating", Dictionary());
Array dock_bottom = p_layout->get_value(p_section, "dock_bottom", Array());
Array closed_docks = p_layout->get_value(p_section, "dock_closed", Array());
bool restore_window_on_load = EDITOR_GET("interface/multi_window/restore_windows_on_load");
// Store the docks by name for easy lookup.
HashMap<String, Control *> dock_map;
for (const KeyValue<Control *, DockInfo> &dock : all_docks) {
dock_map[dock.key->get_name()] = dock.key;
}
// Load docks by slot. Index -1 is for docks that have no slot.
for (int i = -1; i < DOCK_SLOT_MAX; i++) {
if (!p_layout->has_section_key(p_section, "dock_" + itos(i + 1))) {
continue;
}
Vector<String> names = String(p_layout->get_value(p_section, "dock_" + itos(i + 1))).split(",");
for (int j = names.size() - 1; j >= 0; j--) {
String name = names[j];
if (!dock_map.has(name)) {
continue;
}
Control *dock = dock_map[name];
if (!all_docks[dock].enabled) {
// Don't open disabled docks.
continue;
}
if (restore_window_on_load && floating_docks_dump.has(name)) {
all_docks[dock].previous_at_bottom = dock_bottom.has(name);
_restore_dock_to_saved_window(dock, floating_docks_dump[name]);
} else if (dock_bottom.has(name)) {
_dock_move_to_bottom(dock);
} else if (i >= 0) {
_move_dock(dock, dock_slot[i], 0);
}
if (closed_docks.has(name)) {
_move_dock(dock, closed_dock_parent);
all_docks[dock].open = false;
dock->hide();
} else {
// Make sure it is open.
all_docks[dock].open = true;
dock->show();
}
all_docks[dock].dock_slot_index = i;
all_docks[dock].previous_tab_index = i >= 0 ? j : 0;
}
}
// Set the selected tabs.
for (int i = 0; i < DOCK_SLOT_MAX; i++) {
if (dock_slot[i]->get_tab_count() == 0 || !p_layout->has_section_key(p_section, "dock_" + itos(i + 1) + "_selected_tab_idx")) {
continue;
}
int selected_tab_idx = p_layout->get_value(p_section, "dock_" + itos(i + 1) + "_selected_tab_idx");
if (selected_tab_idx >= 0 && selected_tab_idx < dock_slot[i]->get_tab_count()) {
dock_slot[i]->set_block_signals(true);
dock_slot[i]->set_current_tab(selected_tab_idx);
dock_slot[i]->set_block_signals(false);
}
}
// Load SplitContainer offsets.
for (int i = 0; i < vsplits.size(); i++) {
if (!p_layout->has_section_key(p_section, "dock_split_" + itos(i + 1))) {
continue;
}
int ofs = p_layout->get_value(p_section, "dock_split_" + itos(i + 1));
vsplits[i]->set_split_offset(ofs);
}
for (int i = 0; i < hsplits.size(); i++) {
if (!p_layout->has_section_key(p_section, "dock_hsplit_" + itos(i + 1))) {
continue;
}
int ofs = p_layout->get_value(p_section, "dock_hsplit_" + itos(i + 1));
hsplits[i]->set_split_offset(ofs);
}
FileSystemDock::get_singleton()->load_layout_from_config(p_layout, p_section);
_update_docks_menu();
}
void EditorDockManager::bottom_dock_show_placement_popup(const Rect2i &p_position, Control *p_dock) {
ERR_FAIL_COND(!all_docks.has(p_dock));
dock_context_popup->set_dock(p_dock);
Vector2 popup_pos = p_position.position;
popup_pos.y += p_position.size.height;
if (!EditorNode::get_singleton()->get_gui_base()->is_layout_rtl()) {
popup_pos.x -= dock_context_popup->get_size().width;
popup_pos.x += p_position.size.width;
}
dock_context_popup->set_position(popup_pos);
dock_context_popup->popup();
}
void EditorDockManager::set_dock_enabled(Control *p_dock, bool p_enabled) {
ERR_FAIL_NULL(p_dock);
ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot set enabled unknown dock '%s'.", p_dock->get_name()));
if (all_docks[p_dock].enabled == p_enabled) {
return;
}
all_docks[p_dock].enabled = p_enabled;
if (p_enabled) {
open_dock(p_dock, false);
} else {
close_dock(p_dock);
}
}
void EditorDockManager::close_dock(Control *p_dock) {
ERR_FAIL_NULL(p_dock);
ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot close unknown dock '%s'.", p_dock->get_name()));
if (!all_docks[p_dock].open) {
return;
}
_move_dock(p_dock, closed_dock_parent);
all_docks[p_dock].open = false;
p_dock->hide();
_update_layout();
}
void EditorDockManager::open_dock(Control *p_dock, bool p_set_current) {
ERR_FAIL_NULL(p_dock);
ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot open unknown dock '%s'.", p_dock->get_name()));
if (all_docks[p_dock].open) {
return;
}
all_docks[p_dock].open = true;
p_dock->show();
// Open dock to its previous location.
if (all_docks[p_dock].previous_at_bottom) {
_dock_move_to_bottom(p_dock);
} else if (all_docks[p_dock].dock_slot_index != DOCK_SLOT_NONE) {
TabContainer *slot = dock_slot[all_docks[p_dock].dock_slot_index];
int tab_index = all_docks[p_dock].previous_tab_index;
if (tab_index < 0) {
tab_index = slot->get_tab_count();
}
_move_dock(p_dock, slot, tab_index, p_set_current);
} else {
_open_dock_in_window(p_dock, true, true);
return;
}
_update_layout();
}
TabContainer *EditorDockManager::get_dock_tab_container(Control *p_dock) const {
return Object::cast_to<TabContainer>(p_dock->get_parent());
}
void EditorDockManager::focus_dock(Control *p_dock) {
ERR_FAIL_NULL(p_dock);
ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot focus unknown dock '%s'.", p_dock->get_name()));
if (!all_docks[p_dock].enabled) {
return;
}
if (!all_docks[p_dock].open) {
open_dock(p_dock);
}
if (all_docks[p_dock].dock_window) {
p_dock->get_window()->grab_focus();
return;
}
if (all_docks[p_dock].at_bottom) {
EditorNode::get_bottom_panel()->make_item_visible(p_dock);
return;
}
if (!docks_visible) {
return;
}
TabContainer *tab_container = get_dock_tab_container(p_dock);
if (!tab_container) {
return;
}
int tab_index = tab_container->get_tab_idx_from_control(p_dock);
tab_container->get_tab_bar()->grab_focus();
tab_container->set_current_tab(tab_index);
}
void EditorDockManager::add_dock(Control *p_dock, const String &p_title, DockSlot p_slot, const Ref<Shortcut> &p_shortcut, const StringName &p_icon_name) {
ERR_FAIL_NULL(p_dock);
ERR_FAIL_COND_MSG(all_docks.has(p_dock), vformat("Cannot add dock '%s', already added.", p_dock->get_name()));
DockInfo dock_info;
dock_info.title = p_title.is_empty() ? String(p_dock->get_name()) : p_title;
dock_info.dock_slot_index = p_slot;
dock_info.shortcut = p_shortcut;
dock_info.icon_name = p_icon_name;
all_docks[p_dock] = dock_info;
if (p_slot != DOCK_SLOT_NONE) {
ERR_FAIL_INDEX(p_slot, DOCK_SLOT_MAX);
open_dock(p_dock, false);
} else {
closed_dock_parent->add_child(p_dock);
p_dock->hide();
_update_layout();
}
}
void EditorDockManager::remove_dock(Control *p_dock) {
ERR_FAIL_NULL(p_dock);
ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot remove unknown dock '%s'.", p_dock->get_name()));
_move_dock(p_dock, nullptr);
all_docks.erase(p_dock);
_update_layout();
}
void EditorDockManager::set_dock_tab_icon(Control *p_dock, const Ref<Texture2D> &p_icon) {
ERR_FAIL_NULL(p_dock);
ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot set tab icon for unknown dock '%s'.", p_dock->get_name()));
all_docks[p_dock].icon = p_icon;
_update_tab_style(p_dock);
}
void EditorDockManager::set_docks_visible(bool p_show) {
if (docks_visible == p_show) {
return;
}
docks_visible = p_show;
for (int i = 0; i < DOCK_SLOT_MAX; i++) {
dock_slot[i]->set_visible(docks_visible && dock_slot[i]->get_tab_count() > 0);
}
_update_layout();
}
bool EditorDockManager::are_docks_visible() const {
return docks_visible;
}
void EditorDockManager::update_tab_styles() {
for (const KeyValue<Control *, DockInfo> &dock : all_docks) {
_update_tab_style(dock.key);
}
}
void EditorDockManager::set_tab_icon_max_width(int p_max_width) {
for (int i = 0; i < DOCK_SLOT_MAX; i++) {
TabContainer *tab_container = dock_slot[i];
tab_container->add_theme_constant_override(SNAME("icon_max_width"), p_max_width);
}
}
void EditorDockManager::add_vsplit(DockSplitContainer *p_split) {
vsplits.push_back(p_split);
p_split->connect("dragged", callable_mp(this, &EditorDockManager::_dock_split_dragged));
}
void EditorDockManager::add_hsplit(DockSplitContainer *p_split) {
hsplits.push_back(p_split);
p_split->connect("dragged", callable_mp(this, &EditorDockManager::_dock_split_dragged));
}
void EditorDockManager::register_dock_slot(DockSlot p_dock_slot, TabContainer *p_tab_container) {
ERR_FAIL_NULL(p_tab_container);
ERR_FAIL_INDEX(p_dock_slot, DOCK_SLOT_MAX);
dock_slot[p_dock_slot] = p_tab_container;
p_tab_container->set_custom_minimum_size(Size2(170, 0) * EDSCALE);
p_tab_container->set_v_size_flags(Control::SIZE_EXPAND_FILL);
p_tab_container->set_popup(dock_context_popup);
p_tab_container->connect("pre_popup_pressed", callable_mp(dock_context_popup, &DockContextPopup::select_current_dock_in_dock_slot).bind(p_dock_slot));
p_tab_container->set_drag_to_rearrange_enabled(true);
p_tab_container->set_tabs_rearrange_group(1);
p_tab_container->connect("tab_changed", callable_mp(this, &EditorDockManager::_update_layout).unbind(1));
p_tab_container->connect("active_tab_rearranged", callable_mp(this, &EditorDockManager::_update_layout).unbind(1));
p_tab_container->connect("child_order_changed", callable_mp(this, &EditorDockManager::_dock_container_update_visibility).bind(p_tab_container));
p_tab_container->set_use_hidden_tabs_for_min_size(true);
p_tab_container->get_tab_bar()->connect(SceneStringName(gui_input), callable_mp(this, &EditorDockManager::_dock_container_gui_input).bind(p_tab_container));
p_tab_container->hide();
}
int EditorDockManager::get_vsplit_count() const {
return vsplits.size();
}
PopupMenu *EditorDockManager::get_docks_menu() {
return docks_menu;
}
EditorDockManager::EditorDockManager() {
singleton = this;
closed_dock_parent = EditorNode::get_singleton()->get_gui_base();
dock_context_popup = memnew(DockContextPopup);
EditorNode::get_singleton()->get_gui_base()->add_child(dock_context_popup);
docks_menu = memnew(PopupMenu);
docks_menu->set_hide_on_item_selection(false);
docks_menu->connect("id_pressed", callable_mp(this, &EditorDockManager::_docks_menu_option));
EditorNode::get_singleton()->get_gui_base()->connect(SceneStringName(theme_changed), callable_mp(this, &EditorDockManager::_update_docks_menu));
}
void DockContextPopup::_notification(int p_what) {
switch (p_what) {
case NOTIFICATION_THEME_CHANGED: {
if (make_float_button) {
make_float_button->set_icon(get_editor_theme_icon(SNAME("MakeFloating")));
}
if (is_layout_rtl()) {
tab_move_left_button->set_icon(get_editor_theme_icon(SNAME("Forward")));
tab_move_right_button->set_icon(get_editor_theme_icon(SNAME("Back")));
tab_move_left_button->set_tooltip_text(TTR("Move this dock right one tab."));
tab_move_right_button->set_tooltip_text(TTR("Move this dock left one tab."));
} else {
tab_move_left_button->set_icon(get_editor_theme_icon(SNAME("Back")));
tab_move_right_button->set_icon(get_editor_theme_icon(SNAME("Forward")));
tab_move_left_button->set_tooltip_text(TTR("Move this dock left one tab."));
tab_move_right_button->set_tooltip_text(TTR("Move this dock right one tab."));
}
dock_to_bottom_button->set_icon(get_editor_theme_icon(SNAME("ControlAlignBottomWide")));
close_button->set_icon(get_editor_theme_icon(SNAME("Close")));
} break;
}
}
void DockContextPopup::_tab_move_left() {
TabContainer *tab_container = dock_manager->get_dock_tab_container(context_dock);
if (!tab_container) {
return;
}
int new_index = tab_container->get_tab_idx_from_control(context_dock) - 1;
dock_manager->_move_dock(context_dock, tab_container, new_index);
dock_manager->_update_layout();
dock_select->queue_redraw();
}
void DockContextPopup::_tab_move_right() {
TabContainer *tab_container = dock_manager->get_dock_tab_container(context_dock);
if (!tab_container) {
return;
}
int new_index = tab_container->get_tab_idx_from_control(context_dock) + 1;
dock_manager->_move_dock(context_dock, tab_container, new_index);
dock_manager->_update_layout();
dock_select->queue_redraw();
}
void DockContextPopup::_close_dock() {
hide();
dock_manager->close_dock(context_dock);
}
void DockContextPopup::_float_dock() {
hide();
dock_manager->_open_dock_in_window(context_dock);
}
void DockContextPopup::_move_dock_to_bottom() {
hide();
dock_manager->_dock_move_to_bottom(context_dock);
dock_manager->_update_layout();
}
void DockContextPopup::_dock_select_input(const Ref<InputEvent> &p_input) {
Ref<InputEventMouse> me = p_input;
if (me.is_valid()) {
Vector2 point = me->get_position();
int over_dock_slot = -1;
for (int i = 0; i < EditorDockManager::DOCK_SLOT_MAX; i++) {
if (dock_select_rects[i].has_point(point)) {
over_dock_slot = i;
break;
}
}
if (over_dock_slot != dock_select_rect_over_idx) {
dock_select->queue_redraw();
dock_select_rect_over_idx = over_dock_slot;
}
if (over_dock_slot == -1) {
return;
}
Ref<InputEventMouseButton> mb = me;
TabContainer *target_tab_container = dock_manager->dock_slot[over_dock_slot];
if (mb.is_valid() && mb->get_button_index() == MouseButton::LEFT && mb->is_pressed()) {
if (dock_manager->get_dock_tab_container(context_dock) != target_tab_container) {
dock_manager->_move_dock(context_dock, target_tab_container, target_tab_container->get_tab_count());
dock_manager->all_docks[context_dock].dock_slot_index = over_dock_slot;
dock_manager->_update_layout();
hide();
}
}
}
}
void DockContextPopup::_dock_select_mouse_exited() {
dock_select_rect_over_idx = -1;
dock_select->queue_redraw();
}
void DockContextPopup::_dock_select_draw() {
Color used_dock_color = Color(0.6, 0.6, 0.6, 0.8);
Color hovered_dock_color = Color(0.8, 0.8, 0.8, 0.8);
Color tab_selected_color = dock_select->get_theme_color(SNAME("mono_color"), EditorStringName(Editor));
Color tab_unselected_color = used_dock_color;
Color unused_dock_color = used_dock_color;
unused_dock_color.a = 0.4;
Color unusable_dock_color = unused_dock_color;
unusable_dock_color.a = 0.1;
// Update sizes.
Size2 dock_size = dock_select->get_size();
dock_size.x /= 6.0;
dock_size.y /= 2.0;
Size2 center_panel_size = dock_size * 2.0;
Rect2 center_panel_rect(center_panel_size.x, 0, center_panel_size.x, center_panel_size.y);
if (dock_select->is_layout_rtl()) {
dock_select_rects[EditorDockManager::DOCK_SLOT_RIGHT_UR] = Rect2(Point2(), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_RIGHT_BR] = Rect2(Point2(0, dock_size.y), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_RIGHT_UL] = Rect2(Point2(dock_size.x, 0), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_RIGHT_BL] = Rect2(dock_size, dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_LEFT_UR] = Rect2(Point2(dock_size.x * 4, 0), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_LEFT_BR] = Rect2(Point2(dock_size.x * 4, dock_size.y), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_LEFT_UL] = Rect2(Point2(dock_size.x * 5, 0), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_LEFT_BL] = Rect2(Point2(dock_size.x * 5, dock_size.y), dock_size);
} else {
dock_select_rects[EditorDockManager::DOCK_SLOT_LEFT_UL] = Rect2(Point2(), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_LEFT_BL] = Rect2(Point2(0, dock_size.y), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_LEFT_UR] = Rect2(Point2(dock_size.x, 0), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_LEFT_BR] = Rect2(dock_size, dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_RIGHT_UL] = Rect2(Point2(dock_size.x * 4, 0), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_RIGHT_BL] = Rect2(Point2(dock_size.x * 4, dock_size.y), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_RIGHT_UR] = Rect2(Point2(dock_size.x * 5, 0), dock_size);
dock_select_rects[EditorDockManager::DOCK_SLOT_RIGHT_BR] = Rect2(Point2(dock_size.x * 5, dock_size.y), dock_size);
}
int max_tabs = 3;
int rtl_dir = dock_select->is_layout_rtl() ? -1 : 1;
real_t tab_height = 3.0 * EDSCALE;
real_t tab_spacing = 1.0 * EDSCALE;
real_t dock_spacing = 2.0 * EDSCALE;
real_t dock_top_spacing = tab_height + dock_spacing;
TabContainer *context_tab_container = dock_manager->get_dock_tab_container(context_dock);
int context_tab_index = -1;
if (context_tab_container && context_tab_container->get_tab_count() > 0) {
context_tab_index = context_tab_container->get_tab_idx_from_control(context_dock);
}
// Draw center panel.
Rect2 center_panel_draw_rect = center_panel_rect.grow_individual(-dock_spacing, -dock_top_spacing, -dock_spacing, -dock_spacing);
dock_select->draw_rect(center_panel_draw_rect, unusable_dock_color);
// Draw all dock slots.
for (int i = 0; i < EditorDockManager::DOCK_SLOT_MAX; i++) {
Rect2 dock_slot_draw_rect = dock_select_rects[i].grow_individual(-dock_spacing, -dock_top_spacing, -dock_spacing, -dock_spacing);
real_t tab_width = Math::round(dock_slot_draw_rect.size.width / max_tabs);
Rect2 tab_draw_rect = Rect2(dock_slot_draw_rect.position.x, dock_select_rects[i].position.y, tab_width - tab_spacing, tab_height);
if (dock_select->is_layout_rtl()) {
tab_draw_rect.position.x += dock_slot_draw_rect.size.x - tab_draw_rect.size.x;
}
bool is_context_dock = context_tab_container == dock_manager->dock_slot[i];
int tabs_to_draw = MIN(max_tabs, dock_manager->dock_slot[i]->get_tab_count());
if (i == dock_select_rect_over_idx) {
dock_select->draw_rect(dock_slot_draw_rect, hovered_dock_color);
} else if (tabs_to_draw == 0) {
dock_select->draw_rect(dock_slot_draw_rect, unused_dock_color);
} else {
dock_select->draw_rect(dock_slot_draw_rect, used_dock_color);
}
// Draw tabs above each used dock slot.
for (int j = 0; j < tabs_to_draw; j++) {
Color tab_color = tab_unselected_color;
if (is_context_dock && context_tab_index == j) {
tab_color = tab_selected_color;
}
Rect2 tabj_draw_rect = tab_draw_rect;
tabj_draw_rect.position.x += tab_width * j * rtl_dir;
dock_select->draw_rect(tabj_draw_rect, tab_color);
}
}
}
void DockContextPopup::_update_buttons() {
TabContainer *context_tab_container = dock_manager->get_dock_tab_container(context_dock);
bool dock_at_bottom = dock_manager->_is_dock_at_bottom(context_dock);
// Update tab move buttons.
tab_move_left_button->set_disabled(true);
tab_move_right_button->set_disabled(true);
if (!dock_at_bottom && context_tab_container && context_tab_container->get_tab_count() > 0) {
int context_tab_index = context_tab_container->get_tab_idx_from_control(context_dock);
tab_move_left_button->set_disabled(context_tab_index == 0);
tab_move_right_button->set_disabled(context_tab_index >= context_tab_container->get_tab_count() - 1);
}
dock_to_bottom_button->set_visible(!dock_at_bottom && bool(context_dock->call("_can_dock_horizontal")));
reset_size();
}
void DockContextPopup::select_current_dock_in_dock_slot(int p_dock_slot) {
context_dock = dock_manager->dock_slot[p_dock_slot]->get_current_tab_control();
_update_buttons();
}
void DockContextPopup::set_dock(Control *p_dock) {
context_dock = p_dock;
_update_buttons();
}
Control *DockContextPopup::get_dock() const {
return context_dock;
}
void DockContextPopup::docks_updated() {
if (!is_visible()) {
return;
}
_update_buttons();
}
DockContextPopup::DockContextPopup() {
dock_manager = EditorDockManager::get_singleton();
dock_select_popup_vb = memnew(VBoxContainer);
add_child(dock_select_popup_vb);
HBoxContainer *header_hb = memnew(HBoxContainer);
tab_move_left_button = memnew(Button);
tab_move_left_button->set_flat(true);
tab_move_left_button->set_focus_mode(Control::FOCUS_NONE);
tab_move_left_button->connect("pressed", callable_mp(this, &DockContextPopup::_tab_move_left));
header_hb->add_child(tab_move_left_button);
Label *position_label = memnew(Label);
position_label->set_text(TTR("Dock Position"));
position_label->set_h_size_flags(Control::SIZE_EXPAND_FILL);
position_label->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER);
header_hb->add_child(position_label);
tab_move_right_button = memnew(Button);
tab_move_right_button->set_flat(true);
tab_move_right_button->set_focus_mode(Control::FOCUS_NONE);
tab_move_right_button->connect("pressed", callable_mp(this, &DockContextPopup::_tab_move_right));
header_hb->add_child(tab_move_right_button);
dock_select_popup_vb->add_child(header_hb);
dock_select = memnew(Control);
dock_select->set_custom_minimum_size(Size2(128, 64) * EDSCALE);
dock_select->connect(SceneStringName(gui_input), callable_mp(this, &DockContextPopup::_dock_select_input));
dock_select->connect(SceneStringName(draw), callable_mp(this, &DockContextPopup::_dock_select_draw));
dock_select->connect(SceneStringName(mouse_exited), callable_mp(this, &DockContextPopup::_dock_select_mouse_exited));
dock_select->set_v_size_flags(Control::SIZE_EXPAND_FILL);
dock_select_popup_vb->add_child(dock_select);
make_float_button = memnew(Button);
make_float_button->set_text(TTR("Make Floating"));
if (!EditorNode::get_singleton()->is_multi_window_enabled()) {
make_float_button->set_disabled(true);
make_float_button->set_tooltip_text(EditorNode::get_singleton()->get_multiwindow_support_tooltip_text());
} else {
make_float_button->set_tooltip_text(TTR("Make this dock floating."));
}
make_float_button->set_focus_mode(Control::FOCUS_NONE);
make_float_button->set_h_size_flags(Control::SIZE_EXPAND_FILL);
make_float_button->connect("pressed", callable_mp(this, &DockContextPopup::_float_dock));
dock_select_popup_vb->add_child(make_float_button);
dock_to_bottom_button = memnew(Button);
dock_to_bottom_button->set_text(TTR("Move to Bottom"));
dock_to_bottom_button->set_tooltip_text(TTR("Move this dock to the bottom panel."));
dock_to_bottom_button->set_focus_mode(Control::FOCUS_NONE);
dock_to_bottom_button->set_h_size_flags(Control::SIZE_EXPAND_FILL);
dock_to_bottom_button->connect("pressed", callable_mp(this, &DockContextPopup::_move_dock_to_bottom));
dock_to_bottom_button->hide();
dock_select_popup_vb->add_child(dock_to_bottom_button);
close_button = memnew(Button);
close_button->set_text(TTR("Close"));
close_button->set_tooltip_text(TTR("Close this dock."));
close_button->set_focus_mode(Control::FOCUS_NONE);
close_button->set_h_size_flags(Control::SIZE_EXPAND_FILL);
close_button->connect("pressed", callable_mp(this, &DockContextPopup::_close_dock));
dock_select_popup_vb->add_child(close_button);
}