scene_tree_editor.cpp 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552
  1. /**************************************************************************/
  2. /* scene_tree_editor.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 "scene_tree_editor.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/object/message_queue.h"
  33. #include "editor/editor_file_system.h"
  34. #include "editor/editor_node.h"
  35. #include "editor/editor_scale.h"
  36. #include "editor/editor_settings.h"
  37. #include "editor/editor_undo_redo_manager.h"
  38. #include "editor/node_dock.h"
  39. #include "editor/plugins/animation_player_editor_plugin.h"
  40. #include "editor/plugins/canvas_item_editor_plugin.h"
  41. #include "editor/plugins/script_editor_plugin.h"
  42. #include "scene/gui/label.h"
  43. #include "scene/gui/tab_container.h"
  44. #include "scene/gui/texture_rect.h"
  45. #include "scene/main/window.h"
  46. #include "scene/resources/packed_scene.h"
  47. Node *SceneTreeEditor::get_scene_node() {
  48. ERR_FAIL_COND_V(!is_inside_tree(), nullptr);
  49. return get_tree()->get_edited_scene_root();
  50. }
  51. void SceneTreeEditor::_cell_button_pressed(Object *p_item, int p_column, int p_id, MouseButton p_button) {
  52. if (p_button != MouseButton::LEFT) {
  53. return;
  54. }
  55. if (connect_to_script_mode) {
  56. return; //don't do anything in this mode
  57. }
  58. TreeItem *item = Object::cast_to<TreeItem>(p_item);
  59. ERR_FAIL_COND(!item);
  60. NodePath np = item->get_metadata(0);
  61. Node *n = get_node(np);
  62. ERR_FAIL_COND(!n);
  63. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  64. if (p_id == BUTTON_SUBSCENE) {
  65. if (n == get_scene_node()) {
  66. if (n && n->get_scene_inherited_state().is_valid()) {
  67. emit_signal(SNAME("open"), n->get_scene_inherited_state()->get_path());
  68. }
  69. } else {
  70. emit_signal(SNAME("open"), n->get_scene_file_path());
  71. }
  72. } else if (p_id == BUTTON_SCRIPT) {
  73. Ref<Script> script_typed = n->get_script();
  74. if (!script_typed.is_null()) {
  75. emit_signal(SNAME("open_script"), script_typed);
  76. }
  77. } else if (p_id == BUTTON_VISIBILITY) {
  78. undo_redo->create_action(TTR("Toggle Visible"));
  79. _toggle_visible(n);
  80. List<Node *> selection = editor_selection->get_selected_node_list();
  81. if (selection.size() > 1 && selection.find(n) != nullptr) {
  82. for (Node *nv : selection) {
  83. ERR_FAIL_COND(!nv);
  84. if (nv == n) {
  85. continue;
  86. }
  87. _toggle_visible(nv);
  88. }
  89. }
  90. undo_redo->commit_action();
  91. } else if (p_id == BUTTON_LOCK) {
  92. undo_redo->create_action(TTR("Unlock Node"));
  93. if (n->is_class("CanvasItem") || n->is_class("Node3D")) {
  94. undo_redo->add_do_method(n, "remove_meta", "_edit_lock_");
  95. undo_redo->add_undo_method(n, "set_meta", "_edit_lock_", true);
  96. undo_redo->add_do_method(this, "_update_tree");
  97. undo_redo->add_undo_method(this, "_update_tree");
  98. undo_redo->add_do_method(this, "emit_signal", "node_changed");
  99. undo_redo->add_undo_method(this, "emit_signal", "node_changed");
  100. }
  101. undo_redo->commit_action();
  102. } else if (p_id == BUTTON_PIN) {
  103. if (n->is_class("AnimationPlayer")) {
  104. AnimationPlayerEditor::get_singleton()->unpin();
  105. _update_tree();
  106. }
  107. } else if (p_id == BUTTON_GROUP) {
  108. undo_redo->create_action(TTR("Button Group"));
  109. if (n->is_class("CanvasItem") || n->is_class("Node3D")) {
  110. undo_redo->add_do_method(n, "remove_meta", "_edit_group_");
  111. undo_redo->add_undo_method(n, "set_meta", "_edit_group_", true);
  112. undo_redo->add_do_method(this, "_update_tree");
  113. undo_redo->add_undo_method(this, "_update_tree");
  114. undo_redo->add_do_method(this, "emit_signal", "node_changed");
  115. undo_redo->add_undo_method(this, "emit_signal", "node_changed");
  116. }
  117. undo_redo->commit_action();
  118. } else if (p_id == BUTTON_WARNING) {
  119. String config_err = n->get_configuration_warnings_as_string();
  120. if (config_err.is_empty()) {
  121. return;
  122. }
  123. const PackedInt32Array boundaries = TS->string_get_word_breaks(config_err, "", 80);
  124. PackedStringArray lines;
  125. for (int i = 0; i < boundaries.size(); i += 2) {
  126. const int start = boundaries[i];
  127. const int end = boundaries[i + 1];
  128. lines.append(config_err.substr(start, end - start + 1));
  129. }
  130. warning->set_text(String("\n").join(lines));
  131. warning->popup_centered();
  132. } else if (p_id == BUTTON_SIGNALS) {
  133. editor_selection->clear();
  134. editor_selection->add_node(n);
  135. set_selected(n);
  136. TabContainer *tab_container = Object::cast_to<TabContainer>(NodeDock::get_singleton()->get_parent());
  137. NodeDock::get_singleton()->get_parent()->call("set_current_tab", tab_container->get_tab_idx_from_control(NodeDock::get_singleton()));
  138. NodeDock::get_singleton()->show_connections();
  139. } else if (p_id == BUTTON_GROUPS) {
  140. editor_selection->clear();
  141. editor_selection->add_node(n);
  142. set_selected(n);
  143. TabContainer *tab_container = Object::cast_to<TabContainer>(NodeDock::get_singleton()->get_parent());
  144. NodeDock::get_singleton()->get_parent()->call("set_current_tab", tab_container->get_tab_idx_from_control(NodeDock::get_singleton()));
  145. NodeDock::get_singleton()->show_groups();
  146. } else if (p_id == BUTTON_UNIQUE) {
  147. undo_redo->create_action(TTR("Disable Scene Unique Name"));
  148. undo_redo->add_do_method(n, "set_unique_name_in_owner", false);
  149. undo_redo->add_undo_method(n, "set_unique_name_in_owner", true);
  150. undo_redo->add_do_method(this, "_update_tree");
  151. undo_redo->add_undo_method(this, "_update_tree");
  152. undo_redo->commit_action();
  153. }
  154. }
  155. void SceneTreeEditor::_toggle_visible(Node *p_node) {
  156. if (p_node->has_method("is_visible") && p_node->has_method("set_visible")) {
  157. bool v = bool(p_node->call("is_visible"));
  158. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  159. undo_redo->add_do_method(p_node, "set_visible", !v);
  160. undo_redo->add_undo_method(p_node, "set_visible", v);
  161. }
  162. }
  163. void SceneTreeEditor::_add_nodes(Node *p_node, TreeItem *p_parent) {
  164. if (!p_node) {
  165. return;
  166. }
  167. // only owned nodes are editable, since nodes can create their own (manually owned) child nodes,
  168. // which the editor needs not to know about.
  169. bool part_of_subscene = false;
  170. if (!display_foreign && p_node->get_owner() != get_scene_node() && p_node != get_scene_node()) {
  171. if ((show_enabled_subscene || can_open_instance) && p_node->get_owner() && (get_scene_node()->is_editable_instance(p_node->get_owner()))) {
  172. part_of_subscene = true;
  173. //allow
  174. } else {
  175. return;
  176. }
  177. } else {
  178. part_of_subscene = p_node != get_scene_node() && get_scene_node()->get_scene_inherited_state().is_valid() && get_scene_node()->get_scene_inherited_state()->find_node_by_path(get_scene_node()->get_path_to(p_node)) >= 0;
  179. }
  180. TreeItem *item = tree->create_item(p_parent);
  181. item->set_text(0, p_node->get_name());
  182. if (can_rename && !part_of_subscene) {
  183. item->set_editable(0, true);
  184. }
  185. item->set_selectable(0, true);
  186. if (can_rename) {
  187. bool collapsed = p_node->is_displayed_folded();
  188. if (collapsed) {
  189. item->set_collapsed(true);
  190. }
  191. }
  192. Ref<Texture2D> icon = EditorNode::get_singleton()->get_object_icon(p_node, "Node");
  193. item->set_icon(0, icon);
  194. item->set_metadata(0, p_node->get_path());
  195. if (connect_to_script_mode) {
  196. Color accent = get_theme_color(SNAME("accent_color"), SNAME("Editor"));
  197. Ref<Script> scr = p_node->get_script();
  198. if (!scr.is_null() && EditorNode::get_singleton()->get_object_custom_type_base(p_node) != scr) {
  199. //has script
  200. item->add_button(0, get_theme_icon(SNAME("Script"), SNAME("EditorIcons")), BUTTON_SCRIPT);
  201. } else {
  202. //has no script (or script is a custom type)
  203. item->set_custom_color(0, get_theme_color(SNAME("disabled_font_color"), SNAME("Editor")));
  204. item->set_selectable(0, false);
  205. if (!scr.is_null()) { // make sure to mark the script if a custom type
  206. item->add_button(0, get_theme_icon(SNAME("Script"), SNAME("EditorIcons")), BUTTON_SCRIPT);
  207. item->set_button_disabled(0, item->get_button_count(0) - 1, true);
  208. }
  209. accent.a *= 0.7;
  210. }
  211. if (marked.has(p_node)) {
  212. String node_name = p_node->get_name();
  213. if (connecting_signal) {
  214. node_name += " " + TTR("(Connecting From)");
  215. }
  216. item->set_text(0, node_name);
  217. item->set_custom_color(0, accent);
  218. }
  219. } else if (part_of_subscene) {
  220. if (valid_types.size() == 0) {
  221. item->set_custom_color(0, get_theme_color(SNAME("warning_color"), SNAME("Editor")));
  222. }
  223. } else if (marked.has(p_node)) {
  224. String node_name = p_node->get_name();
  225. if (connecting_signal) {
  226. node_name += " " + TTR("(Connecting From)");
  227. }
  228. item->set_text(0, node_name);
  229. item->set_selectable(0, marked_selectable);
  230. item->set_custom_color(0, get_theme_color(SNAME("accent_color"), SNAME("Editor")));
  231. } else if (!p_node->can_process()) {
  232. item->set_custom_color(0, get_theme_color(SNAME("disabled_font_color"), SNAME("Editor")));
  233. } else if (!marked_selectable && !marked_children_selectable) {
  234. Node *node = p_node;
  235. while (node) {
  236. if (marked.has(node)) {
  237. item->set_selectable(0, false);
  238. item->set_custom_color(0, get_theme_color(SNAME("error_color"), SNAME("Editor")));
  239. break;
  240. }
  241. node = node->get_parent();
  242. }
  243. }
  244. if (can_rename) { //should be can edit..
  245. String conf_warning = p_node->get_configuration_warnings_as_string();
  246. if (!conf_warning.is_empty()) {
  247. const int num_warnings = p_node->get_configuration_warnings().size();
  248. String warning_icon;
  249. if (num_warnings == 1) {
  250. warning_icon = SNAME("NodeWarning");
  251. } else if (num_warnings <= 3) {
  252. warning_icon = vformat("NodeWarnings%d", num_warnings);
  253. } else {
  254. warning_icon = SNAME("NodeWarnings4Plus");
  255. }
  256. // Improve looks on tooltip, extra spacing on non-bullet point newlines.
  257. const String bullet_point = String::utf8("• ");
  258. int next_newline = 0;
  259. while (next_newline != -1) {
  260. next_newline = conf_warning.find("\n", next_newline + 2);
  261. if (conf_warning.substr(next_newline + 1, bullet_point.length()) != bullet_point) {
  262. conf_warning = conf_warning.insert(next_newline + 1, " ");
  263. }
  264. }
  265. String newline = (num_warnings == 1 ? "\n" : "\n\n");
  266. item->add_button(0, get_theme_icon(warning_icon, SNAME("EditorIcons")), BUTTON_WARNING, false, TTR("Node configuration warning:") + newline + conf_warning);
  267. }
  268. if (p_node->is_unique_name_in_owner()) {
  269. item->add_button(0, get_theme_icon(SNAME("SceneUniqueName"), SNAME("EditorIcons")), BUTTON_UNIQUE, false, vformat(TTR("This node can be accessed from within anywhere in the scene by preceding it with the '%s' prefix in a node path.\nClick to disable this."), UNIQUE_NODE_PREFIX));
  270. }
  271. int num_connections = p_node->get_persistent_signal_connection_count();
  272. int num_groups = p_node->get_persistent_group_count();
  273. String msg_temp;
  274. if (num_connections >= 1) {
  275. Array arr;
  276. arr.push_back(num_connections);
  277. msg_temp += TTRN("Node has one connection.", "Node has {num} connections.", num_connections).format(arr, "{num}");
  278. if (num_groups >= 1) {
  279. msg_temp += "\n";
  280. }
  281. }
  282. if (num_groups >= 1) {
  283. msg_temp += TTRN("Node is in this group:", "Node is in the following groups:", num_groups) + "\n";
  284. List<GroupInfo> groups;
  285. p_node->get_groups(&groups);
  286. for (const GroupInfo &E : groups) {
  287. if (E.persistent) {
  288. msg_temp += String::utf8("• ") + String(E.name) + "\n";
  289. }
  290. }
  291. }
  292. if (num_connections >= 1 || num_groups >= 1) {
  293. if (num_groups < 1) {
  294. msg_temp += "\n";
  295. }
  296. msg_temp += TTR("Click to show signals dock.");
  297. }
  298. Ref<Texture2D> icon_temp;
  299. SceneTreeEditorButton signal_temp = BUTTON_SIGNALS;
  300. if (num_connections >= 1 && num_groups >= 1) {
  301. icon_temp = get_theme_icon(SNAME("SignalsAndGroups"), SNAME("EditorIcons"));
  302. } else if (num_connections >= 1) {
  303. icon_temp = get_theme_icon(SNAME("Signals"), SNAME("EditorIcons"));
  304. } else if (num_groups >= 1) {
  305. icon_temp = get_theme_icon(SNAME("Groups"), SNAME("EditorIcons"));
  306. signal_temp = BUTTON_GROUPS;
  307. }
  308. if (num_connections >= 1 || num_groups >= 1) {
  309. item->add_button(0, icon_temp, signal_temp, false, msg_temp);
  310. }
  311. }
  312. {
  313. // Display the node name in all tooltips so that long node names can be previewed
  314. // without having to rename them.
  315. String tooltip = String(p_node->get_name());
  316. if (p_node == get_scene_node() && p_node->get_scene_inherited_state().is_valid()) {
  317. item->add_button(0, get_theme_icon(SNAME("InstanceOptions"), SNAME("EditorIcons")), BUTTON_SUBSCENE, false, TTR("Open in Editor"));
  318. tooltip += String("\n" + TTR("Inherits:") + " " + p_node->get_scene_inherited_state()->get_path());
  319. } else if (p_node != get_scene_node() && !p_node->get_scene_file_path().is_empty() && can_open_instance) {
  320. item->add_button(0, get_theme_icon(SNAME("InstanceOptions"), SNAME("EditorIcons")), BUTTON_SUBSCENE, false, TTR("Open in Editor"));
  321. tooltip += String("\n" + TTR("Instance:") + " " + p_node->get_scene_file_path());
  322. }
  323. StringName custom_type = EditorNode::get_singleton()->get_object_custom_type_name(p_node);
  324. tooltip += String("\n" + TTR("Type:") + " " + (custom_type != StringName() ? String(custom_type) : p_node->get_class()));
  325. if (!p_node->get_editor_description().is_empty()) {
  326. tooltip += "\n\n" + p_node->get_editor_description();
  327. }
  328. item->set_tooltip_text(0, tooltip);
  329. }
  330. if (can_open_instance && is_scene_tree_dock) { // Show buttons only when necessary (SceneTreeDock) to avoid crashes.
  331. if (!p_node->is_connected("script_changed", callable_mp(this, &SceneTreeEditor::_node_script_changed))) {
  332. p_node->connect("script_changed", callable_mp(this, &SceneTreeEditor::_node_script_changed).bind(p_node));
  333. }
  334. Ref<Script> scr = p_node->get_script();
  335. if (!scr.is_null()) {
  336. String additional_notes;
  337. Color button_color = Color(1, 1, 1);
  338. // Can't set tooltip after adding button, need to do it before.
  339. if (scr->is_tool()) {
  340. additional_notes += "\n" + TTR("This script is currently running in the editor.");
  341. button_color = get_theme_color(SNAME("accent_color"), SNAME("Editor"));
  342. }
  343. if (EditorNode::get_singleton()->get_object_custom_type_base(p_node) == scr) {
  344. additional_notes += "\n" + TTR("This script is a custom type.");
  345. button_color.a = 0.5;
  346. }
  347. item->add_button(0, get_theme_icon(SNAME("Script"), SNAME("EditorIcons")), BUTTON_SCRIPT, false, TTR("Open Script:") + " " + scr->get_path() + additional_notes);
  348. item->set_button_color(0, item->get_button_count(0) - 1, button_color);
  349. }
  350. if (p_node->is_class("CanvasItem")) {
  351. if (p_node->has_meta("_edit_lock_")) {
  352. item->add_button(0, get_theme_icon(SNAME("Lock"), SNAME("EditorIcons")), BUTTON_LOCK, false, TTR("Node is locked.\nClick to unlock it."));
  353. }
  354. if (p_node->has_meta("_edit_group_")) {
  355. item->add_button(0, get_theme_icon(SNAME("Group"), SNAME("EditorIcons")), BUTTON_GROUP, false, TTR("Children are not selectable.\nClick to make them selectable."));
  356. }
  357. bool v = p_node->call("is_visible");
  358. if (v) {
  359. item->add_button(0, get_theme_icon(SNAME("GuiVisibilityVisible"), SNAME("EditorIcons")), BUTTON_VISIBILITY, false, TTR("Toggle Visibility"));
  360. } else {
  361. item->add_button(0, get_theme_icon(SNAME("GuiVisibilityHidden"), SNAME("EditorIcons")), BUTTON_VISIBILITY, false, TTR("Toggle Visibility"));
  362. }
  363. if (!p_node->is_connected("visibility_changed", callable_mp(this, &SceneTreeEditor::_node_visibility_changed))) {
  364. p_node->connect("visibility_changed", callable_mp(this, &SceneTreeEditor::_node_visibility_changed).bind(p_node));
  365. }
  366. _update_visibility_color(p_node, item);
  367. } else if (p_node->is_class("CanvasLayer") || p_node->is_class("Window")) {
  368. bool v = p_node->call("is_visible");
  369. if (v) {
  370. item->add_button(0, get_theme_icon(SNAME("GuiVisibilityVisible"), SNAME("EditorIcons")), BUTTON_VISIBILITY, false, TTR("Toggle Visibility"));
  371. } else {
  372. item->add_button(0, get_theme_icon(SNAME("GuiVisibilityHidden"), SNAME("EditorIcons")), BUTTON_VISIBILITY, false, TTR("Toggle Visibility"));
  373. }
  374. if (!p_node->is_connected("visibility_changed", callable_mp(this, &SceneTreeEditor::_node_visibility_changed))) {
  375. p_node->connect("visibility_changed", callable_mp(this, &SceneTreeEditor::_node_visibility_changed).bind(p_node));
  376. }
  377. } else if (p_node->is_class("Node3D")) {
  378. if (p_node->has_meta("_edit_lock_")) {
  379. item->add_button(0, get_theme_icon(SNAME("Lock"), SNAME("EditorIcons")), BUTTON_LOCK, false, TTR("Node is locked.\nClick to unlock it."));
  380. }
  381. if (p_node->has_meta("_edit_group_")) {
  382. item->add_button(0, get_theme_icon(SNAME("Group"), SNAME("EditorIcons")), BUTTON_GROUP, false, TTR("Children are not selectable.\nClick to make them selectable."));
  383. }
  384. bool v = p_node->call("is_visible");
  385. if (v) {
  386. item->add_button(0, get_theme_icon(SNAME("GuiVisibilityVisible"), SNAME("EditorIcons")), BUTTON_VISIBILITY, false, TTR("Toggle Visibility"));
  387. } else {
  388. item->add_button(0, get_theme_icon(SNAME("GuiVisibilityHidden"), SNAME("EditorIcons")), BUTTON_VISIBILITY, false, TTR("Toggle Visibility"));
  389. }
  390. if (!p_node->is_connected("visibility_changed", callable_mp(this, &SceneTreeEditor::_node_visibility_changed))) {
  391. p_node->connect("visibility_changed", callable_mp(this, &SceneTreeEditor::_node_visibility_changed).bind(p_node));
  392. }
  393. _update_visibility_color(p_node, item);
  394. } else if (p_node->is_class("AnimationPlayer")) {
  395. bool is_pinned = AnimationPlayerEditor::get_singleton()->get_player() == p_node && AnimationPlayerEditor::get_singleton()->is_pinned();
  396. if (is_pinned) {
  397. item->add_button(0, get_theme_icon(SNAME("Pin"), SNAME("EditorIcons")), BUTTON_PIN, false, TTR("AnimationPlayer is pinned.\nClick to unpin."));
  398. }
  399. }
  400. }
  401. if (editor_selection) {
  402. if (editor_selection->is_selected(p_node)) {
  403. item->select(0);
  404. }
  405. }
  406. if (selected == p_node) {
  407. if (!editor_selection) {
  408. item->select(0);
  409. }
  410. item->set_as_cursor(0);
  411. }
  412. for (int i = 0; i < p_node->get_child_count(); i++) {
  413. _add_nodes(p_node->get_child(i), item);
  414. }
  415. if (valid_types.size()) {
  416. bool valid = false;
  417. for (const StringName &E : valid_types) {
  418. if (p_node->is_class(E) ||
  419. EditorNode::get_singleton()->is_object_of_custom_type(p_node, E)) {
  420. valid = true;
  421. break;
  422. }
  423. }
  424. if (!valid) {
  425. item->set_custom_color(0, get_theme_color(SNAME("disabled_font_color"), SNAME("Editor")));
  426. item->set_selectable(0, false);
  427. }
  428. }
  429. }
  430. void SceneTreeEditor::_node_visibility_changed(Node *p_node) {
  431. if (!p_node || (p_node != get_scene_node() && !p_node->get_owner())) {
  432. return;
  433. }
  434. TreeItem *item = _find(tree->get_root(), p_node->get_path());
  435. if (!item) {
  436. return;
  437. }
  438. int idx = item->get_button_by_id(0, BUTTON_VISIBILITY);
  439. ERR_FAIL_COND(idx == -1);
  440. bool node_visible = false;
  441. if (p_node->is_class("CanvasItem") || p_node->is_class("CanvasLayer") || p_node->is_class("Window")) {
  442. node_visible = p_node->call("is_visible");
  443. CanvasItemEditor::get_singleton()->get_viewport_control()->queue_redraw();
  444. } else if (p_node->is_class("Node3D")) {
  445. node_visible = p_node->call("is_visible");
  446. }
  447. if (node_visible) {
  448. item->set_button(0, idx, get_theme_icon(SNAME("GuiVisibilityVisible"), SNAME("EditorIcons")));
  449. } else {
  450. item->set_button(0, idx, get_theme_icon(SNAME("GuiVisibilityHidden"), SNAME("EditorIcons")));
  451. }
  452. _update_visibility_color(p_node, item);
  453. }
  454. void SceneTreeEditor::_update_visibility_color(Node *p_node, TreeItem *p_item) {
  455. if (p_node->is_class("CanvasItem") || p_node->is_class("Node3D")) {
  456. Color color(1, 1, 1, 1);
  457. bool visible_on_screen = p_node->call("is_visible_in_tree");
  458. if (!visible_on_screen) {
  459. color.a = 0.6;
  460. }
  461. int idx = p_item->get_button_by_id(0, BUTTON_VISIBILITY);
  462. p_item->set_button_color(0, idx, color);
  463. }
  464. }
  465. void SceneTreeEditor::_node_script_changed(Node *p_node) {
  466. if (tree_dirty) {
  467. return;
  468. }
  469. MessageQueue::get_singleton()->push_call(this, "_update_tree");
  470. tree_dirty = true;
  471. }
  472. void SceneTreeEditor::_node_removed(Node *p_node) {
  473. if (EditorNode::get_singleton()->is_exiting()) {
  474. return; //speed up exit
  475. }
  476. if (p_node->is_connected("script_changed", callable_mp(this, &SceneTreeEditor::_node_script_changed))) {
  477. p_node->disconnect("script_changed", callable_mp(this, &SceneTreeEditor::_node_script_changed));
  478. }
  479. if (p_node->is_class("Node3D") || p_node->is_class("CanvasItem") || p_node->is_class("CanvasLayer") || p_node->is_class("Window")) {
  480. if (p_node->is_connected("visibility_changed", callable_mp(this, &SceneTreeEditor::_node_visibility_changed))) {
  481. p_node->disconnect("visibility_changed", callable_mp(this, &SceneTreeEditor::_node_visibility_changed));
  482. }
  483. }
  484. if (p_node == selected) {
  485. selected = nullptr;
  486. emit_signal(SNAME("node_selected"));
  487. }
  488. }
  489. void SceneTreeEditor::_node_renamed(Node *p_node) {
  490. if (p_node != get_scene_node() && !get_scene_node()->is_ancestor_of(p_node)) {
  491. return;
  492. }
  493. emit_signal(SNAME("node_renamed"));
  494. if (!tree_dirty) {
  495. MessageQueue::get_singleton()->push_call(this, "_update_tree");
  496. tree_dirty = true;
  497. }
  498. }
  499. void SceneTreeEditor::_update_tree(bool p_scroll_to_selected) {
  500. if (!is_inside_tree()) {
  501. tree_dirty = false;
  502. return;
  503. }
  504. if (tree->is_editing()) {
  505. return;
  506. }
  507. updating_tree = true;
  508. tree->clear();
  509. if (get_scene_node()) {
  510. _add_nodes(get_scene_node(), nullptr);
  511. last_hash = hash_djb2_one_64(0);
  512. _compute_hash(get_scene_node(), last_hash);
  513. }
  514. updating_tree = false;
  515. tree_dirty = false;
  516. if (!filter.strip_edges().is_empty()) {
  517. _update_filter(nullptr, p_scroll_to_selected);
  518. }
  519. }
  520. bool SceneTreeEditor::_update_filter(TreeItem *p_parent, bool p_scroll_to_selected) {
  521. if (!p_parent) {
  522. p_parent = tree->get_root();
  523. filter_term_warning.clear();
  524. }
  525. if (!p_parent) {
  526. // Tree is empty, nothing to do here.
  527. return false;
  528. }
  529. bool keep_for_children = false;
  530. for (TreeItem *child = p_parent->get_first_child(); child; child = child->get_next()) {
  531. // Always keep if at least one of the children are kept.
  532. keep_for_children = _update_filter(child, p_scroll_to_selected) || keep_for_children;
  533. }
  534. // Now find other reasons to keep this Node, too.
  535. PackedStringArray terms = filter.to_lower().split_spaces();
  536. bool keep = _item_matches_all_terms(p_parent, terms);
  537. p_parent->set_visible(keep_for_children || keep);
  538. if (keep && !valid_types.is_empty()) {
  539. keep = false;
  540. Node *n = get_node(p_parent->get_metadata(0));
  541. for (const StringName &E : valid_types) {
  542. if (n->is_class(E) ||
  543. EditorNode::get_singleton()->is_object_of_custom_type(n, E)) {
  544. keep = true;
  545. break;
  546. }
  547. }
  548. }
  549. if (keep) {
  550. p_parent->clear_custom_color(0);
  551. p_parent->set_selectable(0, true);
  552. } else if (keep_for_children) {
  553. p_parent->set_custom_color(0, get_theme_color(SNAME("disabled_font_color"), SNAME("Editor")));
  554. p_parent->set_selectable(0, false);
  555. p_parent->deselect(0);
  556. }
  557. if (editor_selection) {
  558. Node *n = get_node(p_parent->get_metadata(0));
  559. if (keep) {
  560. if (p_scroll_to_selected && n && editor_selection->is_selected(n)) {
  561. tree->scroll_to_item(p_parent);
  562. }
  563. } else {
  564. if (n && p_parent->is_selected(0)) {
  565. editor_selection->remove_node(n);
  566. p_parent->deselect(0);
  567. }
  568. }
  569. }
  570. return keep || keep_for_children;
  571. }
  572. bool SceneTreeEditor::_item_matches_all_terms(TreeItem *p_item, PackedStringArray p_terms) {
  573. if (p_terms.is_empty()) {
  574. return true;
  575. }
  576. for (int i = 0; i < p_terms.size(); i++) {
  577. String term = p_terms[i];
  578. // Recognize special filter.
  579. if (term.contains(":") && !term.get_slicec(':', 0).is_empty()) {
  580. String parameter = term.get_slicec(':', 0);
  581. String argument = term.get_slicec(':', 1);
  582. if (parameter == "type" || parameter == "t") {
  583. // Filter by Type.
  584. String type = get_node(p_item->get_metadata(0))->get_class();
  585. bool term_in_inherited_class = false;
  586. // Every Node is is a Node, duh!
  587. while (type != "Node") {
  588. if (type.to_lower().contains(argument)) {
  589. term_in_inherited_class = true;
  590. break;
  591. }
  592. type = ClassDB::get_parent_class(type);
  593. }
  594. if (!term_in_inherited_class) {
  595. return false;
  596. }
  597. } else if (parameter == "group" || parameter == "g") {
  598. // Filter by Group.
  599. Node *node = get_node(p_item->get_metadata(0));
  600. if (argument.is_empty()) {
  601. // When argument is empty, match all Nodes belonging to any exposed group.
  602. if (node->get_persistent_group_count() == 0) {
  603. return false;
  604. }
  605. } else {
  606. List<Node::GroupInfo> group_info_list;
  607. node->get_groups(&group_info_list);
  608. bool term_in_groups = false;
  609. for (int j = 0; j < group_info_list.size(); j++) {
  610. if (!group_info_list[j].persistent) {
  611. continue; // Ignore internal groups.
  612. }
  613. if (String(group_info_list[j].name).to_lower().contains(argument)) {
  614. term_in_groups = true;
  615. break;
  616. }
  617. }
  618. if (!term_in_groups) {
  619. return false;
  620. }
  621. }
  622. } else if (filter_term_warning.is_empty()) {
  623. filter_term_warning = vformat(TTR("\"%s\" is not a known filter."), parameter);
  624. continue;
  625. }
  626. } else {
  627. // Default.
  628. if (!p_item->get_text(0).to_lower().contains(term)) {
  629. return false;
  630. }
  631. }
  632. }
  633. return true;
  634. }
  635. void SceneTreeEditor::_compute_hash(Node *p_node, uint64_t &hash) {
  636. hash = hash_djb2_one_64(p_node->get_instance_id(), hash);
  637. if (p_node->get_parent()) {
  638. hash = hash_djb2_one_64(p_node->get_parent()->get_instance_id(), hash); //so a reparent still produces a different hash
  639. }
  640. for (int i = 0; i < p_node->get_child_count(); i++) {
  641. _compute_hash(p_node->get_child(i), hash);
  642. }
  643. }
  644. void SceneTreeEditor::_test_update_tree() {
  645. pending_test_update = false;
  646. if (!is_inside_tree()) {
  647. return;
  648. }
  649. if (tree_dirty) {
  650. return; // don't even bother
  651. }
  652. uint64_t hash = hash_djb2_one_64(0);
  653. if (get_scene_node()) {
  654. _compute_hash(get_scene_node(), hash);
  655. }
  656. //test hash
  657. if (hash == last_hash) {
  658. return; // did not change
  659. }
  660. MessageQueue::get_singleton()->push_call(this, "_update_tree");
  661. tree_dirty = true;
  662. }
  663. void SceneTreeEditor::_tree_process_mode_changed() {
  664. MessageQueue::get_singleton()->push_call(this, "_update_tree");
  665. tree_dirty = true;
  666. }
  667. void SceneTreeEditor::_tree_changed() {
  668. if (EditorNode::get_singleton()->is_exiting()) {
  669. return; //speed up exit
  670. }
  671. if (pending_test_update) {
  672. return;
  673. }
  674. if (tree_dirty) {
  675. return;
  676. }
  677. MessageQueue::get_singleton()->push_call(this, "_test_update_tree");
  678. pending_test_update = true;
  679. }
  680. void SceneTreeEditor::_selected_changed() {
  681. TreeItem *s = tree->get_selected();
  682. ERR_FAIL_COND(!s);
  683. NodePath np = s->get_metadata(0);
  684. Node *n = get_node(np);
  685. if (n == selected) {
  686. return;
  687. }
  688. selected = get_node(np);
  689. blocked++;
  690. emit_signal(SNAME("node_selected"));
  691. blocked--;
  692. }
  693. void SceneTreeEditor::_deselect_items() {
  694. // Clear currently selected items in scene tree dock.
  695. if (editor_selection) {
  696. editor_selection->clear();
  697. emit_signal(SNAME("node_changed"));
  698. }
  699. }
  700. void SceneTreeEditor::_cell_multi_selected(Object *p_object, int p_cell, bool p_selected) {
  701. TreeItem *item = Object::cast_to<TreeItem>(p_object);
  702. ERR_FAIL_COND(!item);
  703. if (!item->is_visible()) {
  704. return;
  705. }
  706. NodePath np = item->get_metadata(0);
  707. Node *n = get_node(np);
  708. if (!n) {
  709. return;
  710. }
  711. if (!editor_selection) {
  712. return;
  713. }
  714. if (p_selected) {
  715. editor_selection->add_node(n);
  716. } else {
  717. editor_selection->remove_node(n);
  718. }
  719. // Emitted "selected" in _selected_changed() when select single node, so select multiple node emit "changed"
  720. if (editor_selection->get_selected_nodes().size() > 1) {
  721. emit_signal(SNAME("node_changed"));
  722. }
  723. }
  724. void SceneTreeEditor::_notification(int p_what) {
  725. switch (p_what) {
  726. case NOTIFICATION_ENTER_TREE: {
  727. get_tree()->connect("tree_changed", callable_mp(this, &SceneTreeEditor::_tree_changed));
  728. get_tree()->connect("tree_process_mode_changed", callable_mp(this, &SceneTreeEditor::_tree_process_mode_changed));
  729. get_tree()->connect("node_removed", callable_mp(this, &SceneTreeEditor::_node_removed));
  730. get_tree()->connect("node_renamed", callable_mp(this, &SceneTreeEditor::_node_renamed));
  731. get_tree()->connect("node_configuration_warning_changed", callable_mp(this, &SceneTreeEditor::_warning_changed));
  732. tree->connect("item_collapsed", callable_mp(this, &SceneTreeEditor::_cell_collapsed));
  733. _update_tree();
  734. } break;
  735. case NOTIFICATION_EXIT_TREE: {
  736. get_tree()->disconnect("tree_changed", callable_mp(this, &SceneTreeEditor::_tree_changed));
  737. get_tree()->disconnect("tree_process_mode_changed", callable_mp(this, &SceneTreeEditor::_tree_process_mode_changed));
  738. get_tree()->disconnect("node_removed", callable_mp(this, &SceneTreeEditor::_node_removed));
  739. get_tree()->disconnect("node_renamed", callable_mp(this, &SceneTreeEditor::_node_renamed));
  740. tree->disconnect("item_collapsed", callable_mp(this, &SceneTreeEditor::_cell_collapsed));
  741. get_tree()->disconnect("node_configuration_warning_changed", callable_mp(this, &SceneTreeEditor::_warning_changed));
  742. } break;
  743. case NOTIFICATION_THEME_CHANGED: {
  744. tree->add_theme_constant_override("icon_max_width", get_theme_constant(SNAME("class_icon_size"), SNAME("Editor")));
  745. _update_tree();
  746. } break;
  747. }
  748. }
  749. TreeItem *SceneTreeEditor::_find(TreeItem *p_node, const NodePath &p_path) {
  750. if (!p_node) {
  751. return nullptr;
  752. }
  753. NodePath np = p_node->get_metadata(0);
  754. if (np == p_path) {
  755. return p_node;
  756. }
  757. TreeItem *children = p_node->get_first_child();
  758. while (children) {
  759. TreeItem *n = _find(children, p_path);
  760. if (n) {
  761. return n;
  762. }
  763. children = children->get_next();
  764. }
  765. return nullptr;
  766. }
  767. void SceneTreeEditor::set_selected(Node *p_node, bool p_emit_selected) {
  768. ERR_FAIL_COND(blocked > 0);
  769. if (pending_test_update) {
  770. _test_update_tree();
  771. }
  772. if (tree_dirty) {
  773. _update_tree();
  774. }
  775. if (selected == p_node) {
  776. return;
  777. }
  778. TreeItem *item = p_node ? _find(tree->get_root(), p_node->get_path()) : nullptr;
  779. if (item) {
  780. if (auto_expand_selected) {
  781. // Make visible when it's collapsed.
  782. TreeItem *node = item->get_parent();
  783. while (node && node != tree->get_root()) {
  784. node->set_collapsed(false);
  785. node = node->get_parent();
  786. }
  787. item->select(0);
  788. item->set_as_cursor(0);
  789. selected = p_node;
  790. tree->ensure_cursor_is_visible();
  791. }
  792. } else {
  793. if (!p_node) {
  794. selected = nullptr;
  795. }
  796. _update_tree();
  797. selected = p_node;
  798. }
  799. if (p_emit_selected) {
  800. emit_signal(SNAME("node_selected"));
  801. }
  802. }
  803. void SceneTreeEditor::_rename_node(Node *p_node, const String &p_name) {
  804. TreeItem *item = _find(tree->get_root(), p_node->get_path());
  805. ERR_FAIL_COND(!item);
  806. String new_name = p_name.validate_node_name();
  807. if (new_name != p_name) {
  808. error->set_text(TTR("Invalid node name, the following characters are not allowed:") + "\n" + String::get_invalid_node_name_characters());
  809. error->popup_centered();
  810. if (new_name.is_empty()) {
  811. item->set_text(0, p_node->get_name());
  812. return;
  813. }
  814. item->set_text(0, new_name);
  815. }
  816. if (new_name == p_node->get_name()) {
  817. if (item->get_text(0).is_empty()) {
  818. item->set_text(0, new_name);
  819. }
  820. return;
  821. }
  822. // Trim leading/trailing whitespace to prevent node names from containing accidental whitespace, which would make it more difficult to get the node via `get_node()`.
  823. new_name = new_name.strip_edges();
  824. if (!is_scene_tree_dock) {
  825. p_node->set_name(new_name);
  826. item->set_metadata(0, p_node->get_path());
  827. emit_signal(SNAME("node_renamed"));
  828. } else {
  829. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  830. undo_redo->create_action("Rename Node", UndoRedo::MERGE_DISABLE, p_node);
  831. emit_signal(SNAME("node_prerename"), p_node, new_name);
  832. undo_redo->add_undo_method(p_node, "set_name", p_node->get_name());
  833. undo_redo->add_undo_method(item, "set_metadata", 0, p_node->get_path());
  834. undo_redo->add_undo_method(item, "set_text", 0, p_node->get_name());
  835. p_node->set_name(p_name);
  836. undo_redo->add_do_method(p_node, "set_name", new_name);
  837. undo_redo->add_do_method(item, "set_metadata", 0, p_node->get_path());
  838. undo_redo->add_do_method(item, "set_text", 0, new_name);
  839. undo_redo->commit_action();
  840. }
  841. }
  842. void SceneTreeEditor::_renamed() {
  843. TreeItem *which = tree->get_edited();
  844. ERR_FAIL_COND(!which);
  845. NodePath np = which->get_metadata(0);
  846. Node *n = get_node(np);
  847. ERR_FAIL_COND(!n);
  848. String new_name = which->get_text(0);
  849. if (new_name.strip_edges().is_empty()) {
  850. // If name is empty, fallback to class name.
  851. if (GLOBAL_GET("editor/naming/node_name_casing").operator int() != NAME_CASING_PASCAL_CASE) {
  852. new_name = Node::adjust_name_casing(n->get_class());
  853. } else {
  854. new_name = n->get_class();
  855. }
  856. }
  857. if (n->is_unique_name_in_owner() && get_tree()->get_edited_scene_root()->get_node_or_null("%" + new_name) != nullptr) {
  858. error->set_text(TTR("Another node already uses this unique name in the scene."));
  859. error->popup_centered();
  860. which->set_text(0, n->get_name());
  861. return;
  862. }
  863. _rename_node(n, new_name);
  864. }
  865. Node *SceneTreeEditor::get_selected() {
  866. return selected;
  867. }
  868. void SceneTreeEditor::set_marked(const HashSet<Node *> &p_marked, bool p_selectable, bool p_children_selectable) {
  869. if (tree_dirty) {
  870. _update_tree();
  871. }
  872. marked = p_marked;
  873. marked_selectable = p_selectable;
  874. marked_children_selectable = p_children_selectable;
  875. _update_tree();
  876. }
  877. void SceneTreeEditor::set_marked(Node *p_marked, bool p_selectable, bool p_children_selectable) {
  878. HashSet<Node *> s;
  879. if (p_marked) {
  880. s.insert(p_marked);
  881. }
  882. set_marked(s, p_selectable, p_children_selectable);
  883. }
  884. void SceneTreeEditor::set_filter(const String &p_filter) {
  885. filter = p_filter;
  886. _update_filter(nullptr, true);
  887. }
  888. String SceneTreeEditor::get_filter() const {
  889. return filter;
  890. }
  891. String SceneTreeEditor::get_filter_term_warning() {
  892. return filter_term_warning;
  893. }
  894. void SceneTreeEditor::set_as_scene_tree_dock() {
  895. is_scene_tree_dock = true;
  896. }
  897. void SceneTreeEditor::set_display_foreign_nodes(bool p_display) {
  898. display_foreign = p_display;
  899. _update_tree();
  900. }
  901. void SceneTreeEditor::set_valid_types(const Vector<StringName> &p_valid) {
  902. valid_types = p_valid;
  903. }
  904. void SceneTreeEditor::set_editor_selection(EditorSelection *p_selection) {
  905. editor_selection = p_selection;
  906. tree->set_select_mode(Tree::SELECT_MULTI);
  907. tree->set_cursor_can_exit_tree(false);
  908. editor_selection->connect("selection_changed", callable_mp(this, &SceneTreeEditor::_selection_changed));
  909. }
  910. void SceneTreeEditor::_update_selection(TreeItem *item) {
  911. ERR_FAIL_COND(!item);
  912. NodePath np = item->get_metadata(0);
  913. if (!has_node(np)) {
  914. return;
  915. }
  916. Node *n = get_node(np);
  917. if (!n) {
  918. return;
  919. }
  920. if (editor_selection->is_selected(n)) {
  921. if (!item->is_selected(0)) {
  922. item->select(0);
  923. }
  924. } else {
  925. if (item->is_selected(0)) {
  926. TreeItem *previous_cursor_item = tree->get_selected();
  927. item->deselect(0);
  928. previous_cursor_item->set_as_cursor(0);
  929. }
  930. }
  931. TreeItem *c = item->get_first_child();
  932. while (c) {
  933. _update_selection(c);
  934. c = c->get_next();
  935. }
  936. }
  937. void SceneTreeEditor::_selection_changed() {
  938. if (!editor_selection) {
  939. return;
  940. }
  941. TreeItem *root = tree->get_root();
  942. if (!root) {
  943. return;
  944. }
  945. _update_selection(root);
  946. }
  947. void SceneTreeEditor::_cell_collapsed(Object *p_obj) {
  948. if (updating_tree) {
  949. return;
  950. }
  951. if (!can_rename) {
  952. return;
  953. }
  954. TreeItem *ti = Object::cast_to<TreeItem>(p_obj);
  955. if (!ti) {
  956. return;
  957. }
  958. bool collapsed = ti->is_collapsed();
  959. NodePath np = ti->get_metadata(0);
  960. Node *n = get_node(np);
  961. ERR_FAIL_COND(!n);
  962. n->set_display_folded(collapsed);
  963. }
  964. Variant SceneTreeEditor::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  965. if (!can_rename) {
  966. return Variant(); //not editable tree
  967. }
  968. if (tree->get_button_id_at_position(p_point) != -1) {
  969. return Variant(); //dragging from button
  970. }
  971. Vector<Node *> selected_nodes;
  972. Vector<Ref<Texture2D>> icons;
  973. TreeItem *next = tree->get_next_selected(nullptr);
  974. while (next) {
  975. NodePath np = next->get_metadata(0);
  976. Node *n = get_node(np);
  977. if (n) {
  978. // Only allow selection if not part of an instantiated scene.
  979. if (!n->get_owner() || n->get_owner() == get_scene_node() || n->get_owner()->get_scene_file_path().is_empty()) {
  980. selected_nodes.push_back(n);
  981. icons.push_back(next->get_icon(0));
  982. }
  983. }
  984. next = tree->get_next_selected(next);
  985. }
  986. if (selected_nodes.is_empty()) {
  987. return Variant();
  988. }
  989. VBoxContainer *vb = memnew(VBoxContainer);
  990. Array objs;
  991. int list_max = 10;
  992. float opacity_step = 1.0f / list_max;
  993. float opacity_item = 1.0f;
  994. for (int i = 0; i < selected_nodes.size(); i++) {
  995. if (i < list_max) {
  996. HBoxContainer *hb = memnew(HBoxContainer);
  997. TextureRect *tf = memnew(TextureRect);
  998. tf->set_texture(icons[i]);
  999. tf->set_stretch_mode(TextureRect::STRETCH_KEEP_CENTERED);
  1000. hb->add_child(tf);
  1001. Label *label = memnew(Label(selected_nodes[i]->get_name()));
  1002. hb->add_child(label);
  1003. vb->add_child(hb);
  1004. hb->set_modulate(Color(1, 1, 1, opacity_item));
  1005. opacity_item -= opacity_step;
  1006. }
  1007. NodePath p = selected_nodes[i]->get_path();
  1008. objs.push_back(p);
  1009. }
  1010. set_drag_preview(vb);
  1011. Dictionary drag_data;
  1012. drag_data["type"] = "nodes";
  1013. drag_data["nodes"] = objs;
  1014. tree->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN | Tree::DROP_MODE_ON_ITEM);
  1015. emit_signal(SNAME("nodes_dragged"));
  1016. return drag_data;
  1017. }
  1018. bool SceneTreeEditor::_is_script_type(const StringName &p_type) const {
  1019. return (script_types->find(p_type));
  1020. }
  1021. bool SceneTreeEditor::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  1022. if (!can_rename) {
  1023. return false; //not editable tree
  1024. }
  1025. Dictionary d = p_data;
  1026. if (!d.has("type")) {
  1027. return false;
  1028. }
  1029. TreeItem *item = tree->get_item_at_position(p_point);
  1030. if (!item) {
  1031. return false;
  1032. }
  1033. int section = tree->get_drop_section_at_position(p_point);
  1034. if (section < -1 || (section == -1 && !item->get_parent())) {
  1035. return false;
  1036. }
  1037. if (String(d["type"]) == "files") {
  1038. Vector<String> files = d["files"];
  1039. if (files.size() == 0) {
  1040. return false; //weird
  1041. }
  1042. if (_is_script_type(EditorFileSystem::get_singleton()->get_file_type(files[0]))) {
  1043. tree->set_drop_mode_flags(Tree::DROP_MODE_ON_ITEM);
  1044. return true;
  1045. }
  1046. bool scene_drop = true;
  1047. for (int i = 0; i < files.size(); i++) {
  1048. String file = files[i];
  1049. String ftype = EditorFileSystem::get_singleton()->get_file_type(file);
  1050. if (ftype != "PackedScene") {
  1051. scene_drop = false;
  1052. break;
  1053. }
  1054. }
  1055. if (scene_drop) {
  1056. tree->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN | Tree::DROP_MODE_ON_ITEM);
  1057. } else {
  1058. if (files.size() > 1) {
  1059. return false;
  1060. }
  1061. tree->set_drop_mode_flags(Tree::DROP_MODE_ON_ITEM);
  1062. }
  1063. return true;
  1064. }
  1065. if (String(d["type"]) == "script_list_element") {
  1066. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(d["script_list_element"]);
  1067. if (se) {
  1068. String sp = se->get_edited_resource()->get_path();
  1069. if (_is_script_type(EditorFileSystem::get_singleton()->get_file_type(sp))) {
  1070. tree->set_drop_mode_flags(Tree::DROP_MODE_ON_ITEM);
  1071. return true;
  1072. }
  1073. }
  1074. }
  1075. return String(d["type"]) == "nodes" && filter.is_empty();
  1076. }
  1077. void SceneTreeEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  1078. if (!can_drop_data_fw(p_point, p_data, p_from)) {
  1079. return;
  1080. }
  1081. TreeItem *item = tree->get_item_at_position(p_point);
  1082. if (!item) {
  1083. return;
  1084. }
  1085. int section = tree->get_drop_section_at_position(p_point);
  1086. if (section < -1) {
  1087. return;
  1088. }
  1089. NodePath np = item->get_metadata(0);
  1090. Node *n = get_node(np);
  1091. if (!n) {
  1092. return;
  1093. }
  1094. Dictionary d = p_data;
  1095. if (String(d["type"]) == "nodes") {
  1096. Array nodes = d["nodes"];
  1097. emit_signal(SNAME("nodes_rearranged"), nodes, np, section);
  1098. }
  1099. if (String(d["type"]) == "files") {
  1100. Vector<String> files = d["files"];
  1101. String ftype = EditorFileSystem::get_singleton()->get_file_type(files[0]);
  1102. if (_is_script_type(ftype)) {
  1103. emit_signal(SNAME("script_dropped"), files[0], np);
  1104. } else {
  1105. emit_signal(SNAME("files_dropped"), files, np, section);
  1106. }
  1107. }
  1108. if (String(d["type"]) == "script_list_element") {
  1109. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(d["script_list_element"]);
  1110. if (se) {
  1111. String sp = se->get_edited_resource()->get_path();
  1112. if (_is_script_type(EditorFileSystem::get_singleton()->get_file_type(sp))) {
  1113. emit_signal(SNAME("script_dropped"), sp, np);
  1114. }
  1115. }
  1116. }
  1117. }
  1118. void SceneTreeEditor::_empty_clicked(const Vector2 &p_pos, MouseButton p_button) {
  1119. if (p_button != MouseButton::RIGHT) {
  1120. return;
  1121. }
  1122. _rmb_select(p_pos);
  1123. }
  1124. void SceneTreeEditor::_rmb_select(const Vector2 &p_pos, MouseButton p_button) {
  1125. if (p_button != MouseButton::RIGHT) {
  1126. return;
  1127. }
  1128. emit_signal(SNAME("rmb_pressed"), tree->get_screen_position() + p_pos);
  1129. }
  1130. void SceneTreeEditor::update_warning() {
  1131. _warning_changed(nullptr);
  1132. }
  1133. void SceneTreeEditor::_warning_changed(Node *p_for_node) {
  1134. //should use a timer
  1135. update_timer->start();
  1136. }
  1137. void SceneTreeEditor::set_auto_expand_selected(bool p_auto, bool p_update_settings) {
  1138. if (p_update_settings) {
  1139. EditorSettings::get_singleton()->set("docks/scene_tree/auto_expand_to_selected", p_auto);
  1140. }
  1141. auto_expand_selected = p_auto;
  1142. }
  1143. void SceneTreeEditor::set_connect_to_script_mode(bool p_enable) {
  1144. connect_to_script_mode = p_enable;
  1145. update_tree();
  1146. }
  1147. void SceneTreeEditor::set_connecting_signal(bool p_enable) {
  1148. connecting_signal = p_enable;
  1149. update_tree();
  1150. }
  1151. void SceneTreeEditor::_bind_methods() {
  1152. ClassDB::bind_method(D_METHOD("_update_tree"), &SceneTreeEditor::_update_tree, DEFVAL(false)); // Still used by UndoRedo.
  1153. ClassDB::bind_method("_rename_node", &SceneTreeEditor::_rename_node);
  1154. ClassDB::bind_method("_test_update_tree", &SceneTreeEditor::_test_update_tree);
  1155. ClassDB::bind_method(D_METHOD("update_tree"), &SceneTreeEditor::update_tree);
  1156. ADD_SIGNAL(MethodInfo("node_selected"));
  1157. ADD_SIGNAL(MethodInfo("node_renamed"));
  1158. ADD_SIGNAL(MethodInfo("node_prerename"));
  1159. ADD_SIGNAL(MethodInfo("node_changed"));
  1160. ADD_SIGNAL(MethodInfo("nodes_dragged"));
  1161. ADD_SIGNAL(MethodInfo("nodes_rearranged", PropertyInfo(Variant::ARRAY, "paths"), PropertyInfo(Variant::NODE_PATH, "to_path"), PropertyInfo(Variant::INT, "type")));
  1162. ADD_SIGNAL(MethodInfo("files_dropped", PropertyInfo(Variant::PACKED_STRING_ARRAY, "files"), PropertyInfo(Variant::NODE_PATH, "to_path"), PropertyInfo(Variant::INT, "type")));
  1163. ADD_SIGNAL(MethodInfo("script_dropped", PropertyInfo(Variant::STRING, "file"), PropertyInfo(Variant::NODE_PATH, "to_path")));
  1164. ADD_SIGNAL(MethodInfo("rmb_pressed", PropertyInfo(Variant::VECTOR2, "position")));
  1165. ADD_SIGNAL(MethodInfo("open"));
  1166. ADD_SIGNAL(MethodInfo("open_script"));
  1167. }
  1168. SceneTreeEditor::SceneTreeEditor(bool p_label, bool p_can_rename, bool p_can_open_instance) {
  1169. selected = nullptr;
  1170. can_rename = p_can_rename;
  1171. can_open_instance = p_can_open_instance;
  1172. editor_selection = nullptr;
  1173. if (p_label) {
  1174. Label *label = memnew(Label);
  1175. label->set_theme_type_variation("HeaderSmall");
  1176. label->set_position(Point2(10, 0));
  1177. label->set_text(TTR("Scene Tree (Nodes):"));
  1178. add_child(label);
  1179. }
  1180. tree = memnew(Tree);
  1181. tree->set_anchor(SIDE_RIGHT, ANCHOR_END);
  1182. tree->set_anchor(SIDE_BOTTOM, ANCHOR_END);
  1183. tree->set_begin(Point2(0, p_label ? 18 : 0));
  1184. tree->set_end(Point2(0, 0));
  1185. tree->set_allow_reselect(true);
  1186. tree->add_theme_constant_override("button_margin", 0);
  1187. add_child(tree);
  1188. SET_DRAG_FORWARDING_GCD(tree, SceneTreeEditor);
  1189. if (p_can_rename) {
  1190. tree->set_allow_rmb_select(true);
  1191. tree->connect("item_mouse_selected", callable_mp(this, &SceneTreeEditor::_rmb_select));
  1192. tree->connect("empty_clicked", callable_mp(this, &SceneTreeEditor::_empty_clicked));
  1193. }
  1194. tree->connect("cell_selected", callable_mp(this, &SceneTreeEditor::_selected_changed));
  1195. tree->connect("item_edited", callable_mp(this, &SceneTreeEditor::_renamed));
  1196. tree->connect("multi_selected", callable_mp(this, &SceneTreeEditor::_cell_multi_selected));
  1197. tree->connect("button_clicked", callable_mp(this, &SceneTreeEditor::_cell_button_pressed));
  1198. tree->connect("nothing_selected", callable_mp(this, &SceneTreeEditor::_deselect_items));
  1199. error = memnew(AcceptDialog);
  1200. add_child(error);
  1201. warning = memnew(AcceptDialog);
  1202. add_child(warning);
  1203. warning->set_title(TTR("Node Configuration Warning!"));
  1204. last_hash = 0;
  1205. blocked = 0;
  1206. update_timer = memnew(Timer);
  1207. update_timer->connect("timeout", callable_mp(this, &SceneTreeEditor::_update_tree).bind(false));
  1208. update_timer->set_one_shot(true);
  1209. update_timer->set_wait_time(0.5);
  1210. add_child(update_timer);
  1211. script_types = memnew(List<StringName>);
  1212. ClassDB::get_inheriters_from_class("Script", script_types);
  1213. }
  1214. SceneTreeEditor::~SceneTreeEditor() {
  1215. memdelete(script_types);
  1216. }
  1217. /******** DIALOG *********/
  1218. void SceneTreeDialog::popup_scenetree_dialog() {
  1219. popup_centered_clamped(Size2(350, 700) * EDSCALE);
  1220. }
  1221. void SceneTreeDialog::_update_theme() {
  1222. filter->set_right_icon(tree->get_theme_icon(SNAME("Search"), SNAME("EditorIcons")));
  1223. }
  1224. void SceneTreeDialog::_notification(int p_what) {
  1225. switch (p_what) {
  1226. case NOTIFICATION_VISIBILITY_CHANGED: {
  1227. if (is_visible()) {
  1228. tree->update_tree();
  1229. // Select the search bar by default.
  1230. filter->call_deferred(SNAME("grab_focus"));
  1231. }
  1232. } break;
  1233. case NOTIFICATION_ENTER_TREE: {
  1234. connect("confirmed", callable_mp(this, &SceneTreeDialog::_select));
  1235. _update_theme();
  1236. } break;
  1237. case NOTIFICATION_THEME_CHANGED: {
  1238. _update_theme();
  1239. } break;
  1240. case NOTIFICATION_EXIT_TREE: {
  1241. disconnect("confirmed", callable_mp(this, &SceneTreeDialog::_select));
  1242. } break;
  1243. }
  1244. }
  1245. void SceneTreeDialog::_cancel() {
  1246. hide();
  1247. }
  1248. void SceneTreeDialog::_select() {
  1249. if (tree->get_selected()) {
  1250. // The signal may cause another dialog to be displayed, so be sure to hide this one first.
  1251. hide();
  1252. emit_signal(SNAME("selected"), tree->get_selected()->get_path());
  1253. }
  1254. }
  1255. void SceneTreeDialog::_selected_changed() {
  1256. get_ok_button()->set_disabled(!tree->get_selected());
  1257. }
  1258. void SceneTreeDialog::_filter_changed(const String &p_filter) {
  1259. tree->set_filter(p_filter);
  1260. }
  1261. void SceneTreeDialog::_bind_methods() {
  1262. ClassDB::bind_method("_cancel", &SceneTreeDialog::_cancel);
  1263. ADD_SIGNAL(MethodInfo("selected", PropertyInfo(Variant::NODE_PATH, "path")));
  1264. }
  1265. SceneTreeDialog::SceneTreeDialog() {
  1266. set_title(TTR("Select a Node"));
  1267. VBoxContainer *vbc = memnew(VBoxContainer);
  1268. add_child(vbc);
  1269. filter = memnew(LineEdit);
  1270. filter->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  1271. filter->set_placeholder(TTR("Filter Nodes"));
  1272. filter->set_clear_button_enabled(true);
  1273. filter->add_theme_constant_override("minimum_character_width", 0);
  1274. filter->connect("text_changed", callable_mp(this, &SceneTreeDialog::_filter_changed));
  1275. vbc->add_child(filter);
  1276. tree = memnew(SceneTreeEditor(false, false, true));
  1277. tree->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  1278. tree->get_scene_tree()->connect("item_activated", callable_mp(this, &SceneTreeDialog::_select));
  1279. vbc->add_child(tree);
  1280. // Disable the OK button when no node is selected.
  1281. get_ok_button()->set_disabled(!tree->get_selected());
  1282. tree->connect("node_selected", callable_mp(this, &SceneTreeDialog::_selected_changed));
  1283. }
  1284. SceneTreeDialog::~SceneTreeDialog() {
  1285. }