scene_tree_editor.cpp 52 KB

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