create_dialog.cpp 26 KB

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