create_dialog.cpp 25 KB

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