create_dialog.cpp 26 KB

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