create_dialog.cpp 26 KB

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