scene_tree_editor.cpp 58 KB

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