create_dialog.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841
  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 "editor/editor_feature_profile.h"
  33. #include "editor/editor_node.h"
  34. #include "editor/editor_paths.h"
  35. #include "editor/editor_settings.h"
  36. #include "editor/editor_string_names.h"
  37. #include "editor/themes/editor_scale.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, EditorStringName(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. StringName 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 StringName &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.operator String().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. if (!ClassDB::is_class_exposed(p_type)) {
  115. return true; // Unexposed types.
  116. }
  117. for (const StringName &E : type_blacklist) {
  118. if (ClassDB::is_parent_class(p_type, E)) {
  119. return true; // Parent type is blacklisted.
  120. }
  121. }
  122. for (const StringName &F : custom_type_blocklist) {
  123. if (ClassDB::is_parent_class(p_type, F)) {
  124. return true; // Parent type is excluded in custom type blocklist.
  125. }
  126. }
  127. } else {
  128. if (!ScriptServer::is_global_class(p_type)) {
  129. return true;
  130. }
  131. if (!EditorNode::get_editor_data().script_class_is_parent(p_type, base_type)) {
  132. return true; // Wrong inheritance.
  133. }
  134. StringName native_type = ScriptServer::get_global_class_native_base(p_type);
  135. if (ClassDB::class_exists(native_type)) {
  136. if (!ClassDB::can_instantiate(native_type)) {
  137. return true;
  138. } else if (custom_type_blocklist.has(p_type) || custom_type_blocklist.has(native_type)) {
  139. return true;
  140. }
  141. }
  142. String script_path = ScriptServer::get_global_class_path(p_type);
  143. if (script_path.begins_with("res://addons/")) {
  144. int i = script_path.find_char('/', 13); // 13 is length of "res://addons/".
  145. while (i > -1) {
  146. const String plugin_path = script_path.substr(0, i).path_join("plugin.cfg");
  147. if (FileAccess::exists(plugin_path)) {
  148. return !EditorNode::get_singleton()->is_addon_plugin_enabled(plugin_path);
  149. }
  150. i = script_path.find_char('/', i + 1);
  151. }
  152. }
  153. }
  154. return false;
  155. }
  156. void CreateDialog::_update_search() {
  157. search_options->clear();
  158. search_options_types.clear();
  159. TreeItem *root = search_options->create_item();
  160. root->set_text(0, base_type);
  161. root->set_icon(0, search_options->get_editor_theme_icon(icon_fallback));
  162. search_options_types[base_type] = root;
  163. _configure_search_option_item(root, base_type, ClassDB::class_exists(base_type) ? TypeCategory::CPP_TYPE : TypeCategory::OTHER_TYPE);
  164. const String search_text = search_box->get_text();
  165. bool empty_search = search_text.is_empty();
  166. float highest_score = 0.0f;
  167. StringName best_match;
  168. for (List<StringName>::Element *I = type_list.front(); I; I = I->next()) {
  169. StringName candidate = I->get();
  170. if (empty_search || search_text.is_subsequence_ofn(candidate)) {
  171. _add_type(candidate, ClassDB::class_exists(candidate) ? TypeCategory::CPP_TYPE : TypeCategory::OTHER_TYPE);
  172. // Determine the best match for an non-empty search.
  173. if (!empty_search) {
  174. float score = _score_type(candidate.operator String().get_slicec(' ', 0), search_text);
  175. if (score > highest_score) {
  176. highest_score = score;
  177. best_match = candidate;
  178. }
  179. }
  180. }
  181. }
  182. // Select the best result.
  183. if (empty_search) {
  184. select_type(base_type);
  185. } else if (best_match != StringName()) {
  186. select_type(best_match);
  187. } else {
  188. favorite->set_disabled(true);
  189. help_bit->set_custom_text(String(), String(), vformat(TTR("No results for \"%s\"."), search_text.replace("[", "[lb]")));
  190. get_ok_button()->set_disabled(true);
  191. search_options->deselect_all();
  192. }
  193. }
  194. void CreateDialog::_add_type(const StringName &p_type, TypeCategory p_type_category) {
  195. if (search_options_types.has(p_type)) {
  196. return;
  197. }
  198. TypeCategory inherited_type = TypeCategory::OTHER_TYPE;
  199. StringName inherits;
  200. if (p_type_category == TypeCategory::CPP_TYPE) {
  201. inherits = ClassDB::get_parent_class(p_type);
  202. inherited_type = TypeCategory::CPP_TYPE;
  203. } else {
  204. if (p_type_category == TypeCategory::PATH_TYPE || ScriptServer::is_global_class(p_type)) {
  205. Ref<Script> scr;
  206. if (p_type_category == TypeCategory::PATH_TYPE) {
  207. ERR_FAIL_COND(!ResourceLoader::exists(p_type, "Script"));
  208. scr = ResourceLoader::load(p_type, "Script");
  209. } else {
  210. scr = EditorNode::get_editor_data().script_class_load_script(p_type);
  211. }
  212. ERR_FAIL_COND(scr.is_null());
  213. Ref<Script> base = scr->get_base_script();
  214. if (base.is_null()) {
  215. // Must be a native base type.
  216. StringName extends = scr->get_instance_base_type();
  217. if (extends == StringName()) {
  218. // Not a valid script (has compile errors), we therefore ignore it as it can not be instantiated anyway (when selected).
  219. return;
  220. }
  221. inherits = extends;
  222. inherited_type = TypeCategory::CPP_TYPE;
  223. } else {
  224. inherits = base->get_global_name();
  225. if (inherits == StringName()) {
  226. inherits = base->get_path();
  227. inherited_type = TypeCategory::PATH_TYPE;
  228. }
  229. }
  230. } else {
  231. inherits = custom_type_parents[p_type];
  232. if (ClassDB::class_exists(inherits)) {
  233. inherited_type = TypeCategory::CPP_TYPE;
  234. }
  235. }
  236. }
  237. // Should never happen, but just in case...
  238. ERR_FAIL_COND(inherits == StringName());
  239. _add_type(inherits, inherited_type);
  240. TreeItem *item = search_options->create_item(search_options_types[inherits]);
  241. search_options_types[p_type] = item;
  242. _configure_search_option_item(item, p_type, p_type_category);
  243. }
  244. void CreateDialog::_configure_search_option_item(TreeItem *r_item, const StringName &p_type, TypeCategory p_type_category) {
  245. bool script_type = ScriptServer::is_global_class(p_type);
  246. bool is_abstract = false;
  247. if (p_type_category == TypeCategory::CPP_TYPE) {
  248. r_item->set_text(0, p_type);
  249. if (custom_type_suffixes.has(p_type)) {
  250. String suffix = custom_type_suffixes.get(p_type);
  251. if (!suffix.is_empty()) {
  252. r_item->set_suffix(0, "(" + suffix + ")");
  253. }
  254. }
  255. } else if (p_type_category == TypeCategory::PATH_TYPE) {
  256. r_item->set_text(0, "\"" + p_type + "\"");
  257. } else if (script_type) {
  258. r_item->set_metadata(0, p_type);
  259. r_item->set_text(0, p_type);
  260. String script_path = ScriptServer::get_global_class_path(p_type);
  261. Ref<Script> scr = ResourceLoader::load(script_path, "Script");
  262. String suffix = script_path.get_file();
  263. if (scr.is_valid() && custom_type_suffixes.has(p_type)) {
  264. suffix = custom_type_suffixes.get(p_type);
  265. }
  266. if (!suffix.is_empty()) {
  267. r_item->set_suffix(0, "(" + suffix + ")");
  268. }
  269. ERR_FAIL_COND(!scr.is_valid());
  270. is_abstract = scr->is_abstract();
  271. } else {
  272. r_item->set_metadata(0, custom_type_parents[p_type]);
  273. r_item->set_text(0, p_type);
  274. }
  275. bool can_instantiate = (p_type_category == TypeCategory::CPP_TYPE && ClassDB::can_instantiate(p_type)) ||
  276. (p_type_category == TypeCategory::OTHER_TYPE && !is_abstract);
  277. bool instantiable = can_instantiate && !(ClassDB::class_exists(p_type) && ClassDB::is_virtual(p_type));
  278. r_item->set_meta(SNAME("__instantiable"), instantiable);
  279. r_item->set_icon(0, EditorNode::get_singleton()->get_class_icon(p_type));
  280. if (!instantiable) {
  281. r_item->set_custom_color(0, search_options->get_theme_color(SNAME("font_disabled_color"), EditorStringName(Editor)));
  282. }
  283. HashMap<String, DocData::ClassDoc>::Iterator class_doc = EditorHelp::get_doc_data()->class_list.find(p_type);
  284. bool is_deprecated = (class_doc && class_doc->value.is_deprecated);
  285. bool is_experimental = (class_doc && class_doc->value.is_experimental);
  286. if (is_deprecated) {
  287. r_item->add_button(0, get_editor_theme_icon("StatusError"), 0, false, TTR("This class is marked as deprecated."));
  288. } else if (is_experimental) {
  289. r_item->add_button(0, get_editor_theme_icon("NodeWarning"), 0, false, TTR("This class is marked as experimental."));
  290. }
  291. if (!search_box->get_text().is_empty()) {
  292. r_item->set_collapsed(false);
  293. } else {
  294. // Don't collapse the root node or an abstract node on the first tree level.
  295. bool should_collapse = p_type != base_type && (r_item->get_parent()->get_text(0) != base_type || can_instantiate);
  296. if (should_collapse && bool(EDITOR_GET("docks/scene_tree/start_create_dialog_fully_expanded"))) {
  297. should_collapse = false; // Collapse all nodes anyway.
  298. }
  299. r_item->set_collapsed(should_collapse);
  300. }
  301. const String &description = DTR(class_doc ? class_doc->value.brief_description : "");
  302. r_item->set_tooltip_text(0, description);
  303. if (p_type_category == TypeCategory::OTHER_TYPE && !script_type) {
  304. Ref<Texture2D> icon = EditorNode::get_editor_data().get_custom_types()[custom_type_parents[p_type]][custom_type_indices[p_type]].icon;
  305. if (icon.is_valid()) {
  306. r_item->set_icon(0, icon);
  307. }
  308. }
  309. }
  310. float CreateDialog::_score_type(const String &p_type, const String &p_search) const {
  311. if (p_type == p_search) {
  312. // Always favor an exact match (case-sensitive), since clicking a favorite will set the search text to the type.
  313. return 1.0f;
  314. }
  315. float inverse_length = 1.f / float(p_type.length());
  316. // Favor types where search term is a substring close to the start of the type.
  317. float w = 0.5f;
  318. int pos = p_type.findn(p_search);
  319. float score = (pos > -1) ? 1.0f - w * MIN(1, 3 * pos * inverse_length) : MAX(0.f, .9f - w);
  320. // Favor shorter items: they resemble the search term more.
  321. w = 0.9f;
  322. score *= (1 - w) + w * MIN(1.0f, p_search.length() * inverse_length);
  323. score *= _is_type_preferred(p_type) ? 1.0f : 0.9f;
  324. // Add score for being a favorite type.
  325. score *= favorite_list.has(p_type) ? 1.0f : 0.8f;
  326. // Look through at most 5 recent items
  327. bool in_recent = false;
  328. constexpr int RECENT_COMPLETION_SIZE = 5;
  329. for (int i = 0; i < MIN(RECENT_COMPLETION_SIZE - 1, recent->get_item_count()); i++) {
  330. if (recent->get_item_text(i) == p_type) {
  331. in_recent = true;
  332. break;
  333. }
  334. }
  335. score *= in_recent ? 1.0f : 0.9f;
  336. return score;
  337. }
  338. void CreateDialog::_cleanup() {
  339. type_list.clear();
  340. favorite_list.clear();
  341. favorites->clear();
  342. recent->clear();
  343. custom_type_parents.clear();
  344. custom_type_indices.clear();
  345. }
  346. void CreateDialog::_confirmed() {
  347. String selected_item = get_selected_type();
  348. if (selected_item.is_empty()) {
  349. return;
  350. }
  351. TreeItem *selected = search_options->get_selected();
  352. if (!selected->get_meta("__instantiable", true)) {
  353. return;
  354. }
  355. {
  356. Ref<FileAccess> f = FileAccess::open(EditorPaths::get_singleton()->get_project_settings_dir().path_join("create_recent." + base_type), FileAccess::WRITE);
  357. if (f.is_valid()) {
  358. f->store_line(selected_item);
  359. constexpr int RECENT_HISTORY_SIZE = 15;
  360. for (int i = 0; i < MIN(RECENT_HISTORY_SIZE - 1, recent->get_item_count()); i++) {
  361. if (recent->get_item_text(i) != selected_item) {
  362. f->store_line(recent->get_item_text(i));
  363. }
  364. }
  365. }
  366. }
  367. // To prevent, emitting an error from the transient window (shader dialog for example) hide this dialog before emitting the "create" signal.
  368. hide();
  369. emit_signal(SNAME("create"));
  370. _cleanup();
  371. }
  372. void CreateDialog::_text_changed(const String &p_newtext) {
  373. _update_search();
  374. }
  375. void CreateDialog::_sbox_input(const Ref<InputEvent> &p_event) {
  376. // Redirect navigational key events to the tree.
  377. Ref<InputEventKey> key = p_event;
  378. if (key.is_valid()) {
  379. if (key->is_action("ui_up", true) || key->is_action("ui_down", true) || key->is_action("ui_page_up") || key->is_action("ui_page_down")) {
  380. search_options->gui_input(key);
  381. search_box->accept_event();
  382. } else if (key->is_action_pressed("ui_select", true)) {
  383. TreeItem *ti = search_options->get_selected();
  384. if (ti) {
  385. ti->set_collapsed(!ti->is_collapsed());
  386. }
  387. search_box->accept_event();
  388. }
  389. }
  390. }
  391. void CreateDialog::_notification(int p_what) {
  392. switch (p_what) {
  393. case NOTIFICATION_ENTER_TREE: {
  394. connect(SceneStringName(confirmed), callable_mp(this, &CreateDialog::_confirmed));
  395. } break;
  396. case NOTIFICATION_EXIT_TREE: {
  397. disconnect(SceneStringName(confirmed), callable_mp(this, &CreateDialog::_confirmed));
  398. } break;
  399. case NOTIFICATION_VISIBILITY_CHANGED: {
  400. if (is_visible()) {
  401. callable_mp((Control *)search_box, &Control::grab_focus).call_deferred(); // Still not visible.
  402. search_box->select_all();
  403. } else {
  404. EditorSettings::get_singleton()->set_project_metadata("dialog_bounds", "create_new_node", Rect2(get_position(), get_size()));
  405. }
  406. } break;
  407. case NOTIFICATION_THEME_CHANGED: {
  408. const int icon_width = get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor));
  409. search_options->add_theme_constant_override("icon_max_width", icon_width);
  410. favorites->add_theme_constant_override("icon_max_width", icon_width);
  411. recent->set_fixed_icon_size(Size2(icon_width, icon_width));
  412. search_box->set_right_icon(get_editor_theme_icon(SNAME("Search")));
  413. favorite->set_button_icon(get_editor_theme_icon(SNAME("Favorites")));
  414. } break;
  415. }
  416. }
  417. void CreateDialog::select_type(const String &p_type, bool p_center_on_item) {
  418. if (!search_options_types.has(p_type)) {
  419. return;
  420. }
  421. TreeItem *to_select = search_options_types[p_type];
  422. to_select->select(0);
  423. search_options->scroll_to_item(to_select, p_center_on_item);
  424. help_bit->parse_symbol("class|" + p_type + "|");
  425. favorite->set_disabled(false);
  426. favorite->set_pressed(favorite_list.has(p_type));
  427. if (to_select->get_meta("__instantiable", true)) {
  428. get_ok_button()->set_disabled(false);
  429. get_ok_button()->set_tooltip_text(String());
  430. } else {
  431. get_ok_button()->set_disabled(true);
  432. get_ok_button()->set_tooltip_text(TTR("The selected class can't be instantiated."));
  433. }
  434. }
  435. void CreateDialog::select_base() {
  436. if (search_options_types.is_empty()) {
  437. _update_search();
  438. }
  439. select_type(base_type, false);
  440. }
  441. String CreateDialog::get_selected_type() {
  442. TreeItem *selected = search_options->get_selected();
  443. if (!selected) {
  444. return String();
  445. }
  446. return selected->get_text(0);
  447. }
  448. void CreateDialog::set_base_type(const String &p_base) {
  449. base_type = p_base;
  450. is_base_type_node = ClassDB::is_parent_class(p_base, "Node");
  451. }
  452. Variant CreateDialog::instantiate_selected() {
  453. TreeItem *selected = search_options->get_selected();
  454. if (!selected) {
  455. return Variant();
  456. }
  457. Variant md = selected->get_metadata(0);
  458. Variant obj;
  459. if (md.get_type() != Variant::NIL) {
  460. String custom = md;
  461. if (ScriptServer::is_global_class(custom)) {
  462. obj = EditorNode::get_editor_data().script_class_instance(custom);
  463. Node *n = Object::cast_to<Node>(obj);
  464. if (n) {
  465. n->set_name(custom);
  466. }
  467. } else {
  468. obj = EditorNode::get_editor_data().instantiate_custom_type(selected->get_text(0), custom);
  469. }
  470. } else {
  471. obj = ClassDB::instantiate(selected->get_text(0));
  472. }
  473. EditorNode::get_editor_data().instantiate_object_properties(obj);
  474. return obj;
  475. }
  476. void CreateDialog::_item_selected() {
  477. String name = get_selected_type();
  478. select_type(name, false);
  479. }
  480. void CreateDialog::_hide_requested() {
  481. _cancel_pressed(); // From AcceptDialog.
  482. }
  483. void CreateDialog::cancel_pressed() {
  484. _cleanup();
  485. }
  486. void CreateDialog::_favorite_toggled() {
  487. TreeItem *item = search_options->get_selected();
  488. if (!item) {
  489. return;
  490. }
  491. String name = item->get_text(0);
  492. if (favorite_list.has(name)) {
  493. favorite_list.erase(name);
  494. favorite->set_pressed(false);
  495. } else {
  496. favorite_list.push_back(name);
  497. favorite->set_pressed(true);
  498. }
  499. _save_and_update_favorite_list();
  500. }
  501. void CreateDialog::_history_selected(int p_idx) {
  502. search_box->set_text(recent->get_item_text(p_idx).get_slicec(' ', 0));
  503. favorites->deselect_all();
  504. _update_search();
  505. }
  506. void CreateDialog::_favorite_selected() {
  507. TreeItem *item = favorites->get_selected();
  508. if (!item) {
  509. return;
  510. }
  511. search_box->set_text(item->get_text(0).get_slicec(' ', 0));
  512. recent->deselect_all();
  513. _update_search();
  514. }
  515. void CreateDialog::_history_activated(int p_idx) {
  516. _history_selected(p_idx);
  517. _confirmed();
  518. }
  519. void CreateDialog::_favorite_activated() {
  520. _favorite_selected();
  521. _confirmed();
  522. }
  523. Variant CreateDialog::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  524. TreeItem *ti = favorites->get_item_at_position(p_point);
  525. if (ti) {
  526. Dictionary d;
  527. d["type"] = "create_favorite_drag";
  528. d["class"] = ti->get_text(0);
  529. Button *tb = memnew(Button);
  530. tb->set_flat(true);
  531. tb->set_button_icon(ti->get_icon(0));
  532. tb->set_text(ti->get_text(0));
  533. tb->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  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_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  646. favorites->set_hide_root(true);
  647. favorites->set_hide_folding(true);
  648. favorites->set_allow_reselect(true);
  649. favorites->connect("cell_selected", callable_mp(this, &CreateDialog::_favorite_selected));
  650. favorites->connect("item_activated", callable_mp(this, &CreateDialog::_favorite_activated));
  651. favorites->add_theme_constant_override("draw_guides", 1);
  652. favorites->set_theme_type_variation("TreeSecondary");
  653. SET_DRAG_FORWARDING_GCD(favorites, CreateDialog);
  654. fav_vb->add_margin_child(TTR("Favorites:"), favorites, true);
  655. VBoxContainer *rec_vb = memnew(VBoxContainer);
  656. vsc->add_child(rec_vb);
  657. rec_vb->set_custom_minimum_size(Size2(150, 100) * EDSCALE);
  658. rec_vb->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  659. recent = memnew(ItemList);
  660. recent->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  661. rec_vb->add_margin_child(TTR("Recent:"), recent, true);
  662. recent->set_allow_reselect(true);
  663. recent->connect(SceneStringName(item_selected), callable_mp(this, &CreateDialog::_history_selected));
  664. recent->connect("item_activated", callable_mp(this, &CreateDialog::_history_activated));
  665. recent->add_theme_constant_override("draw_guides", 1);
  666. recent->set_theme_type_variation("ItemListSecondary");
  667. VBoxContainer *vbc = memnew(VBoxContainer);
  668. vbc->set_custom_minimum_size(Size2(300, 0) * EDSCALE);
  669. vbc->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  670. hsc->add_child(vbc);
  671. search_box = memnew(LineEdit);
  672. search_box->set_clear_button_enabled(true);
  673. search_box->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  674. search_box->connect(SceneStringName(text_changed), callable_mp(this, &CreateDialog::_text_changed));
  675. search_box->connect(SceneStringName(gui_input), callable_mp(this, &CreateDialog::_sbox_input));
  676. HBoxContainer *search_hb = memnew(HBoxContainer);
  677. search_hb->add_child(search_box);
  678. favorite = memnew(Button);
  679. favorite->set_toggle_mode(true);
  680. favorite->set_tooltip_text(TTR("(Un)favorite selected item."));
  681. favorite->connect(SceneStringName(pressed), callable_mp(this, &CreateDialog::_favorite_toggled));
  682. search_hb->add_child(favorite);
  683. vbc->add_margin_child(TTR("Search:"), search_hb);
  684. search_options = memnew(Tree);
  685. search_options->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  686. search_options->connect("item_activated", callable_mp(this, &CreateDialog::_confirmed));
  687. search_options->connect("cell_selected", callable_mp(this, &CreateDialog::_item_selected));
  688. vbc->add_margin_child(TTR("Matches:"), search_options, true);
  689. help_bit = memnew(EditorHelpBit);
  690. help_bit->set_content_height_limits(80 * EDSCALE, 80 * EDSCALE);
  691. help_bit->connect("request_hide", callable_mp(this, &CreateDialog::_hide_requested));
  692. vbc->add_margin_child(TTR("Description:"), help_bit);
  693. register_text_enter(search_box);
  694. set_hide_on_ok(false);
  695. set_clamp_to_embedder(true);
  696. }