create_dialog.cpp 26 KB

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