resource_preloader_editor_plugin.cpp 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432
  1. /**************************************************************************/
  2. /* resource_preloader_editor_plugin.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 "resource_preloader_editor_plugin.h"
  31. #include "core/io/resource_loader.h"
  32. #include "editor/editor_command_palette.h"
  33. #include "editor/editor_interface.h"
  34. #include "editor/editor_node.h"
  35. #include "editor/editor_settings.h"
  36. #include "editor/editor_undo_redo_manager.h"
  37. #include "editor/gui/editor_bottom_panel.h"
  38. #include "editor/gui/editor_file_dialog.h"
  39. #include "editor/themes/editor_scale.h"
  40. void ResourcePreloaderEditor::_notification(int p_what) {
  41. switch (p_what) {
  42. case NOTIFICATION_ENTER_TREE:
  43. case NOTIFICATION_THEME_CHANGED: {
  44. load->set_button_icon(get_editor_theme_icon(SNAME("Folder")));
  45. } break;
  46. }
  47. }
  48. void ResourcePreloaderEditor::_files_load_request(const Vector<String> &p_paths) {
  49. for (int i = 0; i < p_paths.size(); i++) {
  50. const String &path = p_paths[i];
  51. Ref<Resource> resource;
  52. resource = ResourceLoader::load(path);
  53. if (resource.is_null()) {
  54. dialog->set_text(TTR("ERROR: Couldn't load resource!"));
  55. dialog->set_title(TTR("Error!"));
  56. //dialog->get_cancel()->set_text("Close");
  57. dialog->set_ok_button_text(TTR("Close"));
  58. dialog->popup_centered();
  59. return; ///beh should show an error i guess
  60. }
  61. String basename = path.get_file().get_basename();
  62. String name = basename;
  63. int counter = 1;
  64. while (preloader->has_resource(name)) {
  65. counter++;
  66. name = basename + " " + itos(counter);
  67. }
  68. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  69. undo_redo->create_action(TTR("Add Resource"));
  70. undo_redo->add_do_method(preloader, "add_resource", name, resource);
  71. undo_redo->add_undo_method(preloader, "remove_resource", name);
  72. undo_redo->add_do_method(this, "_update_library");
  73. undo_redo->add_undo_method(this, "_update_library");
  74. undo_redo->commit_action();
  75. }
  76. }
  77. void ResourcePreloaderEditor::_load_pressed() {
  78. loading_scene = false;
  79. file->clear_filters();
  80. List<String> extensions;
  81. ResourceLoader::get_recognized_extensions_for_type("", &extensions);
  82. for (const String &extension : extensions) {
  83. file->add_filter("*." + extension);
  84. }
  85. file->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILES);
  86. file->popup_file_dialog();
  87. }
  88. void ResourcePreloaderEditor::_item_edited() {
  89. if (!tree->get_selected()) {
  90. return;
  91. }
  92. TreeItem *s = tree->get_selected();
  93. if (tree->get_selected_column() == 0) {
  94. // renamed
  95. String old_name = s->get_metadata(0);
  96. String new_name = s->get_text(0);
  97. if (old_name == new_name) {
  98. return;
  99. }
  100. if (new_name.is_empty() || new_name.contains_char('\\') || new_name.contains_char('/') || preloader->has_resource(new_name)) {
  101. s->set_text(0, old_name);
  102. return;
  103. }
  104. Ref<Resource> samp = preloader->get_resource(old_name);
  105. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  106. undo_redo->create_action(TTR("Rename Resource"));
  107. undo_redo->add_do_method(preloader, "remove_resource", old_name);
  108. undo_redo->add_do_method(preloader, "add_resource", new_name, samp);
  109. undo_redo->add_undo_method(preloader, "remove_resource", new_name);
  110. undo_redo->add_undo_method(preloader, "add_resource", old_name, samp);
  111. undo_redo->add_do_method(this, "_update_library");
  112. undo_redo->add_undo_method(this, "_update_library");
  113. undo_redo->commit_action();
  114. }
  115. }
  116. void ResourcePreloaderEditor::_remove_resource(const String &p_to_remove) {
  117. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  118. undo_redo->create_action(TTR("Delete Resource"));
  119. undo_redo->add_do_method(preloader, "remove_resource", p_to_remove);
  120. undo_redo->add_undo_method(preloader, "add_resource", p_to_remove, preloader->get_resource(p_to_remove));
  121. undo_redo->add_do_method(this, "_update_library");
  122. undo_redo->add_undo_method(this, "_update_library");
  123. undo_redo->commit_action();
  124. }
  125. void ResourcePreloaderEditor::_paste_pressed() {
  126. Ref<Resource> r = EditorSettings::get_singleton()->get_resource_clipboard();
  127. if (r.is_null()) {
  128. dialog->set_text(TTR("Resource clipboard is empty!"));
  129. dialog->set_title(TTR("Error!"));
  130. dialog->set_ok_button_text(TTR("Close"));
  131. dialog->popup_centered();
  132. return; ///beh should show an error i guess
  133. }
  134. String name = r->get_name();
  135. if (name.is_empty()) {
  136. name = r->get_path().get_file();
  137. }
  138. if (name.is_empty()) {
  139. name = r->get_class();
  140. }
  141. String basename = name;
  142. int counter = 1;
  143. while (preloader->has_resource(name)) {
  144. counter++;
  145. name = basename + " " + itos(counter);
  146. }
  147. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  148. undo_redo->create_action(TTR("Paste Resource"));
  149. undo_redo->add_do_method(preloader, "add_resource", name, r);
  150. undo_redo->add_undo_method(preloader, "remove_resource", name);
  151. undo_redo->add_do_method(this, "_update_library");
  152. undo_redo->add_undo_method(this, "_update_library");
  153. undo_redo->commit_action();
  154. }
  155. void ResourcePreloaderEditor::_update_library() {
  156. tree->clear();
  157. tree->set_hide_root(true);
  158. TreeItem *root = tree->create_item(nullptr);
  159. List<StringName> rnames;
  160. preloader->get_resource_list(&rnames);
  161. List<String> names;
  162. for (const StringName &E : rnames) {
  163. names.push_back(E);
  164. }
  165. names.sort();
  166. for (const String &E : names) {
  167. TreeItem *ti = tree->create_item(root);
  168. ti->set_cell_mode(0, TreeItem::CELL_MODE_STRING);
  169. ti->set_editable(0, true);
  170. ti->set_selectable(0, true);
  171. ti->set_text(0, E);
  172. ti->set_metadata(0, E);
  173. Ref<Resource> r = preloader->get_resource(E);
  174. ERR_CONTINUE(r.is_null());
  175. String type = r->get_class();
  176. ti->set_icon(0, EditorNode::get_singleton()->get_class_icon(type, "Object"));
  177. ti->set_tooltip_text(0, TTR("Instance:") + " " + r->get_path() + "\n" + TTR("Type:") + " " + type);
  178. ti->set_text(1, r->get_path());
  179. ti->set_editable(1, false);
  180. ti->set_selectable(1, false);
  181. if (type == "PackedScene") {
  182. ti->add_button(1, get_editor_theme_icon(SNAME("InstanceOptions")), BUTTON_OPEN_SCENE, false, TTR("Open in Editor"));
  183. } else {
  184. ti->add_button(1, get_editor_theme_icon(SNAME("Load")), BUTTON_EDIT_RESOURCE, false, TTR("Open in Editor"));
  185. }
  186. ti->add_button(1, get_editor_theme_icon(SNAME("Remove")), BUTTON_REMOVE, false, TTR("Remove"));
  187. }
  188. //player->add_resource("default",resource);
  189. }
  190. void ResourcePreloaderEditor::_cell_button_pressed(Object *p_item, int p_column, int p_id, MouseButton p_button) {
  191. if (p_button != MouseButton::LEFT) {
  192. return;
  193. }
  194. TreeItem *item = Object::cast_to<TreeItem>(p_item);
  195. ERR_FAIL_NULL(item);
  196. if (p_id == BUTTON_OPEN_SCENE) {
  197. String rpath = item->get_text(p_column);
  198. EditorInterface::get_singleton()->open_scene_from_path(rpath);
  199. } else if (p_id == BUTTON_EDIT_RESOURCE) {
  200. Ref<Resource> r = preloader->get_resource(item->get_text(0));
  201. EditorInterface::get_singleton()->edit_resource(r);
  202. } else if (p_id == BUTTON_REMOVE) {
  203. _remove_resource(item->get_text(0));
  204. }
  205. }
  206. void ResourcePreloaderEditor::edit(ResourcePreloader *p_preloader) {
  207. preloader = p_preloader;
  208. if (p_preloader) {
  209. _update_library();
  210. } else {
  211. hide();
  212. set_physics_process(false);
  213. }
  214. }
  215. Variant ResourcePreloaderEditor::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  216. TreeItem *ti = tree->get_item_at_position(p_point);
  217. if (!ti) {
  218. return Variant();
  219. }
  220. String name = ti->get_metadata(0);
  221. Ref<Resource> res = preloader->get_resource(name);
  222. if (res.is_null()) {
  223. return Variant();
  224. }
  225. return EditorNode::get_singleton()->drag_resource(res, p_from);
  226. }
  227. bool ResourcePreloaderEditor::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  228. Dictionary d = p_data;
  229. if (!d.has("type")) {
  230. return false;
  231. }
  232. if (d.has("from") && (Object *)(d["from"]) == tree) {
  233. return false;
  234. }
  235. if (String(d["type"]) == "resource" && d.has("resource")) {
  236. Ref<Resource> r = d["resource"];
  237. return r.is_valid();
  238. }
  239. if (String(d["type"]) == "files") {
  240. Vector<String> files = d["files"];
  241. return files.size() != 0;
  242. }
  243. return false;
  244. }
  245. void ResourcePreloaderEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  246. if (!can_drop_data_fw(p_point, p_data, p_from)) {
  247. return;
  248. }
  249. Dictionary d = p_data;
  250. if (!d.has("type")) {
  251. return;
  252. }
  253. if (String(d["type"]) == "resource" && d.has("resource")) {
  254. Ref<Resource> r = d["resource"];
  255. if (r.is_valid()) {
  256. String basename;
  257. if (!r->get_name().is_empty()) {
  258. basename = r->get_name();
  259. } else if (r->get_path().is_resource_file()) {
  260. basename = r->get_path().get_basename();
  261. } else {
  262. basename = "Resource";
  263. }
  264. String name = basename;
  265. int counter = 0;
  266. while (preloader->has_resource(name)) {
  267. counter++;
  268. name = basename + "_" + itos(counter);
  269. }
  270. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  271. undo_redo->create_action(TTR("Add Resource"));
  272. undo_redo->add_do_method(preloader, "add_resource", name, r);
  273. undo_redo->add_undo_method(preloader, "remove_resource", name);
  274. undo_redo->add_do_method(this, "_update_library");
  275. undo_redo->add_undo_method(this, "_update_library");
  276. undo_redo->commit_action();
  277. }
  278. }
  279. if (String(d["type"]) == "files") {
  280. Vector<String> files = d["files"];
  281. _files_load_request(files);
  282. }
  283. }
  284. void ResourcePreloaderEditor::_bind_methods() {
  285. ClassDB::bind_method(D_METHOD("_update_library"), &ResourcePreloaderEditor::_update_library);
  286. ClassDB::bind_method(D_METHOD("_remove_resource", "to_remove"), &ResourcePreloaderEditor::_remove_resource);
  287. }
  288. ResourcePreloaderEditor::ResourcePreloaderEditor() {
  289. //add_style_override("panel", EditorNode::get_singleton()->get_gui_base()->get_stylebox("panel","Panel"));
  290. VBoxContainer *vbc = memnew(VBoxContainer);
  291. add_child(vbc);
  292. HBoxContainer *hbc = memnew(HBoxContainer);
  293. vbc->add_child(hbc);
  294. load = memnew(Button);
  295. load->set_tooltip_text(TTR("Load Resource"));
  296. hbc->add_child(load);
  297. paste = memnew(Button);
  298. paste->set_text(TTR("Paste"));
  299. hbc->add_child(paste);
  300. file = memnew(EditorFileDialog);
  301. add_child(file);
  302. tree = memnew(Tree);
  303. tree->connect("button_clicked", callable_mp(this, &ResourcePreloaderEditor::_cell_button_pressed));
  304. tree->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  305. tree->set_columns(2);
  306. tree->set_column_expand_ratio(0, 2);
  307. tree->set_column_clip_content(0, true);
  308. tree->set_column_expand_ratio(1, 3);
  309. tree->set_column_clip_content(1, true);
  310. tree->set_column_expand(0, true);
  311. tree->set_column_expand(1, true);
  312. tree->set_v_size_flags(SIZE_EXPAND_FILL);
  313. SET_DRAG_FORWARDING_GCD(tree, ResourcePreloaderEditor);
  314. vbc->add_child(tree);
  315. dialog = memnew(AcceptDialog);
  316. add_child(dialog);
  317. load->connect(SceneStringName(pressed), callable_mp(this, &ResourcePreloaderEditor::_load_pressed));
  318. paste->connect(SceneStringName(pressed), callable_mp(this, &ResourcePreloaderEditor::_paste_pressed));
  319. file->connect("files_selected", callable_mp(this, &ResourcePreloaderEditor::_files_load_request));
  320. tree->connect("item_edited", callable_mp(this, &ResourcePreloaderEditor::_item_edited));
  321. loading_scene = false;
  322. }
  323. void ResourcePreloaderEditorPlugin::edit(Object *p_object) {
  324. ResourcePreloader *s = Object::cast_to<ResourcePreloader>(p_object);
  325. if (!s) {
  326. return;
  327. }
  328. preloader_editor->edit(s);
  329. }
  330. bool ResourcePreloaderEditorPlugin::handles(Object *p_object) const {
  331. return p_object->is_class("ResourcePreloader");
  332. }
  333. void ResourcePreloaderEditorPlugin::make_visible(bool p_visible) {
  334. if (p_visible) {
  335. //preloader_editor->show();
  336. button->show();
  337. EditorNode::get_bottom_panel()->make_item_visible(preloader_editor);
  338. //preloader_editor->set_process(true);
  339. } else {
  340. if (preloader_editor->is_visible_in_tree()) {
  341. EditorNode::get_bottom_panel()->hide_bottom_panel();
  342. }
  343. button->hide();
  344. //preloader_editor->hide();
  345. //preloader_editor->set_process(false);
  346. }
  347. }
  348. ResourcePreloaderEditorPlugin::ResourcePreloaderEditorPlugin() {
  349. preloader_editor = memnew(ResourcePreloaderEditor);
  350. preloader_editor->set_custom_minimum_size(Size2(0, 250) * EDSCALE);
  351. button = EditorNode::get_bottom_panel()->add_item("ResourcePreloader", preloader_editor, ED_SHORTCUT_AND_COMMAND("bottom_panels/toggle_resource_preloader_bottom_panel", TTRC("Toggle ResourcePreloader Bottom Panel")));
  352. button->hide();
  353. }
  354. ResourcePreloaderEditorPlugin::~ResourcePreloaderEditorPlugin() {
  355. }