create_dialog.cpp 30 KB

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