create_dialog.cpp 25 KB

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