scene_tree_editor.cpp 58 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873
  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/script_language.h"
  33. #include "editor/editor_dock_manager.h"
  34. #include "editor/editor_file_system.h"
  35. #include "editor/editor_node.h"
  36. #include "editor/editor_settings.h"
  37. #include "editor/editor_string_names.h"
  38. #include "editor/editor_undo_redo_manager.h"
  39. #include "editor/node_dock.h"
  40. #include "editor/plugins/animation_player_editor_plugin.h"
  41. #include "editor/plugins/canvas_item_editor_plugin.h"
  42. #include "editor/plugins/script_editor_plugin.h"
  43. #include "editor/themes/editor_scale.h"
  44. #include "scene/gui/flow_container.h"
  45. #include "scene/gui/label.h"
  46. #include "scene/gui/texture_rect.h"
  47. #include "scene/main/window.h"
  48. #include "scene/resources/packed_scene.h"
  49. Node *SceneTreeEditor::get_scene_node() const {
  50. ERR_FAIL_COND_V(!is_inside_tree(), nullptr);
  51. return get_tree()->get_edited_scene_root();
  52. }
  53. void SceneTreeEditor::_cell_button_pressed(Object *p_item, int p_column, int p_id, MouseButton p_button) {
  54. if (p_button != MouseButton::LEFT) {
  55. return;
  56. }
  57. if (connect_to_script_mode) {
  58. return; //don't do anything in this mode
  59. }
  60. TreeItem *item = Object::cast_to<TreeItem>(p_item);
  61. ERR_FAIL_NULL(item);
  62. NodePath np = item->get_metadata(0);
  63. Node *n = get_node(np);
  64. ERR_FAIL_NULL(n);
  65. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  66. if (p_id == BUTTON_SUBSCENE) {
  67. if (n == get_scene_node()) {
  68. if (n && n->get_scene_inherited_state().is_valid()) {
  69. emit_signal(SNAME("open"), n->get_scene_inherited_state()->get_path());
  70. }
  71. } else {
  72. emit_signal(SNAME("open"), n->get_scene_file_path());
  73. }
  74. } else if (p_id == BUTTON_SCRIPT) {
  75. Ref<Script> script_typed = n->get_script();
  76. if (!script_typed.is_null()) {
  77. emit_signal(SNAME("open_script"), script_typed);
  78. }
  79. } else if (p_id == BUTTON_VISIBILITY) {
  80. undo_redo->create_action(TTR("Toggle Visible"));
  81. _toggle_visible(n);
  82. List<Node *> selection = editor_selection->get_selected_node_list();
  83. if (selection.size() > 1 && selection.find(n) != nullptr) {
  84. for (Node *nv : selection) {
  85. ERR_FAIL_NULL(nv);
  86. if (nv == n) {
  87. continue;
  88. }
  89. _toggle_visible(nv);
  90. }
  91. }
  92. undo_redo->commit_action();
  93. } else if (p_id == BUTTON_LOCK) {
  94. undo_redo->create_action(TTR("Unlock Node"));
  95. undo_redo->add_do_method(n, "remove_meta", "_edit_lock_");
  96. undo_redo->add_undo_method(n, "set_meta", "_edit_lock_", true);
  97. undo_redo->add_do_method(this, "_update_tree");
  98. undo_redo->add_undo_method(this, "_update_tree");
  99. undo_redo->add_do_method(this, "emit_signal", "node_changed");
  100. undo_redo->add_undo_method(this, "emit_signal", "node_changed");
  101. undo_redo->commit_action();
  102. } else if (p_id == BUTTON_PIN) {
  103. if (n->is_class("AnimationMixer")) {
  104. AnimationPlayerEditor::get_singleton()->unpin();
  105. _update_tree();
  106. }
  107. } else if (p_id == BUTTON_GROUP) {
  108. undo_redo->create_action(TTR("Ungroup Children"));
  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. const PackedStringArray warnings = n->get_configuration_warnings();
  120. if (warnings.is_empty()) {
  121. return;
  122. }
  123. // Improve looks on tooltip, extra spacing on non-bullet point newlines.
  124. const String bullet_point = U"• ";
  125. String all_warnings;
  126. for (const String &w : warnings) {
  127. all_warnings += "\n" + bullet_point + w;
  128. }
  129. // Limit the line width while keeping some padding.
  130. // It is not efficient, but it does not have to be.
  131. const PackedInt32Array boundaries = TS->string_get_word_breaks(all_warnings, "", 80);
  132. PackedStringArray lines;
  133. for (int i = 0; i < boundaries.size(); i += 2) {
  134. const int start = boundaries[i];
  135. const int end = boundaries[i + 1];
  136. const String line = all_warnings.substr(start, end - start);
  137. lines.append(line);
  138. }
  139. all_warnings = String("\n").join(lines).indent(" ").replace(U" •", U"\n•").substr(2); // We don't want the first two newlines.
  140. warning->set_text(all_warnings);
  141. warning->popup_centered();
  142. } else if (p_id == BUTTON_SIGNALS) {
  143. editor_selection->clear();
  144. editor_selection->add_node(n);
  145. set_selected(n);
  146. EditorDockManager::get_singleton()->focus_dock(NodeDock::get_singleton());
  147. NodeDock::get_singleton()->show_connections();
  148. } else if (p_id == BUTTON_GROUPS) {
  149. editor_selection->clear();
  150. editor_selection->add_node(n);
  151. set_selected(n);
  152. EditorDockManager::get_singleton()->focus_dock(NodeDock::get_singleton());
  153. NodeDock::get_singleton()->show_groups();
  154. } else if (p_id == BUTTON_UNIQUE) {
  155. bool ask_before_revoking_unique_name = EDITOR_GET("docks/scene_tree/ask_before_revoking_unique_name");
  156. revoke_node = n;
  157. if (ask_before_revoking_unique_name) {
  158. String msg = vformat(TTR("Revoke unique name for node \"%s\"?"), n->get_name());
  159. ask_before_revoke_checkbox->set_pressed(false);
  160. revoke_dialog_label->set_text(msg);
  161. revoke_dialog->reset_size();
  162. revoke_dialog->popup_centered();
  163. } else {
  164. _revoke_unique_name();
  165. }
  166. }
  167. }
  168. void SceneTreeEditor::_update_ask_before_revoking_unique_name() {
  169. if (ask_before_revoke_checkbox->is_pressed()) {
  170. EditorSettings::get_singleton()->set("docks/scene_tree/ask_before_revoking_unique_name", false);
  171. ask_before_revoke_checkbox->set_pressed(false);
  172. }
  173. _revoke_unique_name();
  174. }
  175. void SceneTreeEditor::_revoke_unique_name() {
  176. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  177. undo_redo->create_action(TTR("Disable Scene Unique Name"));
  178. undo_redo->add_do_method(revoke_node, "set_unique_name_in_owner", false);
  179. undo_redo->add_undo_method(revoke_node, "set_unique_name_in_owner", true);
  180. undo_redo->add_do_method(this, "_update_tree");
  181. undo_redo->add_undo_method(this, "_update_tree");
  182. undo_redo->commit_action();
  183. }
  184. void SceneTreeEditor::_toggle_visible(Node *p_node) {
  185. if (p_node->has_method("is_visible") && p_node->has_method("set_visible")) {
  186. bool v = bool(p_node->call("is_visible"));
  187. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  188. undo_redo->add_do_method(p_node, "set_visible", !v);
  189. undo_redo->add_undo_method(p_node, "set_visible", v);
  190. }
  191. }
  192. void SceneTreeEditor::_add_nodes(Node *p_node, TreeItem *p_parent) {
  193. if (!p_node) {
  194. return;
  195. }
  196. // only owned nodes are editable, since nodes can create their own (manually owned) child nodes,
  197. // which the editor needs not to know about.
  198. bool part_of_subscene = false;
  199. if (!display_foreign && p_node->get_owner() != get_scene_node() && p_node != get_scene_node()) {
  200. if ((show_enabled_subscene || can_open_instance) && p_node->get_owner() && (get_scene_node()->is_editable_instance(p_node->get_owner()))) {
  201. part_of_subscene = true;
  202. //allow
  203. } else {
  204. return;
  205. }
  206. } else {
  207. 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;
  208. }
  209. TreeItem *item = tree->create_item(p_parent);
  210. item->set_text(0, p_node->get_name());
  211. item->set_text_overrun_behavior(0, TextServer::OVERRUN_NO_TRIMMING);
  212. if (can_rename && !part_of_subscene) {
  213. item->set_editable(0, true);
  214. }
  215. item->set_selectable(0, true);
  216. if (can_rename) {
  217. bool collapsed = p_node->is_displayed_folded();
  218. if (collapsed) {
  219. item->set_collapsed(true);
  220. }
  221. }
  222. Ref<Texture2D> icon = EditorNode::get_singleton()->get_object_icon(p_node, "Node");
  223. item->set_icon(0, icon);
  224. item->set_metadata(0, p_node->get_path());
  225. if (connecting_signal) {
  226. // Add script icons for all scripted nodes.
  227. Ref<Script> scr = p_node->get_script();
  228. if (scr.is_valid()) {
  229. item->add_button(0, get_editor_theme_icon(SNAME("Script")), BUTTON_SCRIPT);
  230. if (EditorNode::get_singleton()->get_object_custom_type_base(p_node) == scr) {
  231. // Disable button on custom scripts (pure visual cue).
  232. item->set_button_disabled(0, item->get_button_count(0) - 1, true);
  233. }
  234. }
  235. }
  236. if (connect_to_script_mode) {
  237. Color accent = get_theme_color(SNAME("accent_color"), EditorStringName(Editor));
  238. Ref<Script> scr = p_node->get_script();
  239. bool has_custom_script = scr.is_valid() && EditorNode::get_singleton()->get_object_custom_type_base(p_node) == scr;
  240. if (scr.is_null() || has_custom_script) {
  241. _set_item_custom_color(item, get_theme_color(SNAME("font_disabled_color"), EditorStringName(Editor)));
  242. item->set_selectable(0, false);
  243. accent.a *= 0.7;
  244. }
  245. if (marked.has(p_node)) {
  246. String node_name = p_node->get_name();
  247. if (connecting_signal) {
  248. node_name += " " + TTR("(Connecting From)");
  249. }
  250. item->set_text(0, node_name);
  251. _set_item_custom_color(item, accent);
  252. }
  253. } else if (part_of_subscene) {
  254. if (valid_types.size() == 0) {
  255. _set_item_custom_color(item, get_theme_color(SNAME("warning_color"), EditorStringName(Editor)));
  256. }
  257. } else if (marked.has(p_node)) {
  258. String node_name = p_node->get_name();
  259. if (connecting_signal) {
  260. node_name += " " + TTR("(Connecting From)");
  261. }
  262. item->set_text(0, node_name);
  263. item->set_selectable(0, marked_selectable);
  264. _set_item_custom_color(item, get_theme_color(SNAME("accent_color"), EditorStringName(Editor)));
  265. } else if (!p_node->can_process()) {
  266. _set_item_custom_color(item, get_theme_color(SNAME("font_disabled_color"), EditorStringName(Editor)));
  267. } else if (!marked_selectable && !marked_children_selectable) {
  268. Node *node = p_node;
  269. while (node) {
  270. if (marked.has(node)) {
  271. item->set_selectable(0, false);
  272. _set_item_custom_color(item, get_theme_color(SNAME("error_color"), EditorStringName(Editor)));
  273. break;
  274. }
  275. node = node->get_parent();
  276. }
  277. }
  278. if (can_rename) { //should be can edit..
  279. const PackedStringArray warnings = p_node->get_configuration_warnings();
  280. const int num_warnings = warnings.size();
  281. if (num_warnings > 0) {
  282. StringName warning_icon;
  283. if (num_warnings == 1) {
  284. warning_icon = SNAME("NodeWarning");
  285. } else if (num_warnings <= 3) {
  286. warning_icon = vformat("NodeWarnings%d", num_warnings);
  287. } else {
  288. warning_icon = SNAME("NodeWarnings4Plus");
  289. }
  290. // Improve looks on tooltip, extra spacing on non-bullet point newlines.
  291. const String bullet_point = U"• ";
  292. String all_warnings;
  293. for (const String &w : warnings) {
  294. all_warnings += "\n\n" + bullet_point + w.replace("\n", "\n ");
  295. }
  296. if (num_warnings == 1) {
  297. all_warnings.remove_at(0); // With only one warning, two newlines do not look great.
  298. }
  299. item->add_button(0, get_editor_theme_icon(warning_icon), BUTTON_WARNING, false, TTR("Node configuration warning:") + all_warnings);
  300. }
  301. if (p_node->is_unique_name_in_owner()) {
  302. item->add_button(0, get_editor_theme_icon(SNAME("SceneUniqueName")), BUTTON_UNIQUE, p_node->get_owner() != EditorNode::get_singleton()->get_edited_scene(), 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));
  303. }
  304. int num_connections = p_node->get_persistent_signal_connection_count();
  305. int num_groups = p_node->get_persistent_group_count();
  306. String msg_temp;
  307. if (num_connections >= 1) {
  308. Array arr;
  309. arr.push_back(num_connections);
  310. msg_temp += TTRN("Node has one connection.", "Node has {num} connections.", num_connections).format(arr, "{num}");
  311. if (num_groups >= 1) {
  312. msg_temp += "\n";
  313. }
  314. }
  315. if (num_groups >= 1) {
  316. msg_temp += TTRN("Node is in this group:", "Node is in the following groups:", num_groups) + "\n";
  317. List<GroupInfo> groups;
  318. p_node->get_groups(&groups);
  319. for (const GroupInfo &E : groups) {
  320. if (E.persistent) {
  321. msg_temp += String::utf8("• ") + String(E.name) + "\n";
  322. }
  323. }
  324. } else {
  325. msg_temp += "\n";
  326. }
  327. Ref<Texture2D> icon_temp;
  328. SceneTreeEditorButton signal_temp = BUTTON_SIGNALS;
  329. String msg_temp_end = TTR("Click to show signals dock.");
  330. if (num_connections >= 1 && num_groups >= 1) {
  331. icon_temp = get_editor_theme_icon(SNAME("SignalsAndGroups"));
  332. } else if (num_connections >= 1) {
  333. icon_temp = get_editor_theme_icon(SNAME("Signals"));
  334. } else if (num_groups >= 1) {
  335. icon_temp = get_editor_theme_icon(SNAME("Groups"));
  336. signal_temp = BUTTON_GROUPS;
  337. msg_temp_end = TTR("Click to show groups dock.");
  338. }
  339. if (num_connections >= 1 || num_groups >= 1) {
  340. msg_temp += msg_temp_end;
  341. item->add_button(0, icon_temp, signal_temp, false, msg_temp);
  342. }
  343. }
  344. {
  345. _update_node_tooltip(p_node, item);
  346. Callable delay_update_tooltip = callable_mp(this, &SceneTreeEditor::_queue_update_node_tooltip);
  347. if (p_node->is_connected("editor_description_changed", delay_update_tooltip)) {
  348. p_node->disconnect("editor_description_changed", delay_update_tooltip);
  349. }
  350. p_node->connect("editor_description_changed", delay_update_tooltip.bind(item));
  351. }
  352. if (can_open_instance && is_scene_tree_dock) { // Show buttons only when necessary (SceneTreeDock) to avoid crashes.
  353. if (!p_node->is_connected(CoreStringName(script_changed), callable_mp(this, &SceneTreeEditor::_node_script_changed))) {
  354. p_node->connect(CoreStringName(script_changed), callable_mp(this, &SceneTreeEditor::_node_script_changed).bind(p_node));
  355. }
  356. Ref<Script> scr = p_node->get_script();
  357. if (!scr.is_null()) {
  358. String additional_notes;
  359. Color button_color = Color(1, 1, 1);
  360. // Can't set tooltip after adding button, need to do it before.
  361. if (scr->is_tool()) {
  362. additional_notes += "\n" + TTR("This script is currently running in the editor.");
  363. button_color = get_theme_color(SNAME("accent_color"), EditorStringName(Editor));
  364. }
  365. if (EditorNode::get_singleton()->get_object_custom_type_base(p_node) == scr) {
  366. additional_notes += "\n" + TTR("This script is a custom type.");
  367. button_color.a = 0.5;
  368. }
  369. item->add_button(0, get_editor_theme_icon(SNAME("Script")), BUTTON_SCRIPT, false, TTR("Open Script:") + " " + scr->get_path() + additional_notes);
  370. item->set_button_color(0, item->get_button_count(0) - 1, button_color);
  371. }
  372. if (p_node->has_meta("_edit_lock_")) {
  373. item->add_button(0, get_editor_theme_icon(SNAME("Lock")), BUTTON_LOCK, false, TTR("Node is locked.\nClick to unlock it."));
  374. }
  375. if (p_node->has_meta("_edit_group_")) {
  376. item->add_button(0, get_editor_theme_icon(SNAME("Group")), BUTTON_GROUP, false, TTR("Children are not selectable.\nClick to make them selectable."));
  377. }
  378. if (p_node->has_method("is_visible") && p_node->has_method("set_visible") && p_node->has_signal(SceneStringName(visibility_changed))) {
  379. bool is_visible = p_node->call("is_visible");
  380. if (is_visible) {
  381. item->add_button(0, get_editor_theme_icon(SNAME("GuiVisibilityVisible")), BUTTON_VISIBILITY, false, TTR("Toggle Visibility"));
  382. } else {
  383. item->add_button(0, get_editor_theme_icon(SNAME("GuiVisibilityHidden")), BUTTON_VISIBILITY, false, TTR("Toggle Visibility"));
  384. }
  385. const Callable vis_changed = callable_mp(this, &SceneTreeEditor::_node_visibility_changed);
  386. if (!p_node->is_connected(SceneStringName(visibility_changed), vis_changed)) {
  387. p_node->connect(SceneStringName(visibility_changed), vis_changed.bind(p_node));
  388. }
  389. _update_visibility_color(p_node, item);
  390. }
  391. if (p_node->is_class("AnimationMixer")) {
  392. bool is_pinned = AnimationPlayerEditor::get_singleton()->get_editing_node() == p_node && AnimationPlayerEditor::get_singleton()->is_pinned();
  393. if (is_pinned) {
  394. item->add_button(0, get_editor_theme_icon(SNAME("Pin")), BUTTON_PIN, false, TTR("AnimationPlayer is pinned.\nClick to unpin."));
  395. }
  396. }
  397. }
  398. if (editor_selection) {
  399. if (editor_selection->is_selected(p_node)) {
  400. item->select(0);
  401. }
  402. }
  403. if (selected == p_node) {
  404. if (!editor_selection) {
  405. item->select(0);
  406. }
  407. item->set_as_cursor(0);
  408. }
  409. for (int i = 0; i < p_node->get_child_count(); i++) {
  410. _add_nodes(p_node->get_child(i), item);
  411. }
  412. if (valid_types.size()) {
  413. bool valid = false;
  414. for (const StringName &E : valid_types) {
  415. if (p_node->is_class(E) ||
  416. EditorNode::get_singleton()->is_object_of_custom_type(p_node, E)) {
  417. valid = true;
  418. break;
  419. } else {
  420. Ref<Script> node_script = p_node->get_script();
  421. while (node_script.is_valid()) {
  422. if (node_script->get_path() == E) {
  423. valid = true;
  424. break;
  425. }
  426. node_script = node_script->get_base_script();
  427. }
  428. if (valid) {
  429. break;
  430. }
  431. }
  432. }
  433. if (!valid) {
  434. _set_item_custom_color(item, get_theme_color(SNAME("font_disabled_color"), EditorStringName(Editor)));
  435. item->set_selectable(0, false);
  436. }
  437. }
  438. }
  439. void SceneTreeEditor::_queue_update_node_tooltip(Node *p_node, TreeItem *p_item) {
  440. Callable update_tooltip = callable_mp(this, &SceneTreeEditor::_update_node_tooltip);
  441. if (update_node_tooltip_delay->is_connected("timeout", update_tooltip)) {
  442. update_node_tooltip_delay->disconnect("timeout", update_tooltip);
  443. }
  444. update_node_tooltip_delay->connect("timeout", update_tooltip.bind(p_node, p_item));
  445. update_node_tooltip_delay->start();
  446. }
  447. void SceneTreeEditor::_update_node_tooltip(Node *p_node, TreeItem *p_item) {
  448. // Display the node name in all tooltips so that long node names can be previewed
  449. // without having to rename them.
  450. String tooltip = p_node->get_name();
  451. if (p_node == get_scene_node() && p_node->get_scene_inherited_state().is_valid()) {
  452. if (p_item->get_button_by_id(0, BUTTON_SUBSCENE) == -1) {
  453. p_item->add_button(0, get_editor_theme_icon(SNAME("InstanceOptions")), BUTTON_SUBSCENE, false, TTR("Open in Editor"));
  454. }
  455. tooltip += String("\n" + TTR("Inherits:") + " " + p_node->get_scene_inherited_state()->get_path());
  456. } else if (p_node != get_scene_node() && !p_node->get_scene_file_path().is_empty() && can_open_instance) {
  457. if (p_item->get_button_by_id(0, BUTTON_SUBSCENE) == -1) {
  458. p_item->add_button(0, get_editor_theme_icon(SNAME("InstanceOptions")), BUTTON_SUBSCENE, false, TTR("Open in Editor"));
  459. }
  460. tooltip += String("\n" + TTR("Instance:") + " " + p_node->get_scene_file_path());
  461. }
  462. StringName custom_type = EditorNode::get_singleton()->get_object_custom_type_name(p_node);
  463. tooltip += "\n" + TTR("Type:") + " " + (custom_type != StringName() ? String(custom_type) : p_node->get_class());
  464. if (!p_node->get_editor_description().is_empty()) {
  465. const PackedInt32Array boundaries = TS->string_get_word_breaks(p_node->get_editor_description(), "", 80);
  466. tooltip += "\n";
  467. for (int i = 0; i < boundaries.size(); i += 2) {
  468. const int start = boundaries[i];
  469. const int end = boundaries[i + 1];
  470. tooltip += "\n" + p_node->get_editor_description().substr(start, end - start + 1).rstrip("\n");
  471. }
  472. }
  473. p_item->set_tooltip_text(0, tooltip);
  474. }
  475. void SceneTreeEditor::_node_visibility_changed(Node *p_node) {
  476. if (!p_node || (p_node != get_scene_node() && !p_node->get_owner())) {
  477. return;
  478. }
  479. TreeItem *item = _find(tree->get_root(), p_node->get_path());
  480. if (!item) {
  481. return;
  482. }
  483. int idx = item->get_button_by_id(0, BUTTON_VISIBILITY);
  484. ERR_FAIL_COND(idx == -1);
  485. bool node_visible = false;
  486. if (p_node->has_method("is_visible")) {
  487. node_visible = p_node->call("is_visible");
  488. if (p_node->is_class("CanvasItem") || p_node->is_class("CanvasLayer") || p_node->is_class("Window")) {
  489. CanvasItemEditor::get_singleton()->get_viewport_control()->queue_redraw();
  490. }
  491. }
  492. if (node_visible) {
  493. item->set_button(0, idx, get_editor_theme_icon(SNAME("GuiVisibilityVisible")));
  494. } else {
  495. item->set_button(0, idx, get_editor_theme_icon(SNAME("GuiVisibilityHidden")));
  496. }
  497. _update_visibility_color(p_node, item);
  498. }
  499. void SceneTreeEditor::_update_visibility_color(Node *p_node, TreeItem *p_item) {
  500. if (p_node->has_method("is_visible_in_tree")) {
  501. Color color(1, 1, 1, 1);
  502. bool visible_on_screen = p_node->call("is_visible_in_tree");
  503. if (!visible_on_screen) {
  504. color.a = 0.6;
  505. }
  506. int idx = p_item->get_button_by_id(0, BUTTON_VISIBILITY);
  507. p_item->set_button_color(0, idx, color);
  508. }
  509. }
  510. void SceneTreeEditor::_set_item_custom_color(TreeItem *p_item, Color p_color) {
  511. p_item->set_custom_color(0, p_color);
  512. p_item->set_meta(SNAME("custom_color"), p_color);
  513. }
  514. void SceneTreeEditor::_node_script_changed(Node *p_node) {
  515. if (tree_dirty) {
  516. return;
  517. }
  518. callable_mp(this, &SceneTreeEditor::_update_tree).call_deferred(false);
  519. tree_dirty = true;
  520. }
  521. void SceneTreeEditor::_node_removed(Node *p_node) {
  522. if (EditorNode::get_singleton()->is_exiting()) {
  523. return; //speed up exit
  524. }
  525. if (p_node->is_connected(CoreStringName(script_changed), callable_mp(this, &SceneTreeEditor::_node_script_changed))) {
  526. p_node->disconnect(CoreStringName(script_changed), callable_mp(this, &SceneTreeEditor::_node_script_changed));
  527. }
  528. if (p_node->has_signal(SceneStringName(visibility_changed))) {
  529. if (p_node->is_connected(SceneStringName(visibility_changed), callable_mp(this, &SceneTreeEditor::_node_visibility_changed))) {
  530. p_node->disconnect(SceneStringName(visibility_changed), callable_mp(this, &SceneTreeEditor::_node_visibility_changed));
  531. }
  532. }
  533. if (p_node == selected) {
  534. selected = nullptr;
  535. }
  536. }
  537. void SceneTreeEditor::_node_renamed(Node *p_node) {
  538. if (p_node != get_scene_node() && !get_scene_node()->is_ancestor_of(p_node)) {
  539. return;
  540. }
  541. emit_signal(SNAME("node_renamed"));
  542. if (!tree_dirty) {
  543. callable_mp(this, &SceneTreeEditor::_update_tree).call_deferred(false);
  544. tree_dirty = true;
  545. }
  546. }
  547. void SceneTreeEditor::_update_tree(bool p_scroll_to_selected) {
  548. if (!is_inside_tree()) {
  549. tree_dirty = false;
  550. return;
  551. }
  552. if (tree->is_editing()) {
  553. return;
  554. }
  555. updating_tree = true;
  556. tree->clear();
  557. last_hash = hash_djb2_one_64(0);
  558. if (get_scene_node()) {
  559. _add_nodes(get_scene_node(), nullptr);
  560. _compute_hash(get_scene_node(), last_hash);
  561. }
  562. updating_tree = false;
  563. tree_dirty = false;
  564. if (!filter.strip_edges().is_empty() || !show_all_nodes) {
  565. _update_filter(nullptr, p_scroll_to_selected);
  566. }
  567. }
  568. bool SceneTreeEditor::_update_filter(TreeItem *p_parent, bool p_scroll_to_selected) {
  569. if (!p_parent) {
  570. p_parent = tree->get_root();
  571. filter_term_warning.clear();
  572. }
  573. if (!p_parent) {
  574. // Tree is empty, nothing to do here.
  575. return false;
  576. }
  577. bool keep_for_children = false;
  578. for (TreeItem *child = p_parent->get_first_child(); child; child = child->get_next()) {
  579. // Always keep if at least one of the children are kept.
  580. keep_for_children = _update_filter(child, p_scroll_to_selected) || keep_for_children;
  581. }
  582. // Now find other reasons to keep this Node, too.
  583. PackedStringArray terms = filter.to_lower().split_spaces();
  584. bool keep = _item_matches_all_terms(p_parent, terms);
  585. bool selectable = keep;
  586. if (keep && !valid_types.is_empty()) {
  587. selectable = false;
  588. Node *n = get_node(p_parent->get_metadata(0));
  589. for (const StringName &E : valid_types) {
  590. if (n->is_class(E) ||
  591. EditorNode::get_singleton()->is_object_of_custom_type(n, E)) {
  592. selectable = true;
  593. break;
  594. } else {
  595. Ref<Script> node_script = n->get_script();
  596. while (node_script.is_valid()) {
  597. if (node_script->get_path() == E) {
  598. selectable = true;
  599. break;
  600. }
  601. node_script = node_script->get_base_script();
  602. }
  603. if (selectable) {
  604. break;
  605. }
  606. }
  607. }
  608. }
  609. if (show_all_nodes) {
  610. p_parent->set_visible(keep_for_children || keep);
  611. } else {
  612. // Show only selectable nodes, or parents of selectable.
  613. p_parent->set_visible(keep_for_children || selectable);
  614. }
  615. if (selectable) {
  616. Color custom_color = p_parent->get_meta(SNAME("custom_color"), Color(0, 0, 0, 0));
  617. if (custom_color == Color(0, 0, 0, 0)) {
  618. p_parent->clear_custom_color(0);
  619. } else {
  620. p_parent->set_custom_color(0, custom_color);
  621. }
  622. p_parent->set_selectable(0, true);
  623. } else if (keep_for_children) {
  624. p_parent->set_custom_color(0, get_theme_color(SNAME("font_disabled_color"), EditorStringName(Editor)));
  625. p_parent->set_selectable(0, false);
  626. p_parent->deselect(0);
  627. }
  628. if (editor_selection) {
  629. Node *n = get_node(p_parent->get_metadata(0));
  630. if (selectable) {
  631. if (p_scroll_to_selected && n && editor_selection->is_selected(n)) {
  632. tree->scroll_to_item(p_parent);
  633. }
  634. } else {
  635. if (n && p_parent->is_selected(0)) {
  636. editor_selection->remove_node(n);
  637. p_parent->deselect(0);
  638. }
  639. }
  640. }
  641. return p_parent->is_visible();
  642. }
  643. bool SceneTreeEditor::_item_matches_all_terms(TreeItem *p_item, const PackedStringArray &p_terms) {
  644. if (p_terms.is_empty()) {
  645. return true;
  646. }
  647. for (int i = 0; i < p_terms.size(); i++) {
  648. const String &term = p_terms[i];
  649. // Recognize special filter.
  650. if (term.contains(":") && !term.get_slicec(':', 0).is_empty()) {
  651. String parameter = term.get_slicec(':', 0);
  652. String argument = term.get_slicec(':', 1);
  653. if (parameter == "type" || parameter == "t") {
  654. // Filter by Type.
  655. String type = get_node(p_item->get_metadata(0))->get_class();
  656. bool term_in_inherited_class = false;
  657. // Every Node is a Node, duh!
  658. while (type != "Node") {
  659. if (type.to_lower().contains(argument)) {
  660. term_in_inherited_class = true;
  661. break;
  662. }
  663. type = ClassDB::get_parent_class(type);
  664. }
  665. if (!term_in_inherited_class) {
  666. return false;
  667. }
  668. } else if (parameter == "group" || parameter == "g") {
  669. // Filter by Group.
  670. Node *node = get_node(p_item->get_metadata(0));
  671. if (argument.is_empty()) {
  672. // When argument is empty, match all Nodes belonging to any exposed group.
  673. if (node->get_persistent_group_count() == 0) {
  674. return false;
  675. }
  676. } else {
  677. List<Node::GroupInfo> group_info_list;
  678. node->get_groups(&group_info_list);
  679. bool term_in_groups = false;
  680. for (const Node::GroupInfo &group_info : group_info_list) {
  681. if (!group_info.persistent) {
  682. continue; // Ignore internal groups.
  683. }
  684. if (String(group_info.name).to_lower().contains(argument)) {
  685. term_in_groups = true;
  686. break;
  687. }
  688. }
  689. if (!term_in_groups) {
  690. return false;
  691. }
  692. }
  693. } else if (filter_term_warning.is_empty()) {
  694. filter_term_warning = vformat(TTR("\"%s\" is not a known filter."), parameter);
  695. continue;
  696. }
  697. } else {
  698. // Default.
  699. if (!p_item->get_text(0).to_lower().contains(term)) {
  700. return false;
  701. }
  702. }
  703. }
  704. return true;
  705. }
  706. void SceneTreeEditor::_compute_hash(Node *p_node, uint64_t &hash) {
  707. hash = hash_djb2_one_64(p_node->get_instance_id(), hash);
  708. if (p_node->get_parent()) {
  709. hash = hash_djb2_one_64(p_node->get_parent()->get_instance_id(), hash); //so a reparent still produces a different hash
  710. }
  711. for (int i = 0; i < p_node->get_child_count(); i++) {
  712. _compute_hash(p_node->get_child(i), hash);
  713. }
  714. }
  715. void SceneTreeEditor::_test_update_tree() {
  716. pending_test_update = false;
  717. if (!is_inside_tree()) {
  718. return;
  719. }
  720. if (tree_dirty) {
  721. return; // don't even bother
  722. }
  723. uint64_t hash = hash_djb2_one_64(0);
  724. if (get_scene_node()) {
  725. _compute_hash(get_scene_node(), hash);
  726. }
  727. //test hash
  728. if (hash == last_hash) {
  729. return; // did not change
  730. }
  731. callable_mp(this, &SceneTreeEditor::_update_tree).call_deferred(false);
  732. tree_dirty = true;
  733. }
  734. void SceneTreeEditor::_tree_process_mode_changed() {
  735. callable_mp(this, &SceneTreeEditor::_update_tree).call_deferred(false);
  736. tree_dirty = true;
  737. }
  738. void SceneTreeEditor::_tree_changed() {
  739. if (EditorNode::get_singleton()->is_exiting()) {
  740. return; //speed up exit
  741. }
  742. if (pending_test_update) {
  743. return;
  744. }
  745. if (tree_dirty) {
  746. return;
  747. }
  748. callable_mp(this, &SceneTreeEditor::_test_update_tree).call_deferred();
  749. pending_test_update = true;
  750. }
  751. void SceneTreeEditor::_selected_changed() {
  752. TreeItem *s = tree->get_selected();
  753. ERR_FAIL_NULL(s);
  754. NodePath np = s->get_metadata(0);
  755. Node *n = get_node(np);
  756. if (n == selected) {
  757. return;
  758. }
  759. selected = get_node(np);
  760. blocked++;
  761. emit_signal(SNAME("node_selected"));
  762. blocked--;
  763. }
  764. void SceneTreeEditor::_deselect_items() {
  765. // Clear currently selected items in scene tree dock.
  766. if (editor_selection) {
  767. editor_selection->clear();
  768. emit_signal(SNAME("node_changed"));
  769. }
  770. }
  771. void SceneTreeEditor::_cell_multi_selected(Object *p_object, int p_cell, bool p_selected) {
  772. TreeItem *item = Object::cast_to<TreeItem>(p_object);
  773. ERR_FAIL_NULL(item);
  774. if (!item->is_visible()) {
  775. return;
  776. }
  777. NodePath np = item->get_metadata(0);
  778. Node *n = get_node(np);
  779. if (!n) {
  780. return;
  781. }
  782. if (!editor_selection) {
  783. return;
  784. }
  785. if (p_selected) {
  786. editor_selection->add_node(n);
  787. } else {
  788. editor_selection->remove_node(n);
  789. }
  790. // Emitted "selected" in _selected_changed() when select single node, so select multiple node emit "changed"
  791. if (editor_selection->get_selected_nodes().size() > 1) {
  792. emit_signal(SNAME("node_changed"));
  793. }
  794. }
  795. void SceneTreeEditor::_tree_scroll_to_item(ObjectID p_item_id) {
  796. ERR_FAIL_NULL(tree);
  797. TreeItem *item = Object::cast_to<TreeItem>(ObjectDB::get_instance(p_item_id));
  798. if (item) {
  799. tree->scroll_to_item(item, true);
  800. }
  801. }
  802. void SceneTreeEditor::_notification(int p_what) {
  803. switch (p_what) {
  804. case NOTIFICATION_ENTER_TREE: {
  805. get_tree()->connect("tree_changed", callable_mp(this, &SceneTreeEditor::_tree_changed));
  806. get_tree()->connect("tree_process_mode_changed", callable_mp(this, &SceneTreeEditor::_tree_process_mode_changed));
  807. get_tree()->connect("node_removed", callable_mp(this, &SceneTreeEditor::_node_removed));
  808. get_tree()->connect("node_renamed", callable_mp(this, &SceneTreeEditor::_node_renamed));
  809. get_tree()->connect(SceneStringName(node_configuration_warning_changed), callable_mp(this, &SceneTreeEditor::_warning_changed));
  810. tree->connect("item_collapsed", callable_mp(this, &SceneTreeEditor::_cell_collapsed));
  811. _update_tree();
  812. } break;
  813. case NOTIFICATION_EXIT_TREE: {
  814. get_tree()->disconnect("tree_changed", callable_mp(this, &SceneTreeEditor::_tree_changed));
  815. get_tree()->disconnect("tree_process_mode_changed", callable_mp(this, &SceneTreeEditor::_tree_process_mode_changed));
  816. get_tree()->disconnect("node_removed", callable_mp(this, &SceneTreeEditor::_node_removed));
  817. get_tree()->disconnect("node_renamed", callable_mp(this, &SceneTreeEditor::_node_renamed));
  818. tree->disconnect("item_collapsed", callable_mp(this, &SceneTreeEditor::_cell_collapsed));
  819. get_tree()->disconnect(SceneStringName(node_configuration_warning_changed), callable_mp(this, &SceneTreeEditor::_warning_changed));
  820. } break;
  821. case NOTIFICATION_THEME_CHANGED: {
  822. tree->add_theme_constant_override("icon_max_width", get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor)));
  823. _update_tree();
  824. } break;
  825. case NOTIFICATION_VISIBILITY_CHANGED: {
  826. if (is_visible()) {
  827. TreeItem *item = nullptr;
  828. if (selected) {
  829. // Scroll to selected node.
  830. item = _find(tree->get_root(), selected->get_path());
  831. } else if (marked.size() == 1) {
  832. // Scroll to a single marked node.
  833. Node *marked_node = *marked.begin();
  834. if (marked_node) {
  835. item = _find(tree->get_root(), marked_node->get_path());
  836. }
  837. }
  838. if (item) {
  839. // Must wait until tree is properly sized before scrolling.
  840. ObjectID item_id = item->get_instance_id();
  841. callable_mp(this, &SceneTreeEditor::_tree_scroll_to_item).call_deferred(item_id);
  842. }
  843. }
  844. } break;
  845. }
  846. }
  847. TreeItem *SceneTreeEditor::_find(TreeItem *p_node, const NodePath &p_path) {
  848. if (!p_node) {
  849. return nullptr;
  850. }
  851. NodePath np = p_node->get_metadata(0);
  852. if (np == p_path) {
  853. return p_node;
  854. }
  855. TreeItem *children = p_node->get_first_child();
  856. while (children) {
  857. TreeItem *n = _find(children, p_path);
  858. if (n) {
  859. return n;
  860. }
  861. children = children->get_next();
  862. }
  863. return nullptr;
  864. }
  865. void SceneTreeEditor::set_selected(Node *p_node, bool p_emit_selected) {
  866. ERR_FAIL_COND(blocked > 0);
  867. if (pending_test_update) {
  868. _test_update_tree();
  869. }
  870. if (tree_dirty) {
  871. _update_tree();
  872. }
  873. if (selected == p_node) {
  874. return;
  875. }
  876. TreeItem *item = p_node ? _find(tree->get_root(), p_node->get_path()) : nullptr;
  877. if (item) {
  878. selected = p_node;
  879. if (auto_expand_selected) {
  880. // Make visible when it's collapsed.
  881. TreeItem *node = item->get_parent();
  882. while (node && node != tree->get_root()) {
  883. node->set_collapsed(false);
  884. node = node->get_parent();
  885. }
  886. item->select(0);
  887. item->set_as_cursor(0);
  888. tree->ensure_cursor_is_visible();
  889. } else {
  890. // Ensure the node is selected and visible for the user if the node
  891. // is not collapsed.
  892. bool collapsed = false;
  893. TreeItem *node = item;
  894. while (node && node != tree->get_root()) {
  895. if (node->is_collapsed()) {
  896. collapsed = true;
  897. break;
  898. }
  899. node = node->get_parent();
  900. }
  901. if (!collapsed) {
  902. item->select(0);
  903. item->set_as_cursor(0);
  904. tree->ensure_cursor_is_visible();
  905. }
  906. }
  907. } else {
  908. if (!p_node) {
  909. selected = nullptr;
  910. }
  911. selected = p_node;
  912. }
  913. if (p_emit_selected) {
  914. emit_signal(SNAME("node_selected"));
  915. }
  916. }
  917. void SceneTreeEditor::rename_node(Node *p_node, const String &p_name, TreeItem *p_item) {
  918. TreeItem *item;
  919. if (p_item) {
  920. item = p_item; // During batch rename the paths may change, so using _find() is unreliable.
  921. } else {
  922. item = _find(tree->get_root(), p_node->get_path());
  923. }
  924. ERR_FAIL_NULL(item);
  925. String new_name = p_name.validate_node_name();
  926. if (new_name != p_name) {
  927. String text = TTR("Invalid node name, the following characters are not allowed:") + "\n" + String::get_invalid_node_name_characters();
  928. if (error->is_visible()) {
  929. if (!error->get_meta("invalid_character", false)) {
  930. error->set_text(error->get_text() + "\n\n" + text);
  931. error->set_meta("invalid_character", true);
  932. }
  933. } else {
  934. error->set_text(text);
  935. error->set_meta("invalid_character", true);
  936. error->set_meta("same_unique_name", false);
  937. error->popup_centered();
  938. }
  939. }
  940. // 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()`.
  941. new_name = new_name.strip_edges();
  942. if (new_name.is_empty() && p_node->get_owner() != nullptr && !p_node->get_scene_file_path().is_empty()) {
  943. // If name is empty and node is root of an instance, revert to the original name.
  944. const Ref<PackedScene> node_scene = ResourceLoader::load(p_node->get_scene_file_path());
  945. if (node_scene.is_valid()) {
  946. const Ref<SceneState> &state = node_scene->get_state();
  947. if (state->get_node_count() > 0) {
  948. new_name = state->get_node_name(0); // Root's name.
  949. }
  950. }
  951. }
  952. if (new_name.is_empty()) {
  953. // If name is still empty, fallback to class name.
  954. if (GLOBAL_GET("editor/naming/node_name_casing").operator int() != NAME_CASING_PASCAL_CASE) {
  955. new_name = Node::adjust_name_casing(p_node->get_class());
  956. } else {
  957. new_name = p_node->get_class();
  958. }
  959. }
  960. new_name = p_node->get_parent()->prevalidate_child_name(p_node, new_name);
  961. if (new_name == p_node->get_name()) {
  962. item->set_text(0, new_name);
  963. return;
  964. }
  965. // We previously made sure name is not the same as current name so that it won't complain about already used unique name when not changing name.
  966. if (p_node->is_unique_name_in_owner() && get_tree()->get_edited_scene_root()->get_node_or_null("%" + new_name)) {
  967. String text = vformat(TTR("A node with the unique name %s already exists in this scene."), new_name);
  968. if (error->is_visible()) {
  969. if (!error->get_meta("same_unique_name", false)) {
  970. error->set_text(error->get_text() + "\n\n" + text);
  971. error->set_meta("same_unique_name", true);
  972. }
  973. } else {
  974. error->set_text(text);
  975. error->set_meta("same_unique_name", true);
  976. error->set_meta("invalid_character", false);
  977. error->popup_centered();
  978. }
  979. item->set_text(0, p_node->get_name());
  980. return;
  981. }
  982. if (!is_scene_tree_dock) {
  983. p_node->set_name(new_name);
  984. item->set_metadata(0, p_node->get_path());
  985. emit_signal(SNAME("node_renamed"));
  986. } else {
  987. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  988. undo_redo->create_action(TTR("Rename Node"), UndoRedo::MERGE_DISABLE, p_node);
  989. emit_signal(SNAME("node_prerename"), p_node, new_name);
  990. undo_redo->add_undo_method(p_node, "set_name", p_node->get_name());
  991. undo_redo->add_undo_method(item, "set_metadata", 0, p_node->get_path());
  992. undo_redo->add_undo_method(item, "set_text", 0, p_node->get_name());
  993. p_node->set_name(new_name);
  994. undo_redo->add_do_method(p_node, "set_name", new_name);
  995. undo_redo->add_do_method(item, "set_metadata", 0, p_node->get_path());
  996. undo_redo->add_do_method(item, "set_text", 0, new_name);
  997. undo_redo->commit_action();
  998. }
  999. }
  1000. void SceneTreeEditor::_edited() {
  1001. TreeItem *which = tree->get_next_selected(nullptr);
  1002. ERR_FAIL_NULL(which);
  1003. TreeItem *edited = tree->get_edited();
  1004. ERR_FAIL_NULL(edited);
  1005. if (is_scene_tree_dock && tree->get_next_selected(which)) {
  1006. List<Node *> nodes_to_rename;
  1007. for (TreeItem *item = which; item; item = tree->get_next_selected(item)) {
  1008. Node *n = get_node(item->get_metadata(0));
  1009. ERR_FAIL_NULL(n);
  1010. nodes_to_rename.push_back(n);
  1011. }
  1012. ERR_FAIL_COND(nodes_to_rename.is_empty());
  1013. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  1014. undo_redo->create_action(TTR("Rename Nodes"), UndoRedo::MERGE_DISABLE, nodes_to_rename.front()->get(), true);
  1015. TreeItem *item = which;
  1016. String new_name = edited->get_text(0);
  1017. for (Node *n : nodes_to_rename) {
  1018. rename_node(n, new_name, item);
  1019. item = tree->get_next_selected(item);
  1020. }
  1021. undo_redo->commit_action();
  1022. } else {
  1023. Node *n = get_node(which->get_metadata(0));
  1024. ERR_FAIL_NULL(n);
  1025. rename_node(n, which->get_text(0));
  1026. }
  1027. }
  1028. Node *SceneTreeEditor::get_selected() {
  1029. return selected;
  1030. }
  1031. void SceneTreeEditor::set_marked(const HashSet<Node *> &p_marked, bool p_selectable, bool p_children_selectable) {
  1032. if (tree_dirty) {
  1033. _update_tree();
  1034. }
  1035. marked = p_marked;
  1036. marked_selectable = p_selectable;
  1037. marked_children_selectable = p_children_selectable;
  1038. _update_tree();
  1039. }
  1040. void SceneTreeEditor::set_marked(Node *p_marked, bool p_selectable, bool p_children_selectable) {
  1041. HashSet<Node *> s;
  1042. if (p_marked) {
  1043. s.insert(p_marked);
  1044. }
  1045. set_marked(s, p_selectable, p_children_selectable);
  1046. }
  1047. void SceneTreeEditor::set_filter(const String &p_filter) {
  1048. filter = p_filter;
  1049. _update_filter(nullptr, true);
  1050. }
  1051. String SceneTreeEditor::get_filter() const {
  1052. return filter;
  1053. }
  1054. String SceneTreeEditor::get_filter_term_warning() {
  1055. return filter_term_warning;
  1056. }
  1057. void SceneTreeEditor::set_show_all_nodes(bool p_show_all_nodes) {
  1058. show_all_nodes = p_show_all_nodes;
  1059. _update_filter(nullptr, true);
  1060. }
  1061. void SceneTreeEditor::set_as_scene_tree_dock() {
  1062. is_scene_tree_dock = true;
  1063. }
  1064. void SceneTreeEditor::set_display_foreign_nodes(bool p_display) {
  1065. display_foreign = p_display;
  1066. _update_tree();
  1067. }
  1068. void SceneTreeEditor::set_valid_types(const Vector<StringName> &p_valid) {
  1069. valid_types = p_valid;
  1070. }
  1071. void SceneTreeEditor::set_editor_selection(EditorSelection *p_selection) {
  1072. editor_selection = p_selection;
  1073. tree->set_select_mode(Tree::SELECT_MULTI);
  1074. tree->set_cursor_can_exit_tree(false);
  1075. editor_selection->connect("selection_changed", callable_mp(this, &SceneTreeEditor::_selection_changed));
  1076. }
  1077. void SceneTreeEditor::_update_selection(TreeItem *item) {
  1078. ERR_FAIL_NULL(item);
  1079. NodePath np = item->get_metadata(0);
  1080. if (!has_node(np)) {
  1081. return;
  1082. }
  1083. Node *n = get_node(np);
  1084. if (!n) {
  1085. return;
  1086. }
  1087. if (editor_selection->is_selected(n)) {
  1088. if (!item->is_selected(0)) {
  1089. item->select(0);
  1090. }
  1091. } else {
  1092. if (item->is_selected(0)) {
  1093. TreeItem *previous_cursor_item = tree->get_selected();
  1094. item->deselect(0);
  1095. previous_cursor_item->set_as_cursor(0);
  1096. }
  1097. }
  1098. TreeItem *c = item->get_first_child();
  1099. while (c) {
  1100. _update_selection(c);
  1101. c = c->get_next();
  1102. }
  1103. }
  1104. void SceneTreeEditor::_selection_changed() {
  1105. if (!editor_selection) {
  1106. return;
  1107. }
  1108. TreeItem *root = tree->get_root();
  1109. if (!root) {
  1110. return;
  1111. }
  1112. _update_selection(root);
  1113. }
  1114. void SceneTreeEditor::_cell_collapsed(Object *p_obj) {
  1115. if (updating_tree) {
  1116. return;
  1117. }
  1118. if (!can_rename) {
  1119. return;
  1120. }
  1121. TreeItem *ti = Object::cast_to<TreeItem>(p_obj);
  1122. if (!ti) {
  1123. return;
  1124. }
  1125. bool collapsed = ti->is_collapsed();
  1126. NodePath np = ti->get_metadata(0);
  1127. Node *n = get_node(np);
  1128. ERR_FAIL_NULL(n);
  1129. n->set_display_folded(collapsed);
  1130. }
  1131. Variant SceneTreeEditor::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  1132. if (!can_rename) {
  1133. return Variant(); //not editable tree
  1134. }
  1135. if (tree->get_button_id_at_position(p_point) != -1) {
  1136. return Variant(); //dragging from button
  1137. }
  1138. Vector<Node *> selected_nodes;
  1139. Vector<Ref<Texture2D>> icons;
  1140. TreeItem *next = tree->get_next_selected(nullptr);
  1141. while (next) {
  1142. NodePath np = next->get_metadata(0);
  1143. Node *n = get_node(np);
  1144. if (n) {
  1145. selected_nodes.push_back(n);
  1146. icons.push_back(next->get_icon(0));
  1147. }
  1148. next = tree->get_next_selected(next);
  1149. }
  1150. if (selected_nodes.is_empty()) {
  1151. return Variant();
  1152. }
  1153. VBoxContainer *vb = memnew(VBoxContainer);
  1154. Array objs;
  1155. int list_max = 10;
  1156. float opacity_step = 1.0f / list_max;
  1157. float opacity_item = 1.0f;
  1158. for (int i = 0; i < selected_nodes.size(); i++) {
  1159. if (i < list_max) {
  1160. HBoxContainer *hb = memnew(HBoxContainer);
  1161. TextureRect *tf = memnew(TextureRect);
  1162. int icon_size = get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor));
  1163. tf->set_custom_minimum_size(Size2(icon_size, icon_size));
  1164. tf->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED);
  1165. tf->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
  1166. tf->set_texture(icons[i]);
  1167. hb->add_child(tf);
  1168. Label *label = memnew(Label(selected_nodes[i]->get_name()));
  1169. label->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  1170. hb->add_child(label);
  1171. vb->add_child(hb);
  1172. hb->set_modulate(Color(1, 1, 1, opacity_item));
  1173. opacity_item -= opacity_step;
  1174. }
  1175. NodePath p = selected_nodes[i]->get_path();
  1176. objs.push_back(p);
  1177. }
  1178. set_drag_preview(vb);
  1179. Dictionary drag_data;
  1180. drag_data["type"] = "nodes";
  1181. drag_data["nodes"] = objs;
  1182. tree->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN | Tree::DROP_MODE_ON_ITEM);
  1183. emit_signal(SNAME("nodes_dragged"));
  1184. return drag_data;
  1185. }
  1186. bool SceneTreeEditor::_is_script_type(const StringName &p_type) const {
  1187. return (script_types->find(p_type));
  1188. }
  1189. bool SceneTreeEditor::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  1190. if (!can_rename) {
  1191. return false; //not editable tree
  1192. }
  1193. Dictionary d = p_data;
  1194. if (!d.has("type")) {
  1195. return false;
  1196. }
  1197. TreeItem *item = tree->get_item_at_position(p_point);
  1198. if (!item) {
  1199. return false;
  1200. }
  1201. int section = tree->get_drop_section_at_position(p_point);
  1202. if (section < -1 || (section == -1 && !item->get_parent())) {
  1203. return false;
  1204. }
  1205. if (String(d["type"]) == "files") {
  1206. Vector<String> files = d["files"];
  1207. if (files.size() == 0) {
  1208. return false; //weird
  1209. }
  1210. if (_is_script_type(EditorFileSystem::get_singleton()->get_file_type(files[0]))) {
  1211. tree->set_drop_mode_flags(Tree::DROP_MODE_ON_ITEM);
  1212. return true;
  1213. }
  1214. bool scene_drop = true;
  1215. bool audio_drop = true;
  1216. for (int i = 0; i < files.size(); i++) {
  1217. String ftype = EditorFileSystem::get_singleton()->get_file_type(files[i]);
  1218. if (ftype != "PackedScene") {
  1219. scene_drop = false;
  1220. }
  1221. if (audio_drop && !ClassDB::is_parent_class(ftype, "AudioStream")) {
  1222. audio_drop = false;
  1223. }
  1224. }
  1225. if (scene_drop) {
  1226. tree->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN | Tree::DROP_MODE_ON_ITEM);
  1227. return true;
  1228. }
  1229. if (audio_drop) {
  1230. if (files.size() > 1) {
  1231. tree->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN);
  1232. } else {
  1233. tree->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN | Tree::DROP_MODE_ON_ITEM);
  1234. }
  1235. return true;
  1236. }
  1237. if (files.size() > 1) {
  1238. return false;
  1239. }
  1240. tree->set_drop_mode_flags(Tree::DROP_MODE_ON_ITEM);
  1241. return true;
  1242. }
  1243. if (String(d["type"]) == "script_list_element") {
  1244. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(d["script_list_element"]);
  1245. if (se) {
  1246. String sp = se->get_edited_resource()->get_path();
  1247. if (_is_script_type(EditorFileSystem::get_singleton()->get_file_type(sp))) {
  1248. tree->set_drop_mode_flags(Tree::DROP_MODE_ON_ITEM);
  1249. return true;
  1250. }
  1251. }
  1252. }
  1253. if (filter.is_empty() && String(d["type"]) == "nodes") {
  1254. Array nodes = d["nodes"];
  1255. for (int i = 0; i < nodes.size(); i++) {
  1256. Node *n = get_node(nodes[i]);
  1257. // Nodes from an instantiated scene can't be rearranged.
  1258. if (n && n->get_owner() && n->get_owner() != get_scene_node() && !n->get_owner()->get_scene_file_path().is_empty()) {
  1259. return false;
  1260. }
  1261. }
  1262. return true;
  1263. }
  1264. return false;
  1265. }
  1266. void SceneTreeEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  1267. if (!can_drop_data_fw(p_point, p_data, p_from)) {
  1268. return;
  1269. }
  1270. TreeItem *item = tree->get_item_at_position(p_point);
  1271. if (!item) {
  1272. return;
  1273. }
  1274. int section = tree->get_drop_section_at_position(p_point);
  1275. if (section < -1) {
  1276. return;
  1277. }
  1278. NodePath np = item->get_metadata(0);
  1279. Node *n = get_node(np);
  1280. if (!n) {
  1281. return;
  1282. }
  1283. Dictionary d = p_data;
  1284. if (String(d["type"]) == "nodes") {
  1285. Array nodes = d["nodes"];
  1286. emit_signal(SNAME("nodes_rearranged"), nodes, np, section);
  1287. }
  1288. if (String(d["type"]) == "files") {
  1289. Vector<String> files = d["files"];
  1290. String ftype = EditorFileSystem::get_singleton()->get_file_type(files[0]);
  1291. if (_is_script_type(ftype)) {
  1292. emit_signal(SNAME("script_dropped"), files[0], np);
  1293. } else {
  1294. emit_signal(SNAME("files_dropped"), files, np, section);
  1295. }
  1296. }
  1297. if (String(d["type"]) == "script_list_element") {
  1298. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(d["script_list_element"]);
  1299. if (se) {
  1300. String sp = se->get_edited_resource()->get_path();
  1301. if (_is_script_type(EditorFileSystem::get_singleton()->get_file_type(sp))) {
  1302. emit_signal(SNAME("script_dropped"), sp, np);
  1303. }
  1304. }
  1305. }
  1306. }
  1307. void SceneTreeEditor::_empty_clicked(const Vector2 &p_pos, MouseButton p_button) {
  1308. if (p_button != MouseButton::RIGHT) {
  1309. return;
  1310. }
  1311. _rmb_select(p_pos);
  1312. }
  1313. void SceneTreeEditor::_rmb_select(const Vector2 &p_pos, MouseButton p_button) {
  1314. if (p_button != MouseButton::RIGHT) {
  1315. return;
  1316. }
  1317. emit_signal(SNAME("rmb_pressed"), tree->get_screen_position() + p_pos);
  1318. }
  1319. void SceneTreeEditor::update_warning() {
  1320. _warning_changed(nullptr);
  1321. }
  1322. void SceneTreeEditor::_warning_changed(Node *p_for_node) {
  1323. //should use a timer
  1324. update_timer->start();
  1325. }
  1326. void SceneTreeEditor::set_auto_expand_selected(bool p_auto, bool p_update_settings) {
  1327. if (p_update_settings) {
  1328. EditorSettings::get_singleton()->set("docks/scene_tree/auto_expand_to_selected", p_auto);
  1329. }
  1330. auto_expand_selected = p_auto;
  1331. }
  1332. void SceneTreeEditor::set_connect_to_script_mode(bool p_enable) {
  1333. connect_to_script_mode = p_enable;
  1334. update_tree();
  1335. }
  1336. void SceneTreeEditor::set_connecting_signal(bool p_enable) {
  1337. connecting_signal = p_enable;
  1338. update_tree();
  1339. }
  1340. void SceneTreeEditor::_bind_methods() {
  1341. ClassDB::bind_method(D_METHOD("_update_tree"), &SceneTreeEditor::_update_tree, DEFVAL(false)); // Still used by UndoRedo.
  1342. ClassDB::bind_method(D_METHOD("update_tree"), &SceneTreeEditor::update_tree);
  1343. ADD_SIGNAL(MethodInfo("node_selected"));
  1344. ADD_SIGNAL(MethodInfo("node_renamed"));
  1345. ADD_SIGNAL(MethodInfo("node_prerename"));
  1346. ADD_SIGNAL(MethodInfo("node_changed"));
  1347. ADD_SIGNAL(MethodInfo("nodes_dragged"));
  1348. ADD_SIGNAL(MethodInfo("nodes_rearranged", PropertyInfo(Variant::ARRAY, "paths"), PropertyInfo(Variant::NODE_PATH, "to_path"), PropertyInfo(Variant::INT, "type")));
  1349. ADD_SIGNAL(MethodInfo("files_dropped", PropertyInfo(Variant::PACKED_STRING_ARRAY, "files"), PropertyInfo(Variant::NODE_PATH, "to_path"), PropertyInfo(Variant::INT, "type")));
  1350. ADD_SIGNAL(MethodInfo("script_dropped", PropertyInfo(Variant::STRING, "file"), PropertyInfo(Variant::NODE_PATH, "to_path")));
  1351. ADD_SIGNAL(MethodInfo("rmb_pressed", PropertyInfo(Variant::VECTOR2, "position")));
  1352. ADD_SIGNAL(MethodInfo("open"));
  1353. ADD_SIGNAL(MethodInfo("open_script"));
  1354. }
  1355. SceneTreeEditor::SceneTreeEditor(bool p_label, bool p_can_rename, bool p_can_open_instance) {
  1356. selected = nullptr;
  1357. can_rename = p_can_rename;
  1358. can_open_instance = p_can_open_instance;
  1359. editor_selection = nullptr;
  1360. if (p_label) {
  1361. Label *label = memnew(Label);
  1362. label->set_theme_type_variation("HeaderSmall");
  1363. label->set_position(Point2(10, 0));
  1364. label->set_text(TTR("Scene Tree (Nodes):"));
  1365. add_child(label);
  1366. }
  1367. tree = memnew(Tree);
  1368. tree->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  1369. tree->set_anchor(SIDE_RIGHT, ANCHOR_END);
  1370. tree->set_anchor(SIDE_BOTTOM, ANCHOR_END);
  1371. tree->set_begin(Point2(0, p_label ? 18 : 0));
  1372. tree->set_end(Point2(0, 0));
  1373. tree->set_allow_reselect(true);
  1374. tree->add_theme_constant_override("button_margin", 0);
  1375. add_child(tree);
  1376. SET_DRAG_FORWARDING_GCD(tree, SceneTreeEditor);
  1377. if (p_can_rename) {
  1378. tree->set_allow_rmb_select(true);
  1379. tree->connect("item_mouse_selected", callable_mp(this, &SceneTreeEditor::_rmb_select));
  1380. tree->connect("empty_clicked", callable_mp(this, &SceneTreeEditor::_empty_clicked));
  1381. }
  1382. tree->connect("cell_selected", callable_mp(this, &SceneTreeEditor::_selected_changed));
  1383. tree->connect("item_edited", callable_mp(this, &SceneTreeEditor::_edited));
  1384. tree->connect("multi_selected", callable_mp(this, &SceneTreeEditor::_cell_multi_selected));
  1385. tree->connect("button_clicked", callable_mp(this, &SceneTreeEditor::_cell_button_pressed));
  1386. tree->connect("nothing_selected", callable_mp(this, &SceneTreeEditor::_deselect_items));
  1387. error = memnew(AcceptDialog);
  1388. add_child(error);
  1389. warning = memnew(AcceptDialog);
  1390. add_child(warning);
  1391. warning->set_title(TTR("Node Configuration Warning!"));
  1392. warning->set_flag(Window::FLAG_POPUP, true);
  1393. last_hash = 0;
  1394. blocked = 0;
  1395. update_timer = memnew(Timer);
  1396. update_timer->connect("timeout", callable_mp(this, &SceneTreeEditor::_update_tree).bind(false));
  1397. update_timer->set_one_shot(true);
  1398. update_timer->set_wait_time(0.5);
  1399. add_child(update_timer);
  1400. update_node_tooltip_delay = memnew(Timer);
  1401. update_node_tooltip_delay->set_wait_time(0.5);
  1402. update_node_tooltip_delay->set_one_shot(true);
  1403. add_child(update_node_tooltip_delay);
  1404. revoke_dialog = memnew(ConfirmationDialog);
  1405. revoke_dialog->set_ok_button_text(TTR("Revoke"));
  1406. add_child(revoke_dialog);
  1407. revoke_dialog->connect(SceneStringName(confirmed), callable_mp(this, &SceneTreeEditor::_update_ask_before_revoking_unique_name));
  1408. VBoxContainer *vb = memnew(VBoxContainer);
  1409. revoke_dialog->add_child(vb);
  1410. revoke_dialog_label = memnew(Label);
  1411. vb->add_child(revoke_dialog_label);
  1412. ask_before_revoke_checkbox = memnew(CheckBox(TTR("Don't Ask Again")));
  1413. ask_before_revoke_checkbox->set_tooltip_text(TTR("This dialog can also be enabled/disabled in the Editor Settings: Docks > Scene Tree > Ask Before Revoking Unique Name."));
  1414. vb->add_child(ask_before_revoke_checkbox);
  1415. script_types = memnew(List<StringName>);
  1416. ClassDB::get_inheriters_from_class("Script", script_types);
  1417. }
  1418. SceneTreeEditor::~SceneTreeEditor() {
  1419. memdelete(script_types);
  1420. }
  1421. /******** DIALOG *********/
  1422. void SceneTreeDialog::popup_scenetree_dialog(Node *p_selected_node, Node *p_marked_node, bool p_marked_node_selectable, bool p_marked_node_children_selectable) {
  1423. get_scene_tree()->set_marked(p_marked_node, p_marked_node_selectable, p_marked_node_children_selectable);
  1424. get_scene_tree()->set_selected(p_selected_node);
  1425. popup_centered_clamped(Size2(350, 700) * EDSCALE);
  1426. }
  1427. void SceneTreeDialog::_show_all_nodes_changed(bool p_button_pressed) {
  1428. EditorSettings::get_singleton()->set_project_metadata("editor_metadata", "show_all_nodes_for_node_selection", p_button_pressed);
  1429. tree->set_show_all_nodes(p_button_pressed);
  1430. }
  1431. void SceneTreeDialog::set_valid_types(const Vector<StringName> &p_valid) {
  1432. if (allowed_types_hbox) {
  1433. allowed_types_hbox->queue_free();
  1434. allowed_types_hbox = nullptr;
  1435. valid_type_icons.clear();
  1436. }
  1437. tree->set_valid_types(p_valid);
  1438. if (p_valid.is_empty()) {
  1439. return;
  1440. }
  1441. allowed_types_hbox = memnew(HBoxContainer);
  1442. content->add_child(allowed_types_hbox);
  1443. content->move_child(allowed_types_hbox, 0);
  1444. {
  1445. Label *label = memnew(Label);
  1446. allowed_types_hbox->add_child(label);
  1447. label->set_text(TTR("Allowed:"));
  1448. }
  1449. HFlowContainer *hflow = memnew(HFlowContainer);
  1450. allowed_types_hbox->add_child(hflow);
  1451. hflow->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  1452. for (const StringName &type : p_valid) {
  1453. HBoxContainer *hb = memnew(HBoxContainer);
  1454. hflow->add_child(hb);
  1455. // Attempt to get the correct name and icon for script path types.
  1456. String name = type;
  1457. Ref<Texture2D> icon = EditorNode::get_singleton()->get_class_icon(type);
  1458. // If we can't find a global class icon, try to find one for the script.
  1459. if (icon.is_null() && ResourceLoader::exists(type, "Script")) {
  1460. Ref<Script> node_script = ResourceLoader::load(type);
  1461. if (node_script.is_valid()) {
  1462. name = name.get_file();
  1463. icon = EditorNode::get_singleton()->get_object_icon(node_script.ptr());
  1464. }
  1465. }
  1466. TextureRect *trect = memnew(TextureRect);
  1467. hb->add_child(trect);
  1468. trect->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE);
  1469. trect->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED);
  1470. trect->set_meta("icon", icon);
  1471. valid_type_icons.push_back(trect);
  1472. Label *label = memnew(Label);
  1473. hb->add_child(label);
  1474. label->set_text(name);
  1475. label->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  1476. }
  1477. show_all_nodes->show();
  1478. if (is_inside_tree()) {
  1479. _update_valid_type_icons();
  1480. }
  1481. }
  1482. void SceneTreeDialog::_notification(int p_what) {
  1483. switch (p_what) {
  1484. case NOTIFICATION_VISIBILITY_CHANGED: {
  1485. if (is_visible()) {
  1486. tree->update_tree();
  1487. // Select the search bar by default.
  1488. callable_mp((Control *)filter, &Control::grab_focus).call_deferred();
  1489. }
  1490. } break;
  1491. case NOTIFICATION_ENTER_TREE: {
  1492. connect(SceneStringName(confirmed), callable_mp(this, &SceneTreeDialog::_select));
  1493. } break;
  1494. case NOTIFICATION_THEME_CHANGED: {
  1495. _update_valid_type_icons();
  1496. } break;
  1497. case NOTIFICATION_EXIT_TREE: {
  1498. disconnect(SceneStringName(confirmed), callable_mp(this, &SceneTreeDialog::_select));
  1499. } break;
  1500. }
  1501. }
  1502. void SceneTreeDialog::_update_valid_type_icons() {
  1503. filter->set_right_icon(get_editor_theme_icon(SNAME("Search")));
  1504. for (TextureRect *trect : valid_type_icons) {
  1505. trect->set_custom_minimum_size(Vector2(get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor)), 0));
  1506. trect->set_texture(trect->get_meta("icon"));
  1507. }
  1508. }
  1509. void SceneTreeDialog::_cancel() {
  1510. hide();
  1511. }
  1512. void SceneTreeDialog::_select() {
  1513. if (tree->get_selected()) {
  1514. // The signal may cause another dialog to be displayed, so be sure to hide this one first.
  1515. hide();
  1516. emit_signal(SNAME("selected"), tree->get_selected()->get_path());
  1517. }
  1518. }
  1519. void SceneTreeDialog::_selected_changed() {
  1520. get_ok_button()->set_disabled(!tree->get_selected());
  1521. }
  1522. void SceneTreeDialog::_filter_changed(const String &p_filter) {
  1523. tree->set_filter(p_filter);
  1524. }
  1525. void SceneTreeDialog::_on_filter_gui_input(const Ref<InputEvent> &p_event) {
  1526. // Redirect navigational key events to the tree.
  1527. Ref<InputEventKey> key = p_event;
  1528. if (key.is_valid()) {
  1529. if (key->is_action("ui_up", true) || key->is_action("ui_down", true) || key->is_action("ui_page_up") || key->is_action("ui_page_down")) {
  1530. tree->get_scene_tree()->gui_input(key);
  1531. filter->accept_event();
  1532. }
  1533. }
  1534. }
  1535. void SceneTreeDialog::_bind_methods() {
  1536. ClassDB::bind_method("_cancel", &SceneTreeDialog::_cancel);
  1537. ADD_SIGNAL(MethodInfo("selected", PropertyInfo(Variant::NODE_PATH, "path")));
  1538. }
  1539. SceneTreeDialog::SceneTreeDialog() {
  1540. set_title(TTR("Select a Node"));
  1541. content = memnew(VBoxContainer);
  1542. add_child(content);
  1543. HBoxContainer *filter_hbc = memnew(HBoxContainer);
  1544. content->add_child(filter_hbc);
  1545. filter = memnew(LineEdit);
  1546. filter->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  1547. filter->set_placeholder(TTR("Filter Nodes"));
  1548. filter->set_clear_button_enabled(true);
  1549. filter->add_theme_constant_override("minimum_character_width", 0);
  1550. filter->connect(SceneStringName(text_changed), callable_mp(this, &SceneTreeDialog::_filter_changed));
  1551. filter->connect(SceneStringName(gui_input), callable_mp(this, &SceneTreeDialog::_on_filter_gui_input));
  1552. register_text_enter(filter);
  1553. filter_hbc->add_child(filter);
  1554. // Add 'Show All' button to HBoxContainer next to the filter, visible only when valid_types is defined.
  1555. show_all_nodes = memnew(CheckButton);
  1556. show_all_nodes->set_text(TTR("Show All"));
  1557. show_all_nodes->connect(SceneStringName(toggled), callable_mp(this, &SceneTreeDialog::_show_all_nodes_changed));
  1558. show_all_nodes->set_h_size_flags(Control::SIZE_SHRINK_BEGIN);
  1559. show_all_nodes->hide();
  1560. filter_hbc->add_child(show_all_nodes);
  1561. tree = memnew(SceneTreeEditor(false, false, true));
  1562. tree->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  1563. tree->get_scene_tree()->connect("item_activated", callable_mp(this, &SceneTreeDialog::_select));
  1564. // Initialize button state, must be done after the tree has been created to update its 'show_all_nodes' flag.
  1565. // This is also done before adding the tree to the content to avoid triggering unnecessary tree filtering.
  1566. show_all_nodes->set_pressed(EditorSettings::get_singleton()->get_project_metadata("editor_metadata", "show_all_nodes_for_node_selection", false));
  1567. content->add_child(tree);
  1568. // Disable the OK button when no node is selected.
  1569. get_ok_button()->set_disabled(!tree->get_selected());
  1570. tree->connect("node_selected", callable_mp(this, &SceneTreeDialog::_selected_changed));
  1571. }
  1572. SceneTreeDialog::~SceneTreeDialog() {
  1573. }