editor_dock_manager.cpp 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392
  1. /**************************************************************************/
  2. /* editor_dock_manager.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "editor_dock_manager.h"
  31. #include "scene/gui/box_container.h"
  32. #include "scene/gui/button.h"
  33. #include "scene/gui/label.h"
  34. #include "scene/gui/split_container.h"
  35. #include "scene/gui/tab_container.h"
  36. #include "scene/main/window.h"
  37. #include "editor/docks/editor_dock.h"
  38. #include "editor/editor_node.h"
  39. #include "editor/editor_string_names.h"
  40. #include "editor/gui/editor_bottom_panel.h"
  41. #include "editor/gui/window_wrapper.h"
  42. #include "editor/settings/editor_settings.h"
  43. #include "editor/themes/editor_scale.h"
  44. #include "scene/resources/style_box_flat.h"
  45. enum class TabStyle {
  46. TEXT_ONLY,
  47. ICON_ONLY,
  48. TEXT_AND_ICON,
  49. };
  50. static inline Ref<Texture2D> _get_dock_icon(const EditorDock *p_dock, const Callable &p_icon_fetch) {
  51. Ref<Texture2D> icon = p_dock->get_dock_icon();
  52. if (icon.is_null() && !p_dock->get_icon_name().is_empty()) {
  53. icon = p_icon_fetch.call(p_dock->get_icon_name());
  54. }
  55. return icon;
  56. }
  57. bool EditorDockDragHint::can_drop_data(const Point2 &p_point, const Variant &p_data) const {
  58. return can_drop_dock;
  59. }
  60. void EditorDockDragHint::drop_data(const Point2 &p_point, const Variant &p_data) {
  61. // Drop dock into last spot if not over tabbar.
  62. if (drop_tabbar->get_rect().has_point(p_point)) {
  63. drop_tabbar->_handle_drop_data("tab_container_tab", p_point, p_data, callable_mp(this, &EditorDockDragHint::_drag_move_tab), callable_mp(this, &EditorDockDragHint::_drag_move_tab_from));
  64. } else {
  65. dock_manager->_move_dock(dock_manager->_get_dock_tab_dragged(), dock_manager->dock_slots[occupied_slot].container, drop_tabbar->get_tab_count());
  66. }
  67. }
  68. void EditorDockDragHint::_drag_move_tab(int p_from_index, int p_to_index) {
  69. dock_manager->_move_dock_tab_index(dock_manager->_get_dock_tab_dragged(), p_to_index, true);
  70. }
  71. void EditorDockDragHint::_drag_move_tab_from(TabBar *p_from_tabbar, int p_from_index, int p_to_index) {
  72. dock_manager->_move_dock(dock_manager->_get_dock_tab_dragged(), dock_manager->dock_slots[occupied_slot].container, p_to_index);
  73. }
  74. void EditorDockDragHint::gui_input(const Ref<InputEvent> &p_event) {
  75. ERR_FAIL_COND(p_event.is_null());
  76. Ref<InputEventMouseMotion> mm = p_event;
  77. if (mm.is_valid()) {
  78. Point2 pos = mm->get_position();
  79. // Redraw when inside the tabbar and just exited.
  80. if (mouse_inside_tabbar) {
  81. queue_redraw();
  82. }
  83. mouse_inside_tabbar = drop_tabbar->get_rect().has_point(pos);
  84. }
  85. }
  86. void EditorDockDragHint::set_slot(DockConstants::DockSlot p_slot) {
  87. occupied_slot = p_slot;
  88. drop_tabbar = dock_manager->dock_slots[occupied_slot].container->get_tab_bar();
  89. }
  90. void EditorDockDragHint::_notification(int p_what) {
  91. switch (p_what) {
  92. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  93. if (EditorSettings::get_singleton()->check_changed_settings_in_group("interface/theme")) {
  94. dock_drop_highlight->set_corner_radius_all(EDSCALE * EDITOR_GET("interface/theme/corner_radius").operator int());
  95. if (mouse_inside) {
  96. queue_redraw();
  97. }
  98. }
  99. } break;
  100. case NOTIFICATION_THEME_CHANGED: {
  101. valid_drop_color = get_theme_color(SNAME("accent_color"), EditorStringName(Editor));
  102. } break;
  103. case NOTIFICATION_MOUSE_ENTER:
  104. case NOTIFICATION_MOUSE_EXIT: {
  105. mouse_inside = p_what == NOTIFICATION_MOUSE_ENTER;
  106. queue_redraw();
  107. } break;
  108. case NOTIFICATION_DRAG_BEGIN: {
  109. EditorDock *dragged_dock = dock_manager->_get_dock_tab_dragged();
  110. if (!dragged_dock) {
  111. return;
  112. }
  113. can_drop_dock = dragged_dock->get_available_layouts() & (EditorDock::DockLayout)EditorDockManager::get_singleton()->dock_slots[occupied_slot].layout;
  114. dock_drop_highlight->set_border_color(valid_drop_color);
  115. dock_drop_highlight->set_bg_color(valid_drop_color * Color(1, 1, 1, 0.1));
  116. } break;
  117. case NOTIFICATION_DRAG_END: {
  118. dock_manager->_dock_drag_stopped();
  119. can_drop_dock = false;
  120. mouse_inside = false;
  121. hide();
  122. } break;
  123. case NOTIFICATION_DRAW: {
  124. if (!mouse_inside || !can_drop_dock) {
  125. return;
  126. }
  127. // Draw highlights around docks that can be dropped.
  128. Rect2 dock_rect = Rect2(Point2(), get_size()).grow(2 * EDSCALE);
  129. draw_style_box(dock_drop_highlight, dock_rect);
  130. // Only display tabbar hint if the mouse is over the tabbar.
  131. if (drop_tabbar->get_global_rect().has_point(get_global_mouse_position())) {
  132. draw_set_transform(drop_tabbar->get_position()); // The TabBar isn't always on top.
  133. drop_tabbar->_draw_tab_drop(get_canvas_item());
  134. }
  135. } break;
  136. }
  137. }
  138. EditorDockDragHint::EditorDockDragHint() {
  139. dock_manager = EditorDockManager::get_singleton();
  140. set_as_top_level(true);
  141. dock_drop_highlight.instantiate();
  142. dock_drop_highlight->set_corner_radius_all(EDSCALE * EDITOR_GET("interface/theme/corner_radius").operator int());
  143. dock_drop_highlight->set_border_width_all(Math::round(2 * EDSCALE));
  144. }
  145. ////////////////////////////////////////////////
  146. ////////////////////////////////////////////////
  147. void DockSplitContainer::_update_visibility() {
  148. if (is_updating) {
  149. return;
  150. }
  151. is_updating = true;
  152. bool any_visible = false;
  153. for (int i = 0; i < get_child_count(false); i++) {
  154. Control *c = Object::cast_to<Control>(get_child(i, false));
  155. if (!c || !c->is_visible() || c->is_set_as_top_level()) {
  156. continue;
  157. }
  158. any_visible = c;
  159. break;
  160. }
  161. set_visible(any_visible);
  162. is_updating = false;
  163. }
  164. void DockSplitContainer::add_child_notify(Node *p_child) {
  165. SplitContainer::add_child_notify(p_child);
  166. Control *child_control = nullptr;
  167. for (int i = 0; i < get_child_count(false); i++) {
  168. Control *c = Object::cast_to<Control>(get_child(i, false));
  169. if (!c || c->is_set_as_top_level()) {
  170. continue;
  171. }
  172. if (p_child == c) {
  173. child_control = c;
  174. break;
  175. }
  176. }
  177. if (!child_control) {
  178. return;
  179. }
  180. child_control->connect(SceneStringName(visibility_changed), callable_mp(this, &DockSplitContainer::_update_visibility));
  181. _update_visibility();
  182. }
  183. void DockSplitContainer::remove_child_notify(Node *p_child) {
  184. SplitContainer::remove_child_notify(p_child);
  185. Control *child_control = nullptr;
  186. for (int i = 0; i < get_child_count(false); i++) {
  187. Control *c = Object::cast_to<Control>(get_child(i, false));
  188. if (!c || c->is_set_as_top_level()) {
  189. continue;
  190. }
  191. if (p_child == c) {
  192. child_control = c;
  193. break;
  194. }
  195. }
  196. if (!child_control) {
  197. return;
  198. }
  199. child_control->disconnect(SceneStringName(visibility_changed), callable_mp(this, &DockSplitContainer::_update_visibility));
  200. _update_visibility();
  201. }
  202. DockSplitContainer::DockSplitContainer() {
  203. if (EDITOR_GET("interface/touchscreen/enable_touch_optimizations")) {
  204. callable_mp((SplitContainer *)this, &SplitContainer::set_touch_dragger_enabled).call_deferred(true);
  205. }
  206. }
  207. ////////////////////////////////////////////////
  208. ////////////////////////////////////////////////
  209. EditorDock *EditorDockManager::_get_dock_tab_dragged() {
  210. if (dock_tab_dragged) {
  211. return dock_tab_dragged;
  212. }
  213. Dictionary dock_drop_data = dock_slots[DockConstants::DOCK_SLOT_LEFT_BL].container->get_viewport()->gui_get_drag_data();
  214. // Check if we are dragging a dock.
  215. if (dock_drop_data.get("type", "").operator String() != "tab") {
  216. return nullptr;
  217. }
  218. const String tab_type = dock_drop_data.get("tab_type", "");
  219. if (tab_type == "tab_container_tab") {
  220. Node *source_tab_bar = EditorNode::get_singleton()->get_node(dock_drop_data["from_path"]);
  221. if (!source_tab_bar) {
  222. return nullptr;
  223. }
  224. TabContainer *source_tab_container = Object::cast_to<TabContainer>(source_tab_bar->get_parent());
  225. if (!source_tab_container) {
  226. return nullptr;
  227. }
  228. dock_tab_dragged = Object::cast_to<EditorDock>(source_tab_container->get_tab_control(dock_drop_data["tab_index"]));
  229. if (!dock_tab_dragged) {
  230. return nullptr;
  231. }
  232. for (int i = 0; i < DockConstants::DOCK_SLOT_MAX; i++) {
  233. if (dock_slots[i].container->is_visible_in_tree()) {
  234. dock_slots[i].drag_hint->set_rect(dock_slots[i].container->get_global_rect());
  235. dock_slots[i].drag_hint->show();
  236. }
  237. }
  238. return dock_tab_dragged;
  239. }
  240. return nullptr;
  241. }
  242. void EditorDockManager::_dock_drag_stopped() {
  243. dock_tab_dragged = nullptr;
  244. }
  245. void EditorDockManager::_dock_split_dragged(int p_offset) {
  246. EditorNode::get_singleton()->save_editor_layout_delayed();
  247. }
  248. void EditorDockManager::_dock_container_popup(int p_tab_idx, TabContainer *p_dock_container) {
  249. EditorDock *hovered_dock = Object::cast_to<EditorDock>(p_dock_container->get_tab_control(p_tab_idx));
  250. if (hovered_dock == nullptr) {
  251. return;
  252. }
  253. // Right click context menu.
  254. dock_context_popup->set_dock(hovered_dock);
  255. dock_context_popup->set_position(p_dock_container->get_tab_bar()->get_screen_position() + p_dock_container->get_tab_bar()->get_local_mouse_position());
  256. dock_context_popup->popup();
  257. }
  258. void EditorDockManager::_dock_container_update_visibility(TabContainer *p_dock_container) {
  259. if (!docks_visible) {
  260. return;
  261. }
  262. // Hide the dock container if there are no tabs.
  263. p_dock_container->set_visible(p_dock_container->get_tab_count() > 0);
  264. }
  265. void EditorDockManager::_update_layout() {
  266. if (!dock_context_popup->is_inside_tree() || EditorNode::get_singleton()->is_exiting()) {
  267. return;
  268. }
  269. dock_context_popup->docks_updated();
  270. update_docks_menu();
  271. EditorNode::get_singleton()->save_editor_layout_delayed();
  272. }
  273. void EditorDockManager::update_docks_menu() {
  274. docks_menu->clear();
  275. docks_menu->reset_size();
  276. const Ref<Texture2D> default_icon = docks_menu->get_editor_theme_icon(SNAME("Window"));
  277. const Color closed_icon_color_mod = Color(1, 1, 1, 0.5);
  278. bool global_menu = !bool(EDITOR_GET("interface/editor/use_embedded_menu")) && NativeMenu::get_singleton()->has_feature(NativeMenu::FEATURE_GLOBAL_MENU);
  279. bool dark_mode = DisplayServer::get_singleton()->is_dark_mode_supported() && DisplayServer::get_singleton()->is_dark_mode();
  280. int icon_max_width = EditorNode::get_singleton()->get_editor_theme()->get_constant(SNAME("class_icon_size"), EditorStringName(Editor));
  281. // Add docks.
  282. docks_menu_docks.clear();
  283. int id = 0;
  284. const Callable icon_fetch = callable_mp(EditorNode::get_singleton(), &EditorNode::get_editor_theme_native_menu_icon).bind(global_menu, dark_mode);
  285. for (EditorDock *dock : all_docks) {
  286. if (!dock->enabled || !dock->global) {
  287. continue;
  288. }
  289. if (dock->shortcut.is_valid()) {
  290. docks_menu->add_shortcut(dock->shortcut, id);
  291. docks_menu->set_item_text(id, dock->get_display_title());
  292. } else {
  293. docks_menu->add_item(dock->get_display_title(), id);
  294. }
  295. docks_menu->set_item_icon_max_width(id, icon_max_width);
  296. const Ref<Texture2D> icon = _get_dock_icon(dock, icon_fetch);
  297. docks_menu->set_item_icon(id, icon.is_valid() ? icon : default_icon);
  298. if (!dock->is_open) {
  299. docks_menu->set_item_icon_modulate(id, closed_icon_color_mod);
  300. docks_menu->set_item_tooltip(id, vformat(TTR("Open the %s dock."), dock->get_display_title()));
  301. } else {
  302. docks_menu->set_item_tooltip(id, vformat(TTR("Focus on the %s dock."), dock->get_display_title()));
  303. }
  304. docks_menu_docks.push_back(dock);
  305. id++;
  306. }
  307. }
  308. void EditorDockManager::_docks_menu_option(int p_id) {
  309. EditorDock *dock = docks_menu_docks[p_id];
  310. ERR_FAIL_NULL(dock);
  311. ERR_FAIL_COND_MSG(!all_docks.has(dock), vformat("Menu option for unknown dock '%s'.", dock->get_display_title()));
  312. if (dock->enabled && dock->is_open) {
  313. PopupMenu *parent_menu = Object::cast_to<PopupMenu>(docks_menu->get_parent());
  314. ERR_FAIL_NULL(parent_menu);
  315. parent_menu->hide();
  316. }
  317. focus_dock(dock);
  318. }
  319. void EditorDockManager::_window_close_request(WindowWrapper *p_wrapper) {
  320. // Give the dock back to the original owner.
  321. EditorDock *dock = _close_window(p_wrapper);
  322. ERR_FAIL_COND(!all_docks.has(dock));
  323. if (dock->dock_slot_index != DockConstants::DOCK_SLOT_NONE) {
  324. dock->is_open = false;
  325. open_dock(dock);
  326. focus_dock(dock);
  327. } else {
  328. close_dock(dock);
  329. }
  330. }
  331. EditorDock *EditorDockManager::_close_window(WindowWrapper *p_wrapper) {
  332. p_wrapper->set_block_signals(true);
  333. EditorDock *dock = Object::cast_to<EditorDock>(p_wrapper->release_wrapped_control());
  334. p_wrapper->set_block_signals(false);
  335. ERR_FAIL_COND_V(!all_docks.has(dock), nullptr);
  336. dock->dock_window = nullptr;
  337. dock_windows.erase(p_wrapper);
  338. p_wrapper->queue_free();
  339. return dock;
  340. }
  341. void EditorDockManager::_open_dock_in_window(EditorDock *p_dock, bool p_show_window, bool p_reset_size) {
  342. ERR_FAIL_NULL(p_dock);
  343. Size2 borders = Size2(4, 4) * EDSCALE;
  344. // Remember size and position before removing it from the main window.
  345. Size2 dock_size = p_dock->get_size() + borders * 2;
  346. Point2 dock_screen_pos = p_dock->get_screen_position();
  347. WindowWrapper *wrapper = memnew(WindowWrapper);
  348. wrapper->set_window_title(vformat(TTR("%s - Godot Engine"), TTR(p_dock->get_display_title())));
  349. wrapper->set_margins_enabled(true);
  350. EditorNode::get_singleton()->get_gui_base()->add_child(wrapper);
  351. _move_dock(p_dock, nullptr);
  352. p_dock->update_layout(EditorDock::DOCK_LAYOUT_FLOATING);
  353. p_dock->current_layout = EditorDock::DOCK_LAYOUT_FLOATING;
  354. wrapper->set_wrapped_control(p_dock);
  355. p_dock->dock_window = wrapper;
  356. p_dock->is_open = true;
  357. p_dock->show();
  358. wrapper->connect("window_close_requested", callable_mp(this, &EditorDockManager::_window_close_request).bind(wrapper));
  359. dock_windows.push_back(wrapper);
  360. if (p_show_window) {
  361. wrapper->restore_window(Rect2i(dock_screen_pos, dock_size), EditorNode::get_singleton()->get_gui_base()->get_window()->get_current_screen());
  362. _update_layout();
  363. if (p_reset_size) {
  364. // Use a default size of one third the current window size.
  365. Size2i popup_size = EditorNode::get_singleton()->get_window()->get_size() / 3.0;
  366. p_dock->get_window()->set_size(popup_size);
  367. p_dock->get_window()->move_to_center();
  368. }
  369. p_dock->get_window()->grab_focus();
  370. }
  371. }
  372. void EditorDockManager::_restore_dock_to_saved_window(EditorDock *p_dock, const Dictionary &p_window_dump) {
  373. if (!p_dock->dock_window) {
  374. _open_dock_in_window(p_dock, false);
  375. }
  376. p_dock->dock_window->restore_window_from_saved_position(
  377. p_window_dump.get("window_rect", Rect2i()),
  378. p_window_dump.get("window_screen", -1),
  379. p_window_dump.get("window_screen_rect", Rect2i()));
  380. }
  381. void EditorDockManager::_move_dock_tab_index(EditorDock *p_dock, int p_tab_index, bool p_set_current) {
  382. TabContainer *dock_tab_container = Object::cast_to<TabContainer>(p_dock->get_parent());
  383. if (!dock_tab_container) {
  384. return;
  385. }
  386. dock_tab_container->set_block_signals(true);
  387. int target_index = CLAMP(p_tab_index, 0, dock_tab_container->get_tab_count() - 1);
  388. dock_tab_container->move_child(p_dock, dock_tab_container->get_tab_control(target_index)->get_index(false));
  389. p_dock->previous_tab_index = target_index;
  390. if (p_set_current) {
  391. dock_tab_container->set_current_tab(target_index);
  392. }
  393. dock_tab_container->set_block_signals(false);
  394. }
  395. void EditorDockManager::_move_dock(EditorDock *p_dock, Control *p_target, int p_tab_index, bool p_set_current) {
  396. ERR_FAIL_NULL(p_dock);
  397. ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot move unknown dock '%s'.", p_dock->get_display_title()));
  398. Node *parent = p_dock->get_parent();
  399. if (parent == p_target) {
  400. if (parent && p_tab_index >= 0) {
  401. // Only change the tab index.
  402. _move_dock_tab_index(p_dock, p_tab_index, p_set_current);
  403. }
  404. return;
  405. }
  406. // Remove dock from its existing parent.
  407. if (parent) {
  408. if (p_dock->dock_window) {
  409. _close_window(p_dock->dock_window);
  410. } else {
  411. TabContainer *parent_tabs = Object::cast_to<TabContainer>(parent);
  412. if (parent_tabs) {
  413. p_dock->previous_tab_index = parent_tabs->get_tab_idx_from_control(p_dock);
  414. }
  415. parent->set_block_signals(true);
  416. parent->remove_child(p_dock);
  417. parent->set_block_signals(false);
  418. if (parent_tabs) {
  419. _dock_container_update_visibility(parent_tabs);
  420. }
  421. }
  422. }
  423. if (!p_target) {
  424. return;
  425. }
  426. if (p_target != closed_dock_parent) {
  427. EditorDock::DockLayout layout = p_target->get_meta("dock_layout");
  428. if (layout != p_dock->current_layout) {
  429. p_dock->update_layout(layout);
  430. p_dock->current_layout = layout;
  431. }
  432. p_dock->dock_slot_index = p_target->get_meta("dock_slot");
  433. }
  434. // Add dock to its new parent, at the given tab index.
  435. p_target->set_block_signals(true);
  436. p_target->add_child(p_dock);
  437. p_target->set_block_signals(false);
  438. TabContainer *dock_tab_container = Object::cast_to<TabContainer>(p_target);
  439. if (dock_tab_container) {
  440. if (dock_tab_container->is_inside_tree()) {
  441. _update_tab_style(p_dock);
  442. }
  443. if (p_tab_index >= 0) {
  444. _move_dock_tab_index(p_dock, p_tab_index, p_set_current);
  445. }
  446. _dock_container_update_visibility(dock_tab_container);
  447. }
  448. }
  449. void EditorDockManager::_queue_update_tab_style(EditorDock *p_dock) {
  450. if (dirty_docks.is_empty()) {
  451. callable_mp(this, &EditorDockManager::_update_dirty_dock_tabs).call_deferred();
  452. }
  453. dirty_docks.insert(p_dock);
  454. }
  455. void EditorDockManager::_update_dirty_dock_tabs() {
  456. bool update_menu = false;
  457. for (EditorDock *dock : dirty_docks) {
  458. update_menu = update_menu || dock->global;
  459. _update_tab_style(dock);
  460. }
  461. dirty_docks.clear();
  462. if (update_menu) {
  463. update_docks_menu();
  464. }
  465. }
  466. void EditorDockManager::_update_tab_style(EditorDock *p_dock) {
  467. if (!p_dock->enabled || !p_dock->is_open) {
  468. return; // Disabled by feature profile or manually closed by user.
  469. }
  470. if (p_dock->dock_window) {
  471. return; // Floating.
  472. }
  473. TabContainer *tab_container = get_dock_tab_container(p_dock);
  474. ERR_FAIL_NULL(tab_container);
  475. int index = tab_container->get_tab_idx_from_control(p_dock);
  476. ERR_FAIL_COND(index == -1);
  477. tab_container->get_tab_bar()->set_font_color_override_all(index, p_dock->title_color);
  478. const TabStyle style = (tab_container == EditorNode::get_bottom_panel())
  479. ? (TabStyle)EDITOR_GET("interface/editor/bottom_dock_tab_style").operator int()
  480. : (TabStyle)EDITOR_GET("interface/editor/dock_tab_style").operator int();
  481. const Ref<Texture2D> icon = _get_dock_icon(p_dock, callable_mp((Control *)tab_container, &Control::get_editor_theme_icon));
  482. bool assign_icon = p_dock->force_show_icon;
  483. String tooltip;
  484. switch (style) {
  485. case TabStyle::TEXT_ONLY: {
  486. tab_container->set_tab_title(index, p_dock->get_display_title());
  487. } break;
  488. case TabStyle::ICON_ONLY: {
  489. tab_container->set_tab_title(index, icon.is_valid() ? String() : p_dock->get_display_title());
  490. tooltip = TTR(p_dock->get_display_title());
  491. assign_icon = true;
  492. } break;
  493. case TabStyle::TEXT_AND_ICON: {
  494. tab_container->set_tab_title(index, p_dock->get_display_title());
  495. assign_icon = true;
  496. } break;
  497. }
  498. if (p_dock->shortcut.is_valid() && p_dock->shortcut->has_valid_event()) {
  499. tooltip += (tooltip.is_empty() ? "" : "\n") + TTR(p_dock->shortcut->get_name()) + " (" + p_dock->shortcut->get_as_text() + ")";
  500. }
  501. tab_container->set_tab_tooltip(index, tooltip);
  502. if (assign_icon) {
  503. tab_container->set_tab_icon(index, icon);
  504. } else {
  505. tab_container->set_tab_icon(index, Ref<Texture2D>());
  506. }
  507. }
  508. void EditorDockManager::save_docks_to_config(Ref<ConfigFile> p_layout, const String &p_section) const {
  509. // Save docks by dock slot.
  510. for (int i = 0; i < DockConstants::DOCK_SLOT_MAX; i++) {
  511. const DockSlot &dock_slot = dock_slots[i];
  512. PackedStringArray names;
  513. names.reserve_exact(dock_slot.container->get_tab_count());
  514. for (int j = 0; j < dock_slot.container->get_tab_count(); j++) {
  515. const String name = Object::cast_to<EditorDock>(dock_slot.container->get_tab_control(j))->get_effective_layout_key();
  516. names.append(name);
  517. }
  518. const String config_key = "dock_" + itos(i + 1);
  519. if (p_layout->has_section_key(p_section, config_key)) {
  520. p_layout->erase_section_key(p_section, config_key);
  521. }
  522. if (!names.is_empty()) {
  523. p_layout->set_value(p_section, config_key, String(",").join(names));
  524. }
  525. const String tab_key = config_key + "_selected_tab_idx";
  526. int selected_tab_idx = dock_slots[i].container->get_current_tab();
  527. if (selected_tab_idx >= 0) {
  528. p_layout->set_value(p_section, tab_key, selected_tab_idx);
  529. } else if (p_layout->has_section_key(p_section, tab_key)) {
  530. p_layout->erase_section_key(p_section, tab_key);
  531. }
  532. }
  533. // Clear the special dock slot for docks without default slots (index -1 = dock_0).
  534. // This prevents closed docks from being infinitely appended to the config on each save.
  535. const String no_slot_config_key = "dock_0";
  536. if (p_layout->has_section_key(p_section, no_slot_config_key)) {
  537. p_layout->erase_section_key(p_section, no_slot_config_key);
  538. }
  539. // Save docks in windows.
  540. Dictionary floating_docks_dump;
  541. for (WindowWrapper *wrapper : dock_windows) {
  542. EditorDock *dock = Object::cast_to<EditorDock>(wrapper->get_wrapped_control());
  543. Dictionary window_dump;
  544. window_dump["window_rect"] = wrapper->get_window_rect();
  545. int screen = wrapper->get_window_screen();
  546. window_dump["window_screen"] = wrapper->get_window_screen();
  547. window_dump["window_screen_rect"] = DisplayServer::get_singleton()->screen_get_usable_rect(screen);
  548. String name = dock->get_effective_layout_key();
  549. if (!dock->transient) {
  550. floating_docks_dump[name] = window_dump;
  551. }
  552. // Append to regular dock section so we know where to restore it to.
  553. int dock_slot_id = dock->dock_slot_index;
  554. String config_key = "dock_" + itos(dock_slot_id + 1);
  555. String names = p_layout->get_value(p_section, config_key, "");
  556. if (names.is_empty()) {
  557. names = name;
  558. } else {
  559. names += "," + name;
  560. }
  561. p_layout->set_value(p_section, config_key, names);
  562. }
  563. p_layout->set_value(p_section, "dock_floating", floating_docks_dump);
  564. // Save closed docks.
  565. Array closed_docks_dump;
  566. for (const EditorDock *dock : all_docks) {
  567. const String section_name = p_section + "/" + dock->get_effective_layout_key();
  568. dock->save_layout_to_config(p_layout, section_name);
  569. if (dock->is_open) {
  570. continue;
  571. }
  572. const String name = dock->get_effective_layout_key();
  573. if (!dock->is_open && !dock->transient) {
  574. closed_docks_dump.push_back(name);
  575. }
  576. int dock_slot_id = dock->dock_slot_index;
  577. String config_key = "dock_" + itos(dock_slot_id + 1);
  578. String names = p_layout->get_value(p_section, config_key, "");
  579. if (names.is_empty()) {
  580. names = name;
  581. } else {
  582. names += "," + name;
  583. }
  584. p_layout->set_value(p_section, config_key, names);
  585. }
  586. p_layout->set_value(p_section, "dock_closed", closed_docks_dump);
  587. // Save SplitContainer offsets.
  588. for (int i = 0; i < vsplits.size(); i++) {
  589. if (vsplits[i]->is_visible_in_tree()) {
  590. p_layout->set_value(p_section, "dock_split_" + itos(i + 1), vsplits[i]->get_split_offset());
  591. }
  592. }
  593. PackedInt32Array split_offsets = main_hsplit->get_split_offsets();
  594. int index = 0;
  595. for (int i = 0; i < vsplits.size(); i++) {
  596. int value = 0;
  597. if (vsplits[i]->is_visible() && index < split_offsets.size()) {
  598. value = split_offsets[index] / EDSCALE;
  599. index++;
  600. }
  601. p_layout->set_value(p_section, "dock_hsplit_" + itos(i + 1), value);
  602. }
  603. }
  604. void EditorDockManager::load_docks_from_config(Ref<ConfigFile> p_layout, const String &p_section, bool p_first_load) {
  605. Dictionary floating_docks_dump = p_layout->get_value(p_section, "dock_floating", Dictionary());
  606. Array closed_docks = p_layout->get_value(p_section, "dock_closed", Array());
  607. bool allow_floating_docks = EditorNode::get_singleton()->is_multi_window_enabled() && (!p_first_load || EDITOR_GET("interface/multi_window/restore_windows_on_load"));
  608. // Store the docks by name for easy lookup.
  609. HashMap<String, EditorDock *> dock_map;
  610. for (EditorDock *dock : all_docks) {
  611. dock_map[dock->get_effective_layout_key()] = dock;
  612. }
  613. // Load docks by slot. Index -1 is for docks that have no slot.
  614. for (int i = -1; i < DockConstants::DOCK_SLOT_MAX; i++) {
  615. if (!p_layout->has_section_key(p_section, "dock_" + itos(i + 1))) {
  616. continue;
  617. }
  618. Vector<String> names = String(p_layout->get_value(p_section, "dock_" + itos(i + 1))).split(",");
  619. for (int j = names.size() - 1; j >= 0; j--) {
  620. const String &name = names[j];
  621. const String section_name = p_section + "/" + name;
  622. if (!dock_map.has(name)) {
  623. continue;
  624. }
  625. EditorDock *dock = dock_map[name];
  626. if (!dock->enabled) {
  627. // Don't is_open disabled docks.
  628. dock->load_layout_from_config(p_layout, section_name);
  629. continue;
  630. }
  631. if (allow_floating_docks && floating_docks_dump.has(name)) {
  632. _restore_dock_to_saved_window(dock, floating_docks_dump[name]);
  633. } else if (i >= 0 && !(dock->transient && !dock->is_open)) {
  634. // Safe to include transient open docks here because they won't be in the closed dock dump.
  635. if (closed_docks.has(name)) {
  636. dock->is_open = false;
  637. dock->hide();
  638. _move_dock(dock, closed_dock_parent);
  639. } else {
  640. dock->is_open = true;
  641. _move_dock(dock, dock_slots[i].container, 0);
  642. }
  643. }
  644. dock->load_layout_from_config(p_layout, section_name);
  645. dock->dock_slot_index = i;
  646. dock->previous_tab_index = i >= 0 ? j : 0;
  647. }
  648. }
  649. // Set the selected tabs.
  650. for (int i = 0; i < DockConstants::DOCK_SLOT_MAX; i++) {
  651. const DockSlot &dock_slot = dock_slots[i];
  652. int selected_tab_idx = p_layout->get_value(p_section, "dock_" + itos(i + 1) + "_selected_tab_idx", -1);
  653. if (selected_tab_idx <= 0 || selected_tab_idx >= dock_slot.container->get_tab_count()) {
  654. if (i == DockConstants::DOCK_SLOT_BOTTOM) {
  655. dock_slot.container->set_current_tab(-1);
  656. }
  657. continue;
  658. }
  659. EditorDock *selected_dock = Object::cast_to<EditorDock>(dock_slot.container->get_tab_control(selected_tab_idx));
  660. if (!selected_dock) {
  661. continue;
  662. }
  663. dock_slot.container->set_block_signals(true);
  664. dock_slot.container->set_current_tab(selected_tab_idx);
  665. dock_slot.container->set_block_signals(false);
  666. }
  667. // Load SplitContainer offsets.
  668. PackedInt32Array offsets;
  669. for (int i = 0; i < vsplits.size(); i++) {
  670. if (!p_layout->has_section_key(p_section, "dock_split_" + itos(i + 1))) {
  671. continue;
  672. }
  673. int ofs = p_layout->get_value(p_section, "dock_split_" + itos(i + 1));
  674. vsplits[i]->set_split_offset(ofs);
  675. // Only visible ones need a split offset for the main hsplit, even though they all have a value saved.
  676. if (vsplits[i]->is_visible() && p_layout->has_section_key(p_section, "dock_hsplit_" + itos(i + 1))) {
  677. int offset = p_layout->get_value(p_section, "dock_hsplit_" + itos(i + 1));
  678. offsets.push_back(offset * EDSCALE);
  679. }
  680. }
  681. main_hsplit->set_split_offsets(offsets);
  682. update_docks_menu();
  683. }
  684. void EditorDockManager::set_dock_enabled(EditorDock *p_dock, bool p_enabled) {
  685. ERR_FAIL_NULL(p_dock);
  686. ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot set enabled unknown dock '%s'.", p_dock->get_display_title()));
  687. if (p_dock->enabled == p_enabled) {
  688. return;
  689. }
  690. p_dock->enabled = p_enabled;
  691. if (p_enabled) {
  692. open_dock(p_dock, false);
  693. } else {
  694. close_dock(p_dock);
  695. }
  696. }
  697. void EditorDockManager::close_dock(EditorDock *p_dock) {
  698. ERR_FAIL_NULL(p_dock);
  699. ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot close unknown dock '%s'.", p_dock->get_display_title()));
  700. if (!p_dock->is_open) {
  701. return;
  702. }
  703. p_dock->is_open = false;
  704. EditorBottomPanel *bottom_panel = EditorNode::get_bottom_panel();
  705. if (get_dock_tab_container(p_dock) == bottom_panel && bottom_panel->get_current_tab_control() == p_dock) {
  706. bottom_panel->hide_bottom_panel();
  707. }
  708. // Hide before moving to remove inconsistent signals.
  709. p_dock->hide();
  710. _move_dock(p_dock, closed_dock_parent);
  711. _update_layout();
  712. }
  713. void EditorDockManager::open_dock(EditorDock *p_dock, bool p_set_current) {
  714. ERR_FAIL_NULL(p_dock);
  715. ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot open unknown dock '%s'.", p_dock->get_display_title()));
  716. if (p_dock->is_open) {
  717. // Show the dock if it is already open.
  718. if (p_set_current) {
  719. _make_dock_visible(p_dock, false);
  720. }
  721. return;
  722. }
  723. p_dock->is_open = true;
  724. // Open dock to its previous location.
  725. if (p_dock->dock_slot_index != DockConstants::DOCK_SLOT_NONE) {
  726. TabContainer *slot = dock_slots[p_dock->dock_slot_index].container;
  727. int tab_index = p_dock->previous_tab_index;
  728. if (tab_index < 0) {
  729. tab_index = slot->get_tab_count();
  730. }
  731. _move_dock(p_dock, slot, tab_index, p_set_current);
  732. } else {
  733. _open_dock_in_window(p_dock, true, true);
  734. return;
  735. }
  736. _update_layout();
  737. }
  738. void EditorDockManager::make_dock_floating(EditorDock *p_dock) {
  739. ERR_FAIL_NULL(p_dock);
  740. ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot make unknown dock '%s' floating.", p_dock->get_display_title()));
  741. if (!p_dock->dock_window) {
  742. _open_dock_in_window(p_dock);
  743. }
  744. }
  745. TabContainer *EditorDockManager::get_dock_tab_container(Control *p_dock) const {
  746. return Object::cast_to<TabContainer>(p_dock->get_parent());
  747. }
  748. void EditorDockManager::_make_dock_visible(EditorDock *p_dock, bool p_grab_focus) {
  749. if (p_dock->dock_window) {
  750. if (p_grab_focus) {
  751. p_dock->get_window()->grab_focus();
  752. }
  753. return;
  754. }
  755. if (p_dock->get_parent() == EditorNode::get_bottom_panel()) {
  756. if (EditorNode::get_bottom_panel()->is_locked()) {
  757. return;
  758. }
  759. } else if (!docks_visible) {
  760. return;
  761. }
  762. TabContainer *tab_container = get_dock_tab_container(p_dock);
  763. if (tab_container) {
  764. if (p_grab_focus) {
  765. tab_container->get_tab_bar()->grab_focus();
  766. }
  767. int tab_index = tab_container->get_tab_idx_from_control(p_dock);
  768. tab_container->set_current_tab(tab_index);
  769. }
  770. }
  771. void EditorDockManager::focus_dock(EditorDock *p_dock) {
  772. ERR_FAIL_NULL(p_dock);
  773. ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot focus unknown dock '%s'.", p_dock->get_display_title()));
  774. if (!p_dock->enabled) {
  775. return;
  776. }
  777. if (!p_dock->is_open) {
  778. open_dock(p_dock, false);
  779. }
  780. _make_dock_visible(p_dock, true);
  781. }
  782. void EditorDockManager::add_dock(EditorDock *p_dock) {
  783. ERR_FAIL_NULL(p_dock);
  784. ERR_FAIL_COND_MSG(all_docks.has(p_dock), vformat("Cannot add dock '%s', already added.", p_dock->get_display_title()));
  785. p_dock->dock_slot_index = p_dock->default_slot;
  786. all_docks.push_back(p_dock);
  787. p_dock->connect("_tab_style_changed", callable_mp(this, &EditorDockManager::_queue_update_tab_style).bind(p_dock));
  788. p_dock->connect("renamed", callable_mp(this, &EditorDockManager::_queue_update_tab_style).bind(p_dock));
  789. if (p_dock->default_slot != EditorDock::DOCK_SLOT_NONE) {
  790. open_dock(p_dock, false);
  791. } else {
  792. closed_dock_parent->add_child(p_dock);
  793. p_dock->hide();
  794. _update_layout();
  795. }
  796. }
  797. void EditorDockManager::remove_dock(EditorDock *p_dock) {
  798. ERR_FAIL_NULL(p_dock);
  799. ERR_FAIL_COND_MSG(!all_docks.has(p_dock), vformat("Cannot remove unknown dock '%s'.", p_dock->get_display_title()));
  800. _move_dock(p_dock, nullptr);
  801. all_docks.erase(p_dock);
  802. p_dock->disconnect("_tab_style_changed", callable_mp(this, &EditorDockManager::_queue_update_tab_style));
  803. p_dock->disconnect("renamed", callable_mp(this, &EditorDockManager::_queue_update_tab_style));
  804. _update_layout();
  805. }
  806. void EditorDockManager::set_docks_visible(bool p_show) {
  807. if (docks_visible == p_show) {
  808. return;
  809. }
  810. docks_visible = p_show;
  811. for (int i = 0; i < DockConstants::DOCK_SLOT_BOTTOM; i++) {
  812. // Show and hide in reverse order due to the SplitContainer prioritizing the last split offset.
  813. TabContainer *container = dock_slots[docks_visible ? i : DockConstants::DOCK_SLOT_BOTTOM - i - 1].container;
  814. container->set_visible(docks_visible && container->get_tab_count() > 0);
  815. }
  816. _update_layout();
  817. }
  818. bool EditorDockManager::are_docks_visible() const {
  819. return docks_visible;
  820. }
  821. void EditorDockManager::update_tab_styles() {
  822. for (EditorDock *dock : all_docks) {
  823. _update_tab_style(dock);
  824. }
  825. }
  826. void EditorDockManager::set_tab_icon_max_width(int p_max_width) {
  827. for (int i = 0; i < DockConstants::DOCK_SLOT_MAX; i++) {
  828. TabContainer *tab_container = dock_slots[i].container;
  829. tab_container->add_theme_constant_override(SNAME("icon_max_width"), p_max_width);
  830. }
  831. }
  832. void EditorDockManager::add_vsplit(DockSplitContainer *p_split) {
  833. vsplits.push_back(p_split);
  834. p_split->connect("dragged", callable_mp(this, &EditorDockManager::_dock_split_dragged));
  835. }
  836. void EditorDockManager::set_hsplit(DockSplitContainer *p_split) {
  837. main_hsplit = p_split;
  838. p_split->connect("dragged", callable_mp(this, &EditorDockManager::_dock_split_dragged));
  839. }
  840. void EditorDockManager::register_dock_slot(DockConstants::DockSlot p_dock_slot, TabContainer *p_tab_container, DockConstants::DockLayout p_layout) {
  841. ERR_FAIL_NULL(p_tab_container);
  842. ERR_FAIL_INDEX(p_dock_slot, DockConstants::DOCK_SLOT_MAX);
  843. DockSlot slot;
  844. slot.layout = p_layout;
  845. slot.container = p_tab_container;
  846. p_tab_container->set_popup(dock_context_popup);
  847. p_tab_container->connect("pre_popup_pressed", callable_mp(dock_context_popup, &DockContextPopup::select_current_dock_in_dock_slot).bind(p_dock_slot));
  848. p_tab_container->get_tab_bar()->set_switch_on_release(true);
  849. p_tab_container->get_tab_bar()->connect("tab_rmb_clicked", callable_mp(this, &EditorDockManager::_dock_container_popup).bind(p_tab_container));
  850. p_tab_container->set_drag_to_rearrange_enabled(true);
  851. p_tab_container->set_tabs_rearrange_group(1);
  852. p_tab_container->connect("tab_changed", callable_mp(this, &EditorDockManager::_update_layout).unbind(1));
  853. p_tab_container->connect("active_tab_rearranged", callable_mp(this, &EditorDockManager::_update_layout).unbind(1));
  854. p_tab_container->connect("child_order_changed", callable_mp(this, &EditorDockManager::_dock_container_update_visibility).bind(p_tab_container));
  855. p_tab_container->hide();
  856. p_tab_container->set_meta("dock_slot", p_dock_slot);
  857. p_tab_container->set_meta("dock_layout", p_layout);
  858. if (p_layout == DockConstants::DOCK_LAYOUT_VERTICAL) {
  859. p_tab_container->set_custom_minimum_size(Size2(170, 0) * EDSCALE);
  860. p_tab_container->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  861. p_tab_container->set_use_hidden_tabs_for_min_size(true);
  862. }
  863. // Create dock dragging hint.
  864. slot.drag_hint = memnew(EditorDockDragHint);
  865. slot.drag_hint->hide();
  866. EditorNode::get_singleton()->get_gui_base()->add_child(slot.drag_hint);
  867. dock_slots[p_dock_slot] = slot;
  868. slot.drag_hint->set_slot(p_dock_slot);
  869. }
  870. int EditorDockManager::get_vsplit_count() const {
  871. return vsplits.size();
  872. }
  873. PopupMenu *EditorDockManager::get_docks_menu() {
  874. return docks_menu;
  875. }
  876. EditorDockManager::EditorDockManager() {
  877. singleton = this;
  878. closed_dock_parent = memnew(Control);
  879. closed_dock_parent->hide();
  880. EditorNode::get_singleton()->get_gui_base()->add_child(closed_dock_parent);
  881. dock_context_popup = memnew(DockContextPopup);
  882. EditorNode::get_singleton()->get_gui_base()->add_child(dock_context_popup);
  883. EditorNode::get_singleton()->add_child(memnew(DockShortcutHandler));
  884. docks_menu = memnew(PopupMenu);
  885. docks_menu->set_hide_on_item_selection(false);
  886. docks_menu->connect(SceneStringName(id_pressed), callable_mp(this, &EditorDockManager::_docks_menu_option));
  887. EditorNode::get_singleton()->get_gui_base()->connect(SceneStringName(theme_changed), callable_mp(this, &EditorDockManager::update_docks_menu));
  888. }
  889. ////////////////////////////////////////////////
  890. ////////////////////////////////////////////////
  891. void DockContextPopup::_notification(int p_what) {
  892. switch (p_what) {
  893. case Control::NOTIFICATION_LAYOUT_DIRECTION_CHANGED:
  894. case NOTIFICATION_TRANSLATION_CHANGED:
  895. case NOTIFICATION_THEME_CHANGED: {
  896. if (make_float_button) {
  897. make_float_button->set_button_icon(get_editor_theme_icon(SNAME("MakeFloating")));
  898. }
  899. if (is_layout_rtl()) {
  900. tab_move_left_button->set_button_icon(get_editor_theme_icon(SNAME("Forward")));
  901. tab_move_right_button->set_button_icon(get_editor_theme_icon(SNAME("Back")));
  902. tab_move_left_button->set_tooltip_text(TTR("Move this dock right one tab."));
  903. tab_move_right_button->set_tooltip_text(TTR("Move this dock left one tab."));
  904. } else {
  905. tab_move_left_button->set_button_icon(get_editor_theme_icon(SNAME("Back")));
  906. tab_move_right_button->set_button_icon(get_editor_theme_icon(SNAME("Forward")));
  907. tab_move_left_button->set_tooltip_text(TTR("Move this dock left one tab."));
  908. tab_move_right_button->set_tooltip_text(TTR("Move this dock right one tab."));
  909. }
  910. close_button->set_button_icon(get_editor_theme_icon(SNAME("Close")));
  911. } break;
  912. }
  913. }
  914. void DockContextPopup::_tab_move_left() {
  915. TabContainer *tab_container = dock_manager->get_dock_tab_container(context_dock);
  916. if (!tab_container) {
  917. return;
  918. }
  919. int new_index = tab_container->get_tab_idx_from_control(context_dock) - 1;
  920. dock_manager->_move_dock(context_dock, tab_container, new_index);
  921. dock_manager->_update_layout();
  922. dock_select->queue_redraw();
  923. }
  924. void DockContextPopup::_tab_move_right() {
  925. TabContainer *tab_container = dock_manager->get_dock_tab_container(context_dock);
  926. if (!tab_container) {
  927. return;
  928. }
  929. int new_index = tab_container->get_tab_idx_from_control(context_dock) + 1;
  930. dock_manager->_move_dock(context_dock, tab_container, new_index);
  931. dock_manager->_update_layout();
  932. dock_select->queue_redraw();
  933. }
  934. void DockContextPopup::_close_dock() {
  935. hide();
  936. context_dock->emit_signal("closed");
  937. dock_manager->close_dock(context_dock);
  938. }
  939. void DockContextPopup::_float_dock() {
  940. hide();
  941. dock_manager->_open_dock_in_window(context_dock);
  942. }
  943. bool DockContextPopup::_is_slot_available(int p_slot) const {
  944. return context_dock->available_layouts & (EditorDock::DockLayout)EditorDockManager::get_singleton()->dock_slots[p_slot].layout;
  945. }
  946. void DockContextPopup::_dock_select_input(const Ref<InputEvent> &p_input) {
  947. Ref<InputEventMouse> me = p_input;
  948. if (me.is_valid()) {
  949. Vector2 point = me->get_position();
  950. int over_dock_slot = -1;
  951. for (int i = 0; i < DockConstants::DOCK_SLOT_MAX; i++) {
  952. if (dock_select_rects[i].has_point(point)) {
  953. over_dock_slot = i;
  954. break;
  955. }
  956. }
  957. if (over_dock_slot != dock_select_rect_over_idx) {
  958. dock_select->queue_redraw();
  959. dock_select_rect_over_idx = over_dock_slot;
  960. }
  961. if (over_dock_slot == -1) {
  962. return;
  963. }
  964. Ref<InputEventMouseButton> mb = me;
  965. TabContainer *target_tab_container = dock_manager->dock_slots[over_dock_slot].container;
  966. if (mb.is_valid() && mb->get_button_index() == MouseButton::LEFT && mb->is_pressed()) {
  967. if (dock_manager->get_dock_tab_container(context_dock) != target_tab_container && _is_slot_available(over_dock_slot)) {
  968. dock_manager->_move_dock(context_dock, target_tab_container, target_tab_container->get_tab_count());
  969. dock_manager->_update_layout();
  970. hide();
  971. }
  972. }
  973. }
  974. }
  975. void DockContextPopup::_dock_select_mouse_exited() {
  976. dock_select_rect_over_idx = -1;
  977. dock_select->queue_redraw();
  978. }
  979. void DockContextPopup::_dock_select_draw() {
  980. Color used_dock_color = Color(0.6, 0.6, 0.6, 0.8);
  981. Color hovered_dock_color = Color(0.8, 0.8, 0.8, 0.8);
  982. Color tab_selected_color = dock_select->get_theme_color(SNAME("mono_color"), EditorStringName(Editor));
  983. Color tab_unselected_color = used_dock_color;
  984. Color unused_dock_color = used_dock_color;
  985. unused_dock_color.a = 0.4;
  986. Color unusable_dock_color = unused_dock_color;
  987. unusable_dock_color.a = 0.1;
  988. // Update sizes.
  989. Size2 dock_size = dock_select->get_size();
  990. dock_size.x /= 6.0;
  991. dock_size.y /= 2.0;
  992. real_t center_panel_width = dock_size.x * 2.0;
  993. Rect2 center_panel_rect(center_panel_width, 0, center_panel_width, dock_size.y);
  994. if (dock_select->is_layout_rtl()) {
  995. dock_select_rects[DockConstants::DOCK_SLOT_RIGHT_UR] = Rect2(Point2(), dock_size);
  996. dock_select_rects[DockConstants::DOCK_SLOT_RIGHT_BR] = Rect2(Point2(0, dock_size.y), dock_size);
  997. dock_select_rects[DockConstants::DOCK_SLOT_RIGHT_UL] = Rect2(Point2(dock_size.x, 0), dock_size);
  998. dock_select_rects[DockConstants::DOCK_SLOT_RIGHT_BL] = Rect2(dock_size, dock_size);
  999. dock_select_rects[DockConstants::DOCK_SLOT_LEFT_UR] = Rect2(Point2(dock_size.x * 4, 0), dock_size);
  1000. dock_select_rects[DockConstants::DOCK_SLOT_LEFT_BR] = Rect2(Point2(dock_size.x * 4, dock_size.y), dock_size);
  1001. dock_select_rects[DockConstants::DOCK_SLOT_LEFT_UL] = Rect2(Point2(dock_size.x * 5, 0), dock_size);
  1002. dock_select_rects[DockConstants::DOCK_SLOT_LEFT_BL] = Rect2(Point2(dock_size.x * 5, dock_size.y), dock_size);
  1003. } else {
  1004. dock_select_rects[DockConstants::DOCK_SLOT_LEFT_UL] = Rect2(Point2(), dock_size);
  1005. dock_select_rects[DockConstants::DOCK_SLOT_LEFT_BL] = Rect2(Point2(0, dock_size.y), dock_size);
  1006. dock_select_rects[DockConstants::DOCK_SLOT_LEFT_UR] = Rect2(Point2(dock_size.x, 0), dock_size);
  1007. dock_select_rects[DockConstants::DOCK_SLOT_LEFT_BR] = Rect2(dock_size, dock_size);
  1008. dock_select_rects[DockConstants::DOCK_SLOT_RIGHT_UL] = Rect2(Point2(dock_size.x * 4, 0), dock_size);
  1009. dock_select_rects[DockConstants::DOCK_SLOT_RIGHT_BL] = Rect2(Point2(dock_size.x * 4, dock_size.y), dock_size);
  1010. dock_select_rects[DockConstants::DOCK_SLOT_RIGHT_UR] = Rect2(Point2(dock_size.x * 5, 0), dock_size);
  1011. dock_select_rects[DockConstants::DOCK_SLOT_RIGHT_BR] = Rect2(Point2(dock_size.x * 5, dock_size.y), dock_size);
  1012. }
  1013. dock_select_rects[DockConstants::DOCK_SLOT_BOTTOM] = Rect2(center_panel_width, dock_size.y, center_panel_width, dock_size.y);
  1014. int rtl_dir = dock_select->is_layout_rtl() ? -1 : 1;
  1015. real_t tab_height = 3.0 * EDSCALE;
  1016. real_t tab_spacing = 1.0 * EDSCALE;
  1017. real_t dock_spacing = 2.0 * EDSCALE;
  1018. real_t dock_top_spacing = tab_height + dock_spacing;
  1019. TabContainer *context_tab_container = dock_manager->get_dock_tab_container(context_dock);
  1020. int context_tab_index = -1;
  1021. if (context_tab_container && context_tab_container->get_tab_count() > 0) {
  1022. context_tab_index = context_tab_container->get_tab_idx_from_control(context_dock);
  1023. }
  1024. // Draw center panel.
  1025. Rect2 center_panel_draw_rect = center_panel_rect.grow_individual(-dock_spacing, -dock_top_spacing, -dock_spacing, -dock_spacing);
  1026. dock_select->draw_rect(center_panel_draw_rect, unusable_dock_color);
  1027. // Draw all dock slots.
  1028. for (int i = 0; i < DockConstants::DOCK_SLOT_MAX; i++) {
  1029. int max_tabs = (i == DockConstants::DOCK_SLOT_BOTTOM) ? 6 : 3;
  1030. const EditorDockManager::DockSlot &dock_slot = dock_manager->dock_slots[i];
  1031. Rect2 dock_slot_draw_rect = dock_select_rects[i].grow_individual(-dock_spacing, -dock_top_spacing, -dock_spacing, -dock_spacing);
  1032. real_t tab_width = Math::round(dock_slot_draw_rect.size.width / max_tabs);
  1033. Rect2 tab_draw_rect = Rect2(dock_slot_draw_rect.position.x, dock_select_rects[i].position.y, tab_width - tab_spacing, tab_height);
  1034. real_t max_width = tab_width * max_tabs;
  1035. // Tabs may not fit perfectly, so they need to be re-centered.
  1036. if (max_width > dock_slot_draw_rect.size.x) {
  1037. tab_draw_rect.position.x -= int(max_width - dock_slot_draw_rect.size.x) / 2 * rtl_dir;
  1038. }
  1039. if (dock_select->is_layout_rtl()) {
  1040. tab_draw_rect.position.x += dock_slot_draw_rect.size.x - tab_draw_rect.size.x;
  1041. }
  1042. int tabs_to_draw = MIN(max_tabs, dock_slot.container->get_tab_count());
  1043. bool is_context_dock = context_tab_container == dock_slot.container;
  1044. if (i == context_dock->dock_slot_index) {
  1045. dock_select->draw_rect(dock_slot_draw_rect, tab_selected_color);
  1046. } else if (!_is_slot_available(i)) {
  1047. dock_select->draw_rect(dock_slot_draw_rect, unusable_dock_color);
  1048. } else if (i == dock_select_rect_over_idx) {
  1049. dock_select->draw_rect(dock_slot_draw_rect, hovered_dock_color);
  1050. } else if (tabs_to_draw == 0) {
  1051. dock_select->draw_rect(dock_slot_draw_rect, unused_dock_color);
  1052. } else {
  1053. dock_select->draw_rect(dock_slot_draw_rect, used_dock_color);
  1054. }
  1055. // Draw tabs above each used dock slot.
  1056. for (int j = 0; j < tabs_to_draw; j++) {
  1057. Color tab_color = tab_unselected_color;
  1058. if (is_context_dock && context_tab_index == j) {
  1059. tab_color = tab_selected_color;
  1060. }
  1061. Rect2 tabj_draw_rect = tab_draw_rect;
  1062. tabj_draw_rect.position.x += tab_width * j * rtl_dir;
  1063. dock_select->draw_rect(tabj_draw_rect, tab_color);
  1064. }
  1065. }
  1066. }
  1067. void DockContextPopup::_update_buttons() {
  1068. TabContainer *context_tab_container = dock_manager->get_dock_tab_container(context_dock);
  1069. if (context_dock->global || context_dock->closable) {
  1070. close_button->set_tooltip_text(TTRC("Close this dock."));
  1071. close_button->set_disabled(false);
  1072. } else {
  1073. close_button->set_tooltip_text(TTRC("This dock can't be closed."));
  1074. close_button->set_disabled(true);
  1075. }
  1076. if (EditorNode::get_singleton()->is_multi_window_enabled()) {
  1077. if (!(context_dock->available_layouts & EditorDock::DOCK_LAYOUT_FLOATING)) {
  1078. make_float_button->set_tooltip_text(TTRC("This dock does not support floating."));
  1079. make_float_button->set_disabled(true);
  1080. } else {
  1081. make_float_button->set_tooltip_text(TTRC("Make this dock floating."));
  1082. make_float_button->set_disabled(false);
  1083. }
  1084. }
  1085. // Update tab move buttons.
  1086. tab_move_left_button->set_disabled(true);
  1087. tab_move_right_button->set_disabled(true);
  1088. if (context_tab_container && context_tab_container->get_tab_count() > 0) {
  1089. int context_tab_index = context_tab_container->get_tab_idx_from_control(context_dock);
  1090. tab_move_left_button->set_disabled(context_tab_index == 0);
  1091. tab_move_right_button->set_disabled(context_tab_index >= context_tab_container->get_tab_count() - 1);
  1092. }
  1093. reset_size();
  1094. }
  1095. void DockContextPopup::select_current_dock_in_dock_slot(int p_dock_slot) {
  1096. context_dock = Object::cast_to<EditorDock>(dock_manager->dock_slots[p_dock_slot].container->get_current_tab_control());
  1097. _update_buttons();
  1098. }
  1099. void DockContextPopup::set_dock(EditorDock *p_dock) {
  1100. context_dock = p_dock;
  1101. _update_buttons();
  1102. }
  1103. EditorDock *DockContextPopup::get_dock() const {
  1104. return context_dock;
  1105. }
  1106. void DockContextPopup::docks_updated() {
  1107. if (!is_visible()) {
  1108. return;
  1109. }
  1110. _update_buttons();
  1111. }
  1112. DockContextPopup::DockContextPopup() {
  1113. dock_manager = EditorDockManager::get_singleton();
  1114. dock_select_popup_vb = memnew(VBoxContainer);
  1115. add_child(dock_select_popup_vb);
  1116. HBoxContainer *header_hb = memnew(HBoxContainer);
  1117. tab_move_left_button = memnew(Button);
  1118. tab_move_left_button->set_accessibility_name(TTRC("Move Tab Left"));
  1119. tab_move_left_button->set_flat(true);
  1120. tab_move_left_button->set_focus_mode(Control::FOCUS_ACCESSIBILITY);
  1121. tab_move_left_button->connect(SceneStringName(pressed), callable_mp(this, &DockContextPopup::_tab_move_left));
  1122. header_hb->add_child(tab_move_left_button);
  1123. Label *position_label = memnew(Label);
  1124. position_label->set_text(TTRC("Dock Position"));
  1125. position_label->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  1126. position_label->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER);
  1127. header_hb->add_child(position_label);
  1128. tab_move_right_button = memnew(Button);
  1129. tab_move_right_button->set_accessibility_name(TTRC("Move Tab Right"));
  1130. tab_move_right_button->set_flat(true);
  1131. tab_move_right_button->set_focus_mode(Control::FOCUS_ACCESSIBILITY);
  1132. tab_move_right_button->connect(SceneStringName(pressed), callable_mp(this, &DockContextPopup::_tab_move_right));
  1133. header_hb->add_child(tab_move_right_button);
  1134. dock_select_popup_vb->add_child(header_hb);
  1135. dock_select = memnew(Control);
  1136. dock_select->set_custom_minimum_size(Size2(128, 64) * EDSCALE);
  1137. dock_select->connect(SceneStringName(gui_input), callable_mp(this, &DockContextPopup::_dock_select_input));
  1138. dock_select->connect(SceneStringName(draw), callable_mp(this, &DockContextPopup::_dock_select_draw));
  1139. dock_select->connect(SceneStringName(mouse_exited), callable_mp(this, &DockContextPopup::_dock_select_mouse_exited));
  1140. dock_select->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  1141. dock_select_popup_vb->add_child(dock_select);
  1142. make_float_button = memnew(Button);
  1143. make_float_button->set_text(TTRC("Make Floating"));
  1144. if (!EditorNode::get_singleton()->is_multi_window_enabled()) {
  1145. make_float_button->set_disabled(true);
  1146. make_float_button->set_tooltip_text(EditorNode::get_singleton()->get_multiwindow_support_tooltip_text());
  1147. }
  1148. make_float_button->set_focus_mode(Control::FOCUS_ACCESSIBILITY);
  1149. make_float_button->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  1150. make_float_button->connect(SceneStringName(pressed), callable_mp(this, &DockContextPopup::_float_dock));
  1151. dock_select_popup_vb->add_child(make_float_button);
  1152. close_button = memnew(Button);
  1153. close_button->set_text(TTRC("Close"));
  1154. close_button->set_focus_mode(Control::FOCUS_ACCESSIBILITY);
  1155. close_button->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  1156. close_button->connect(SceneStringName(pressed), callable_mp(this, &DockContextPopup::_close_dock));
  1157. dock_select_popup_vb->add_child(close_button);
  1158. }
  1159. void DockShortcutHandler::shortcut_input(const Ref<InputEvent> &p_event) {
  1160. if (p_event.is_null() || !p_event->is_pressed() || p_event->is_echo()) {
  1161. return;
  1162. }
  1163. for (EditorDock *dock : EditorDockManager::get_singleton()->all_docks) {
  1164. const Ref<Shortcut> &dock_shortcut = dock->get_dock_shortcut();
  1165. if (dock_shortcut.is_valid() && dock_shortcut->matches_event(p_event)) {
  1166. if (dock->is_visible() && dock->get_parent() == EditorNode::get_bottom_panel()) {
  1167. EditorNode::get_bottom_panel()->hide_bottom_panel();
  1168. } else if (!dock->transient || dock->is_open) {
  1169. EditorDockManager::get_singleton()->focus_dock(dock);
  1170. }
  1171. get_viewport()->set_input_as_handled();
  1172. break;
  1173. }
  1174. }
  1175. }