create_dialog.cpp 30 KB

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