scene_tree_editor.cpp 47 KB

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