create_dialog.cpp 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858
  1. /**************************************************************************/
  2. /* create_dialog.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 "create_dialog.h"
  31. #include "core/object/class_db.h"
  32. #include "editor/editor_feature_profile.h"
  33. #include "editor/editor_node.h"
  34. #include "editor/editor_paths.h"
  35. #include "editor/editor_settings.h"
  36. #include "editor/editor_string_names.h"
  37. #include "editor/themes/editor_scale.h"
  38. void CreateDialog::popup_create(bool p_dont_clear, bool p_replace_mode, const String &p_current_type, const String &p_current_name) {
  39. _fill_type_list();
  40. icon_fallback = search_options->has_theme_icon(base_type, EditorStringName(EditorIcons)) ? base_type : "Object";
  41. if (p_dont_clear) {
  42. search_box->select_all();
  43. } else {
  44. search_box->clear();
  45. }
  46. if (p_replace_mode) {
  47. search_box->set_text(p_current_type);
  48. }
  49. search_box->grab_focus();
  50. _update_search();
  51. if (p_replace_mode) {
  52. set_title(vformat(TTR("Change Type of \"%s\""), p_current_name));
  53. set_ok_button_text(TTR("Change"));
  54. } else {
  55. set_title(vformat(TTR("Create New %s"), base_type));
  56. set_ok_button_text(TTR("Create"));
  57. }
  58. _load_favorites_and_history();
  59. _save_and_update_favorite_list();
  60. // Restore valid window bounds or pop up at default size.
  61. Rect2 saved_size = EditorSettings::get_singleton()->get_project_metadata("dialog_bounds", "create_new_node", Rect2());
  62. if (saved_size != Rect2()) {
  63. popup(saved_size);
  64. } else {
  65. popup_centered_clamped(Size2(900, 700) * EDSCALE, 0.8);
  66. }
  67. }
  68. void CreateDialog::_fill_type_list() {
  69. List<StringName> complete_type_list;
  70. ClassDB::get_class_list(&complete_type_list);
  71. ScriptServer::get_global_class_list(&complete_type_list);
  72. EditorData &ed = EditorNode::get_editor_data();
  73. for (List<StringName>::Element *I = complete_type_list.front(); I; I = I->next()) {
  74. StringName type = I->get();
  75. if (!_should_hide_type(type)) {
  76. type_list.push_back(type);
  77. if (!ed.get_custom_types().has(type)) {
  78. continue;
  79. }
  80. const Vector<EditorData::CustomType> &ct = ed.get_custom_types()[type];
  81. for (int i = 0; i < ct.size(); i++) {
  82. custom_type_parents[ct[i].name] = type;
  83. custom_type_indices[ct[i].name] = i;
  84. type_list.push_back(ct[i].name);
  85. }
  86. }
  87. }
  88. type_list.sort_custom<StringName::AlphCompare>();
  89. }
  90. bool CreateDialog::_is_type_preferred(const String &p_type) const {
  91. if (ClassDB::class_exists(p_type)) {
  92. return ClassDB::is_parent_class(p_type, preferred_search_result_type);
  93. }
  94. return EditorNode::get_editor_data().script_class_is_parent(p_type, preferred_search_result_type);
  95. }
  96. void CreateDialog::_script_button_clicked(TreeItem *p_item, int p_column, int p_button_id, MouseButton p_mouse_button_index) {
  97. if (p_mouse_button_index != MouseButton::LEFT) {
  98. return;
  99. }
  100. // The id of opening-script button is 1.
  101. if (p_button_id != 1) {
  102. return;
  103. }
  104. String scr_path = ScriptServer::get_global_class_path(p_item->get_text(0));
  105. Ref<Script> scr = ResourceLoader::load(scr_path, "Script");
  106. ERR_FAIL_COND_MSG(scr.is_null(), vformat("Could not load the script from resource path: %s", scr_path));
  107. EditorNode::get_singleton()->push_item_no_inspector(scr.ptr());
  108. hide();
  109. _cleanup();
  110. }
  111. bool CreateDialog::_is_class_disabled_by_feature_profile(const StringName &p_class) const {
  112. Ref<EditorFeatureProfile> profile = EditorFeatureProfileManager::get_singleton()->get_current_profile();
  113. return profile.is_valid() && profile->is_class_disabled(p_class);
  114. }
  115. bool CreateDialog::_should_hide_type(const StringName &p_type) const {
  116. if (_is_class_disabled_by_feature_profile(p_type)) {
  117. return true;
  118. }
  119. if (is_base_type_node && p_type.operator String().begins_with("Editor")) {
  120. return true; // Do not show editor nodes.
  121. }
  122. if (ClassDB::class_exists(p_type)) {
  123. if (!ClassDB::can_instantiate(p_type) || ClassDB::is_virtual(p_type)) {
  124. return true; // Can't create abstract or virtual class.
  125. }
  126. if (!ClassDB::is_parent_class(p_type, base_type)) {
  127. return true; // Wrong inheritance.
  128. }
  129. if (!ClassDB::is_class_exposed(p_type)) {
  130. return true; // Unexposed types.
  131. }
  132. for (const StringName &E : type_blacklist) {
  133. if (ClassDB::is_parent_class(p_type, E)) {
  134. return true; // Parent type is blacklisted.
  135. }
  136. }
  137. for (const StringName &F : custom_type_blocklist) {
  138. if (ClassDB::is_parent_class(p_type, F)) {
  139. return true; // Parent type is excluded in custom type blocklist.
  140. }
  141. }
  142. } else {
  143. if (!ScriptServer::is_global_class(p_type)) {
  144. return true;
  145. }
  146. if (!EditorNode::get_editor_data().script_class_is_parent(p_type, base_type)) {
  147. return true; // Wrong inheritance.
  148. }
  149. StringName native_type = ScriptServer::get_global_class_native_base(p_type);
  150. if (ClassDB::class_exists(native_type)) {
  151. if (!ClassDB::can_instantiate(native_type)) {
  152. return true;
  153. } else if (custom_type_blocklist.has(p_type) || custom_type_blocklist.has(native_type)) {
  154. return true;
  155. }
  156. }
  157. String script_path = ScriptServer::get_global_class_path(p_type);
  158. if (script_path.begins_with("res://addons/")) {
  159. int i = script_path.find_char('/', 13); // 13 is length of "res://addons/".
  160. while (i > -1) {
  161. const String plugin_path = script_path.substr(0, i).path_join("plugin.cfg");
  162. if (FileAccess::exists(plugin_path)) {
  163. return !EditorNode::get_singleton()->is_addon_plugin_enabled(plugin_path);
  164. }
  165. i = script_path.find_char('/', i + 1);
  166. }
  167. }
  168. }
  169. return false;
  170. }
  171. void CreateDialog::_update_search() {
  172. search_options->clear();
  173. search_options_types.clear();
  174. TreeItem *root = search_options->create_item();
  175. root->set_text(0, base_type);
  176. root->set_icon(0, search_options->get_editor_theme_icon(icon_fallback));
  177. search_options_types[base_type] = root;
  178. _configure_search_option_item(root, base_type, ClassDB::class_exists(base_type) ? TypeCategory::CPP_TYPE : TypeCategory::OTHER_TYPE);
  179. const String search_text = search_box->get_text();
  180. bool empty_search = search_text.is_empty();
  181. float highest_score = 0.0f;
  182. StringName best_match;
  183. for (List<StringName>::Element *I = type_list.front(); I; I = I->next()) {
  184. StringName candidate = I->get();
  185. if (empty_search || search_text.is_subsequence_ofn(candidate)) {
  186. _add_type(candidate, ClassDB::class_exists(candidate) ? TypeCategory::CPP_TYPE : TypeCategory::OTHER_TYPE);
  187. // Determine the best match for an non-empty search.
  188. if (!empty_search) {
  189. float score = _score_type(candidate.operator String().get_slicec(' ', 0), search_text);
  190. if (score > highest_score) {
  191. highest_score = score;
  192. best_match = candidate;
  193. }
  194. }
  195. }
  196. }
  197. // Select the best result.
  198. if (empty_search) {
  199. select_type(base_type);
  200. } else if (best_match != StringName()) {
  201. select_type(best_match);
  202. } else {
  203. favorite->set_disabled(true);
  204. help_bit->set_custom_text(String(), String(), vformat(TTR("No results for \"%s\"."), search_text.replace("[", "[lb]")));
  205. get_ok_button()->set_disabled(true);
  206. search_options->deselect_all();
  207. }
  208. }
  209. void CreateDialog::_add_type(const StringName &p_type, TypeCategory p_type_category) {
  210. if (search_options_types.has(p_type)) {
  211. return;
  212. }
  213. TypeCategory inherited_type = TypeCategory::OTHER_TYPE;
  214. StringName inherits;
  215. if (p_type_category == TypeCategory::CPP_TYPE) {
  216. inherits = ClassDB::get_parent_class(p_type);
  217. inherited_type = TypeCategory::CPP_TYPE;
  218. } else {
  219. if (p_type_category == TypeCategory::PATH_TYPE || ScriptServer::is_global_class(p_type)) {
  220. Ref<Script> scr;
  221. if (p_type_category == TypeCategory::PATH_TYPE) {
  222. ERR_FAIL_COND(!ResourceLoader::exists(p_type, "Script"));
  223. scr = ResourceLoader::load(p_type, "Script");
  224. } else {
  225. scr = EditorNode::get_editor_data().script_class_load_script(p_type);
  226. }
  227. ERR_FAIL_COND(scr.is_null());
  228. Ref<Script> base = scr->get_base_script();
  229. if (base.is_null()) {
  230. // Must be a native base type.
  231. StringName extends = scr->get_instance_base_type();
  232. if (extends == StringName()) {
  233. // Not a valid script (has compile errors), we therefore ignore it as it can not be instantiated anyway (when selected).
  234. return;
  235. }
  236. inherits = extends;
  237. inherited_type = TypeCategory::CPP_TYPE;
  238. } else {
  239. inherits = base->get_global_name();
  240. if (inherits == StringName()) {
  241. inherits = base->get_path();
  242. inherited_type = TypeCategory::PATH_TYPE;
  243. }
  244. }
  245. } else {
  246. inherits = custom_type_parents[p_type];
  247. if (ClassDB::class_exists(inherits)) {
  248. inherited_type = TypeCategory::CPP_TYPE;
  249. }
  250. }
  251. }
  252. // Should never happen, but just in case...
  253. ERR_FAIL_COND(inherits == StringName());
  254. _add_type(inherits, inherited_type);
  255. TreeItem *item = search_options->create_item(search_options_types[inherits]);
  256. search_options_types[p_type] = item;
  257. _configure_search_option_item(item, p_type, p_type_category);
  258. }
  259. void CreateDialog::_configure_search_option_item(TreeItem *r_item, const StringName &p_type, TypeCategory p_type_category) {
  260. bool script_type = ScriptServer::is_global_class(p_type);
  261. bool is_abstract = false;
  262. if (p_type_category == TypeCategory::CPP_TYPE) {
  263. r_item->set_text(0, p_type);
  264. } else if (p_type_category == TypeCategory::PATH_TYPE) {
  265. r_item->set_text(0, "\"" + p_type + "\"");
  266. } else if (script_type) {
  267. r_item->set_metadata(0, p_type);
  268. r_item->set_text(0, p_type);
  269. String script_path = ScriptServer::get_global_class_path(p_type);
  270. Ref<Script> scr = ResourceLoader::load(script_path, "Script");
  271. ERR_FAIL_COND(scr.is_null());
  272. is_abstract = scr->is_abstract();
  273. String tooltip = TTR("Script path: %s");
  274. bool is_tool = scr->is_tool();
  275. if (is_tool) {
  276. tooltip = TTR("The script will run in the editor.") + "\n" + tooltip;
  277. }
  278. r_item->add_button(0, get_editor_theme_icon(SNAME("Script")), 1, false, vformat(tooltip, script_path));
  279. if (is_tool) {
  280. int button_index = r_item->get_button_count(0) - 1;
  281. r_item->set_button_color(0, button_index, get_theme_color(SNAME("accent_color"), EditorStringName(Editor)));
  282. }
  283. } else {
  284. r_item->set_metadata(0, custom_type_parents[p_type]);
  285. r_item->set_text(0, p_type);
  286. }
  287. bool can_instantiate = (p_type_category == TypeCategory::CPP_TYPE && ClassDB::can_instantiate(p_type)) ||
  288. (p_type_category == TypeCategory::OTHER_TYPE && !is_abstract);
  289. bool instantiable = can_instantiate && !(ClassDB::class_exists(p_type) && ClassDB::is_virtual(p_type));
  290. r_item->set_meta(SNAME("__instantiable"), instantiable);
  291. r_item->set_icon(0, EditorNode::get_singleton()->get_class_icon(p_type));
  292. if (!instantiable) {
  293. r_item->set_custom_color(0, search_options->get_theme_color(SNAME("font_disabled_color"), EditorStringName(Editor)));
  294. }
  295. HashMap<String, DocData::ClassDoc>::Iterator class_doc = EditorHelp::get_doc_data()->class_list.find(p_type);
  296. bool is_deprecated = (class_doc && class_doc->value.is_deprecated);
  297. bool is_experimental = (class_doc && class_doc->value.is_experimental);
  298. if (is_deprecated) {
  299. r_item->add_button(0, get_editor_theme_icon("StatusError"), 0, false, TTR("This class is marked as deprecated."));
  300. } else if (is_experimental) {
  301. r_item->add_button(0, get_editor_theme_icon("NodeWarning"), 0, false, TTR("This class is marked as experimental."));
  302. }
  303. if (!search_box->get_text().is_empty()) {
  304. r_item->set_collapsed(false);
  305. } else {
  306. // Don't collapse the root node or an abstract node on the first tree level.
  307. bool should_collapse = p_type != base_type && (r_item->get_parent()->get_text(0) != base_type || can_instantiate);
  308. if (should_collapse && bool(EDITOR_GET("docks/scene_tree/start_create_dialog_fully_expanded"))) {
  309. should_collapse = false; // Collapse all nodes anyway.
  310. }
  311. r_item->set_collapsed(should_collapse);
  312. }
  313. const String &description = DTR(class_doc ? class_doc->value.brief_description : "");
  314. r_item->set_tooltip_text(0, description);
  315. if (p_type_category == TypeCategory::OTHER_TYPE && !script_type) {
  316. Ref<Texture2D> icon = EditorNode::get_editor_data().get_custom_types()[custom_type_parents[p_type]][custom_type_indices[p_type]].icon;
  317. if (icon.is_valid()) {
  318. r_item->set_icon(0, icon);
  319. }
  320. }
  321. }
  322. float CreateDialog::_score_type(const String &p_type, const String &p_search) const {
  323. if (p_type == p_search) {
  324. // Always favor an exact match (case-sensitive), since clicking a favorite will set the search text to the type.
  325. return 1.0f;
  326. }
  327. float inverse_length = 1.f / float(p_type.length());
  328. // Favor types where search term is a substring close to the start of the type.
  329. float w = 0.5f;
  330. int pos = p_type.findn(p_search);
  331. float score = (pos > -1) ? 1.0f - w * MIN(1, 3 * pos * inverse_length) : MAX(0.f, .9f - w);
  332. // Favor shorter items: they resemble the search term more.
  333. w = 0.9f;
  334. score *= (1 - w) + w * MIN(1.0f, p_search.length() * inverse_length);
  335. score *= _is_type_preferred(p_type) ? 1.0f : 0.9f;
  336. // Add score for being a favorite type.
  337. score *= favorite_list.has(p_type) ? 1.0f : 0.8f;
  338. // Look through at most 5 recent items
  339. bool in_recent = false;
  340. constexpr int RECENT_COMPLETION_SIZE = 5;
  341. for (int i = 0; i < MIN(RECENT_COMPLETION_SIZE - 1, recent->get_item_count()); i++) {
  342. if (recent->get_item_text(i) == p_type) {
  343. in_recent = true;
  344. break;
  345. }
  346. }
  347. score *= in_recent ? 1.0f : 0.9f;
  348. return score;
  349. }
  350. void CreateDialog::_cleanup() {
  351. type_list.clear();
  352. favorite_list.clear();
  353. favorites->clear();
  354. recent->clear();
  355. custom_type_parents.clear();
  356. custom_type_indices.clear();
  357. }
  358. void CreateDialog::_confirmed() {
  359. String selected_item = get_selected_type();
  360. if (selected_item.is_empty()) {
  361. return;
  362. }
  363. TreeItem *selected = search_options->get_selected();
  364. if (!selected->get_meta("__instantiable", true)) {
  365. return;
  366. }
  367. {
  368. Ref<FileAccess> f = FileAccess::open(EditorPaths::get_singleton()->get_project_settings_dir().path_join("create_recent." + base_type), FileAccess::WRITE);
  369. if (f.is_valid()) {
  370. f->store_line(selected_item);
  371. constexpr int RECENT_HISTORY_SIZE = 15;
  372. for (int i = 0; i < MIN(RECENT_HISTORY_SIZE - 1, recent->get_item_count()); i++) {
  373. if (recent->get_item_text(i) != selected_item) {
  374. f->store_line(recent->get_item_text(i));
  375. }
  376. }
  377. }
  378. }
  379. // To prevent, emitting an error from the transient window (shader dialog for example) hide this dialog before emitting the "create" signal.
  380. hide();
  381. emit_signal(SNAME("create"));
  382. _cleanup();
  383. }
  384. void CreateDialog::_text_changed(const String &p_newtext) {
  385. _update_search();
  386. }
  387. void CreateDialog::_sbox_input(const Ref<InputEvent> &p_event) {
  388. // Redirect navigational key events to the tree.
  389. Ref<InputEventKey> key = p_event;
  390. if (key.is_valid()) {
  391. if (key->is_action("ui_up", true) || key->is_action("ui_down", true) || key->is_action("ui_page_up") || key->is_action("ui_page_down")) {
  392. search_options->gui_input(key);
  393. search_box->accept_event();
  394. } else if (key->is_action_pressed("ui_select", true)) {
  395. TreeItem *ti = search_options->get_selected();
  396. if (ti) {
  397. ti->set_collapsed(!ti->is_collapsed());
  398. }
  399. search_box->accept_event();
  400. }
  401. }
  402. }
  403. void CreateDialog::_notification(int p_what) {
  404. switch (p_what) {
  405. case NOTIFICATION_ENTER_TREE: {
  406. connect(SceneStringName(confirmed), callable_mp(this, &CreateDialog::_confirmed));
  407. } break;
  408. case NOTIFICATION_EXIT_TREE: {
  409. disconnect(SceneStringName(confirmed), callable_mp(this, &CreateDialog::_confirmed));
  410. } break;
  411. case NOTIFICATION_VISIBILITY_CHANGED: {
  412. if (is_visible()) {
  413. callable_mp((Control *)search_box, &Control::grab_focus).call_deferred(); // Still not visible.
  414. search_box->select_all();
  415. } else {
  416. EditorSettings::get_singleton()->set_project_metadata("dialog_bounds", "create_new_node", Rect2(get_position(), get_size()));
  417. }
  418. } break;
  419. case NOTIFICATION_THEME_CHANGED: {
  420. const int icon_width = get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor));
  421. search_options->add_theme_constant_override("icon_max_width", icon_width);
  422. favorites->add_theme_constant_override("icon_max_width", icon_width);
  423. recent->set_fixed_icon_size(Size2(icon_width, icon_width));
  424. search_box->set_right_icon(get_editor_theme_icon(SNAME("Search")));
  425. favorite->set_button_icon(get_editor_theme_icon(SNAME("Favorites")));
  426. } break;
  427. }
  428. }
  429. void CreateDialog::select_type(const String &p_type, bool p_center_on_item) {
  430. if (!search_options_types.has(p_type)) {
  431. return;
  432. }
  433. TreeItem *to_select = search_options_types[p_type];
  434. to_select->select(0);
  435. search_options->scroll_to_item(to_select, p_center_on_item);
  436. help_bit->parse_symbol("class|" + p_type + "|");
  437. favorite->set_disabled(false);
  438. favorite->set_pressed(favorite_list.has(p_type));
  439. if (to_select->get_meta("__instantiable", true)) {
  440. get_ok_button()->set_disabled(false);
  441. get_ok_button()->set_tooltip_text(String());
  442. } else {
  443. get_ok_button()->set_disabled(true);
  444. get_ok_button()->set_tooltip_text(TTR("The selected class can't be instantiated."));
  445. }
  446. }
  447. void CreateDialog::select_base() {
  448. if (search_options_types.is_empty()) {
  449. _update_search();
  450. }
  451. select_type(base_type, false);
  452. }
  453. String CreateDialog::get_selected_type() {
  454. TreeItem *selected = search_options->get_selected();
  455. if (!selected) {
  456. return String();
  457. }
  458. return selected->get_text(0);
  459. }
  460. void CreateDialog::set_base_type(const String &p_base) {
  461. base_type = p_base;
  462. is_base_type_node = ClassDB::is_parent_class(p_base, "Node");
  463. }
  464. Variant CreateDialog::instantiate_selected() {
  465. TreeItem *selected = search_options->get_selected();
  466. if (!selected) {
  467. return Variant();
  468. }
  469. Variant md = selected->get_metadata(0);
  470. Variant obj;
  471. if (md.get_type() != Variant::NIL) {
  472. String custom = md;
  473. if (ScriptServer::is_global_class(custom)) {
  474. obj = EditorNode::get_editor_data().script_class_instance(custom);
  475. Node *n = Object::cast_to<Node>(obj);
  476. if (n) {
  477. n->set_name(custom);
  478. }
  479. } else {
  480. obj = EditorNode::get_editor_data().instantiate_custom_type(selected->get_text(0), custom);
  481. }
  482. } else {
  483. obj = ClassDB::instantiate(selected->get_text(0));
  484. }
  485. EditorNode::get_editor_data().instantiate_object_properties(obj);
  486. return obj;
  487. }
  488. void CreateDialog::_item_selected() {
  489. String name = get_selected_type();
  490. select_type(name, false);
  491. }
  492. void CreateDialog::_hide_requested() {
  493. _cancel_pressed(); // From AcceptDialog.
  494. }
  495. void CreateDialog::cancel_pressed() {
  496. _cleanup();
  497. }
  498. void CreateDialog::_favorite_toggled() {
  499. TreeItem *item = search_options->get_selected();
  500. if (!item) {
  501. return;
  502. }
  503. String name = item->get_text(0);
  504. if (favorite_list.has(name)) {
  505. favorite_list.erase(name);
  506. favorite->set_pressed(false);
  507. } else {
  508. favorite_list.push_back(name);
  509. favorite->set_pressed(true);
  510. }
  511. _save_and_update_favorite_list();
  512. }
  513. void CreateDialog::_history_selected(int p_idx) {
  514. search_box->set_text(recent->get_item_text(p_idx).get_slicec(' ', 0));
  515. favorites->deselect_all();
  516. _update_search();
  517. }
  518. void CreateDialog::_favorite_selected() {
  519. TreeItem *item = favorites->get_selected();
  520. if (!item) {
  521. return;
  522. }
  523. search_box->set_text(item->get_text(0).get_slicec(' ', 0));
  524. recent->deselect_all();
  525. _update_search();
  526. }
  527. void CreateDialog::_history_activated(int p_idx) {
  528. _history_selected(p_idx);
  529. _confirmed();
  530. }
  531. void CreateDialog::_favorite_activated() {
  532. _favorite_selected();
  533. _confirmed();
  534. }
  535. Variant CreateDialog::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  536. TreeItem *ti = favorites->get_item_at_position(p_point);
  537. if (ti) {
  538. Dictionary d;
  539. d["type"] = "create_favorite_drag";
  540. d["class"] = ti->get_text(0);
  541. Button *tb = memnew(Button);
  542. tb->set_flat(true);
  543. tb->set_button_icon(ti->get_icon(0));
  544. tb->set_text(ti->get_text(0));
  545. tb->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  546. favorites->set_drag_preview(tb);
  547. return d;
  548. }
  549. return Variant();
  550. }
  551. bool CreateDialog::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  552. Dictionary d = p_data;
  553. if (d.has("type") && String(d["type"]) == "create_favorite_drag") {
  554. favorites->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN);
  555. return true;
  556. }
  557. return false;
  558. }
  559. void CreateDialog::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  560. Dictionary d = p_data;
  561. TreeItem *ti = favorites->get_item_at_position(p_point);
  562. if (!ti) {
  563. return;
  564. }
  565. String drop_at = ti->get_text(0);
  566. int ds = favorites->get_drop_section_at_position(p_point);
  567. int drop_idx = favorite_list.find(drop_at);
  568. if (drop_idx < 0) {
  569. return;
  570. }
  571. String type = d["class"];
  572. int from_idx = favorite_list.find(type);
  573. if (from_idx < 0) {
  574. return;
  575. }
  576. if (drop_idx == from_idx) {
  577. ds = -1; //cause it will be gone
  578. } else if (drop_idx > from_idx) {
  579. drop_idx--;
  580. }
  581. favorite_list.remove_at(from_idx);
  582. if (ds < 0) {
  583. favorite_list.insert(drop_idx, type);
  584. } else {
  585. if (drop_idx >= favorite_list.size() - 1) {
  586. favorite_list.push_back(type);
  587. } else {
  588. favorite_list.insert(drop_idx + 1, type);
  589. }
  590. }
  591. _save_and_update_favorite_list();
  592. }
  593. void CreateDialog::_save_and_update_favorite_list() {
  594. favorites->clear();
  595. TreeItem *root = favorites->create_item();
  596. {
  597. Ref<FileAccess> f = FileAccess::open(EditorPaths::get_singleton()->get_project_settings_dir().path_join("favorites." + base_type), FileAccess::WRITE);
  598. if (f.is_valid()) {
  599. for (int i = 0; i < favorite_list.size(); i++) {
  600. String l = favorite_list[i];
  601. String name = l.get_slicec(' ', 0);
  602. if (!EditorNode::get_editor_data().is_type_recognized(name)) {
  603. continue;
  604. }
  605. f->store_line(l);
  606. if (_is_class_disabled_by_feature_profile(name)) {
  607. continue;
  608. }
  609. TreeItem *ti = favorites->create_item(root);
  610. ti->set_text(0, l);
  611. ti->set_icon(0, EditorNode::get_singleton()->get_class_icon(name));
  612. }
  613. }
  614. }
  615. emit_signal(SNAME("favorites_updated"));
  616. }
  617. void CreateDialog::_load_favorites_and_history() {
  618. String dir = EditorPaths::get_singleton()->get_project_settings_dir();
  619. Ref<FileAccess> f = FileAccess::open(dir.path_join("create_recent." + base_type), FileAccess::READ);
  620. if (f.is_valid()) {
  621. while (!f->eof_reached()) {
  622. String l = f->get_line().strip_edges();
  623. String name = l.get_slicec(' ', 0);
  624. if (EditorNode::get_editor_data().is_type_recognized(name) && !_is_class_disabled_by_feature_profile(name)) {
  625. recent->add_item(l, EditorNode::get_singleton()->get_class_icon(name));
  626. }
  627. }
  628. }
  629. f = FileAccess::open(dir.path_join("favorites." + base_type), FileAccess::READ);
  630. if (f.is_valid()) {
  631. while (!f->eof_reached()) {
  632. String l = f->get_line().strip_edges();
  633. if (!l.is_empty()) {
  634. favorite_list.push_back(l);
  635. }
  636. }
  637. }
  638. }
  639. void CreateDialog::_bind_methods() {
  640. ADD_SIGNAL(MethodInfo("create"));
  641. ADD_SIGNAL(MethodInfo("favorites_updated"));
  642. }
  643. CreateDialog::CreateDialog() {
  644. base_type = "Object";
  645. preferred_search_result_type = "";
  646. type_blacklist.insert("PluginScript"); // PluginScript must be initialized before use, which is not possible here.
  647. type_blacklist.insert("ScriptCreateDialog"); // This is an exposed editor Node that doesn't have an Editor prefix.
  648. HSplitContainer *hsc = memnew(HSplitContainer);
  649. add_child(hsc);
  650. VSplitContainer *vsc = memnew(VSplitContainer);
  651. hsc->add_child(vsc);
  652. VBoxContainer *fav_vb = memnew(VBoxContainer);
  653. fav_vb->set_custom_minimum_size(Size2(150, 100) * EDSCALE);
  654. fav_vb->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  655. vsc->add_child(fav_vb);
  656. favorites = memnew(Tree);
  657. favorites->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  658. favorites->set_hide_root(true);
  659. favorites->set_hide_folding(true);
  660. favorites->set_allow_reselect(true);
  661. favorites->connect("cell_selected", callable_mp(this, &CreateDialog::_favorite_selected));
  662. favorites->connect("item_activated", callable_mp(this, &CreateDialog::_favorite_activated));
  663. favorites->add_theme_constant_override("draw_guides", 1);
  664. favorites->set_theme_type_variation("TreeSecondary");
  665. SET_DRAG_FORWARDING_GCD(favorites, CreateDialog);
  666. fav_vb->add_margin_child(TTR("Favorites:"), favorites, true);
  667. VBoxContainer *rec_vb = memnew(VBoxContainer);
  668. vsc->add_child(rec_vb);
  669. rec_vb->set_custom_minimum_size(Size2(150, 100) * EDSCALE);
  670. rec_vb->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  671. recent = memnew(ItemList);
  672. recent->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  673. rec_vb->add_margin_child(TTR("Recent:"), recent, true);
  674. recent->set_allow_reselect(true);
  675. recent->connect(SceneStringName(item_selected), callable_mp(this, &CreateDialog::_history_selected));
  676. recent->connect("item_activated", callable_mp(this, &CreateDialog::_history_activated));
  677. recent->add_theme_constant_override("draw_guides", 1);
  678. recent->set_theme_type_variation("ItemListSecondary");
  679. VBoxContainer *vbc = memnew(VBoxContainer);
  680. vbc->set_custom_minimum_size(Size2(300, 0) * EDSCALE);
  681. vbc->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  682. hsc->add_child(vbc);
  683. search_box = memnew(LineEdit);
  684. search_box->set_clear_button_enabled(true);
  685. search_box->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  686. search_box->connect(SceneStringName(text_changed), callable_mp(this, &CreateDialog::_text_changed));
  687. search_box->connect(SceneStringName(gui_input), callable_mp(this, &CreateDialog::_sbox_input));
  688. HBoxContainer *search_hb = memnew(HBoxContainer);
  689. search_hb->add_child(search_box);
  690. favorite = memnew(Button);
  691. favorite->set_toggle_mode(true);
  692. favorite->set_tooltip_text(TTR("(Un)favorite selected item."));
  693. favorite->connect(SceneStringName(pressed), callable_mp(this, &CreateDialog::_favorite_toggled));
  694. search_hb->add_child(favorite);
  695. vbc->add_margin_child(TTR("Search:"), search_hb);
  696. search_options = memnew(Tree);
  697. search_options->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  698. search_options->connect("item_activated", callable_mp(this, &CreateDialog::_confirmed));
  699. search_options->connect("cell_selected", callable_mp(this, &CreateDialog::_item_selected));
  700. search_options->connect("button_clicked", callable_mp(this, &CreateDialog::_script_button_clicked));
  701. vbc->add_margin_child(TTR("Matches:"), search_options, true);
  702. help_bit = memnew(EditorHelpBit);
  703. help_bit->set_content_height_limits(80 * EDSCALE, 80 * EDSCALE);
  704. help_bit->connect("request_hide", callable_mp(this, &CreateDialog::_hide_requested));
  705. vbc->add_margin_child(TTR("Description:"), help_bit);
  706. register_text_enter(search_box);
  707. set_hide_on_ok(false);
  708. set_clamp_to_embedder(true);
  709. }