create_dialog.cpp 28 KB

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