create_dialog.cpp 26 KB

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