create_dialog.cpp 28 KB

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