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) 2007-2020 Juan Linietsky, Ariel Manzur.                 */
9 /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md).   */
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 
31 #include "resource_preloader_editor_plugin.h"
32 
33 #include "core/io/resource_loader.h"
34 #include "core/project_settings.h"
35 #include "editor/editor_scale.h"
36 #include "editor/editor_settings.h"
37 
_gui_input(Ref<InputEvent> p_event)38 void ResourcePreloaderEditor::_gui_input(Ref<InputEvent> p_event) {
39 }
40 
_notification(int p_what)41 void ResourcePreloaderEditor::_notification(int p_what) {
42 
43 	if (p_what == NOTIFICATION_ENTER_TREE) {
44 		load->set_icon(get_icon("Folder", "EditorIcons"));
45 	}
46 
47 	if (p_what == NOTIFICATION_READY) {
48 
49 		//NodePath("/root")->connect("node_removed", this,"_node_removed",Vector<Variant>(),true);
50 	}
51 
52 	if (p_what == NOTIFICATION_DRAW) {
53 	}
54 }
55 
_files_load_request(const Vector<String> & p_paths)56 void ResourcePreloaderEditor::_files_load_request(const Vector<String> &p_paths) {
57 
58 	for (int i = 0; i < p_paths.size(); i++) {
59 
60 		String path = p_paths[i];
61 
62 		RES resource;
63 		resource = ResourceLoader::load(path);
64 
65 		if (resource.is_null()) {
66 			dialog->set_text(TTR("ERROR: Couldn't load resource!"));
67 			dialog->set_title(TTR("Error!"));
68 			//dialog->get_cancel()->set_text("Close");
69 			dialog->get_ok()->set_text(TTR("Close"));
70 			dialog->popup_centered_minsize();
71 			return; ///beh should show an error i guess
72 		}
73 
74 		String basename = path.get_file().get_basename();
75 		String name = basename;
76 		int counter = 1;
77 		while (preloader->has_resource(name)) {
78 			counter++;
79 			name = basename + " " + itos(counter);
80 		}
81 
82 		undo_redo->create_action(TTR("Add Resource"));
83 		undo_redo->add_do_method(preloader, "add_resource", name, resource);
84 		undo_redo->add_undo_method(preloader, "remove_resource", name);
85 		undo_redo->add_do_method(this, "_update_library");
86 		undo_redo->add_undo_method(this, "_update_library");
87 		undo_redo->commit_action();
88 	}
89 }
90 
_load_pressed()91 void ResourcePreloaderEditor::_load_pressed() {
92 
93 	loading_scene = false;
94 
95 	file->clear_filters();
96 	List<String> extensions;
97 	ResourceLoader::get_recognized_extensions_for_type("", &extensions);
98 	for (int i = 0; i < extensions.size(); i++)
99 		file->add_filter("*." + extensions[i]);
100 
101 	file->set_mode(EditorFileDialog::MODE_OPEN_FILES);
102 
103 	file->popup_centered_ratio();
104 }
105 
_item_edited()106 void ResourcePreloaderEditor::_item_edited() {
107 
108 	if (!tree->get_selected())
109 		return;
110 
111 	TreeItem *s = tree->get_selected();
112 
113 	if (tree->get_selected_column() == 0) {
114 		// renamed
115 		String old_name = s->get_metadata(0);
116 		String new_name = s->get_text(0);
117 		if (old_name == new_name)
118 			return;
119 
120 		if (new_name == "" || new_name.find("\\") != -1 || new_name.find("/") != -1 || preloader->has_resource(new_name)) {
121 
122 			s->set_text(0, old_name);
123 			return;
124 		}
125 
126 		RES samp = preloader->get_resource(old_name);
127 		undo_redo->create_action(TTR("Rename Resource"));
128 		undo_redo->add_do_method(preloader, "remove_resource", old_name);
129 		undo_redo->add_do_method(preloader, "add_resource", new_name, samp);
130 		undo_redo->add_undo_method(preloader, "remove_resource", new_name);
131 		undo_redo->add_undo_method(preloader, "add_resource", old_name, samp);
132 		undo_redo->add_do_method(this, "_update_library");
133 		undo_redo->add_undo_method(this, "_update_library");
134 		undo_redo->commit_action();
135 	}
136 }
137 
_remove_resource(const String & p_to_remove)138 void ResourcePreloaderEditor::_remove_resource(const String &p_to_remove) {
139 
140 	undo_redo->create_action(TTR("Delete Resource"));
141 	undo_redo->add_do_method(preloader, "remove_resource", p_to_remove);
142 	undo_redo->add_undo_method(preloader, "add_resource", p_to_remove, preloader->get_resource(p_to_remove));
143 	undo_redo->add_do_method(this, "_update_library");
144 	undo_redo->add_undo_method(this, "_update_library");
145 	undo_redo->commit_action();
146 }
147 
_paste_pressed()148 void ResourcePreloaderEditor::_paste_pressed() {
149 
150 	RES r = EditorSettings::get_singleton()->get_resource_clipboard();
151 	if (!r.is_valid()) {
152 		dialog->set_text(TTR("Resource clipboard is empty!"));
153 		dialog->set_title(TTR("Error!"));
154 		dialog->get_ok()->set_text(TTR("Close"));
155 		dialog->popup_centered_minsize();
156 		return; ///beh should show an error i guess
157 	}
158 
159 	String name = r->get_name();
160 	if (name == "")
161 		name = r->get_path().get_file();
162 	if (name == "")
163 		name = r->get_class();
164 
165 	String basename = name;
166 	int counter = 1;
167 	while (preloader->has_resource(name)) {
168 		counter++;
169 		name = basename + " " + itos(counter);
170 	}
171 
172 	undo_redo->create_action(TTR("Paste Resource"));
173 	undo_redo->add_do_method(preloader, "add_resource", name, r);
174 	undo_redo->add_undo_method(preloader, "remove_resource", name);
175 	undo_redo->add_do_method(this, "_update_library");
176 	undo_redo->add_undo_method(this, "_update_library");
177 	undo_redo->commit_action();
178 }
179 
_update_library()180 void ResourcePreloaderEditor::_update_library() {
181 
182 	tree->clear();
183 	tree->set_hide_root(true);
184 	TreeItem *root = tree->create_item(NULL);
185 
186 	List<StringName> rnames;
187 	preloader->get_resource_list(&rnames);
188 
189 	List<String> names;
190 	for (List<StringName>::Element *E = rnames.front(); E; E = E->next()) {
191 		names.push_back(E->get());
192 	}
193 
194 	names.sort();
195 
196 	for (List<String>::Element *E = names.front(); E; E = E->next()) {
197 
198 		TreeItem *ti = tree->create_item(root);
199 		ti->set_cell_mode(0, TreeItem::CELL_MODE_STRING);
200 		ti->set_editable(0, true);
201 		ti->set_selectable(0, true);
202 		ti->set_text(0, E->get());
203 		ti->set_metadata(0, E->get());
204 
205 		RES r = preloader->get_resource(E->get());
206 
207 		ERR_CONTINUE(r.is_null());
208 
209 		String type = r->get_class();
210 		ti->set_icon(0, EditorNode::get_singleton()->get_class_icon(type, "Object"));
211 		ti->set_tooltip(0, TTR("Instance:") + " " + r->get_path() + "\n" + TTR("Type:") + " " + type);
212 
213 		ti->set_text(1, r->get_path());
214 		ti->set_editable(1, false);
215 		ti->set_selectable(1, false);
216 
217 		if (type == "PackedScene") {
218 			ti->add_button(1, get_icon("InstanceOptions", "EditorIcons"), BUTTON_OPEN_SCENE, false, TTR("Open in Editor"));
219 		} else {
220 			ti->add_button(1, get_icon("Load", "EditorIcons"), BUTTON_EDIT_RESOURCE, false, TTR("Open in Editor"));
221 		}
222 		ti->add_button(1, get_icon("Remove", "EditorIcons"), BUTTON_REMOVE, false, TTR("Remove"));
223 	}
224 
225 	//player->add_resource("default",resource);
226 }
227 
_cell_button_pressed(Object * p_item,int p_column,int p_id)228 void ResourcePreloaderEditor::_cell_button_pressed(Object *p_item, int p_column, int p_id) {
229 
230 	TreeItem *item = Object::cast_to<TreeItem>(p_item);
231 	ERR_FAIL_COND(!item);
232 
233 	if (p_id == BUTTON_OPEN_SCENE) {
234 		String rpath = item->get_text(p_column);
235 		EditorInterface::get_singleton()->open_scene_from_path(rpath);
236 
237 	} else if (p_id == BUTTON_EDIT_RESOURCE) {
238 		RES r = preloader->get_resource(item->get_text(0));
239 		EditorInterface::get_singleton()->edit_resource(r);
240 
241 	} else if (p_id == BUTTON_REMOVE) {
242 		_remove_resource(item->get_text(0));
243 	}
244 }
245 
edit(ResourcePreloader * p_preloader)246 void ResourcePreloaderEditor::edit(ResourcePreloader *p_preloader) {
247 
248 	preloader = p_preloader;
249 
250 	if (p_preloader) {
251 		_update_library();
252 	} else {
253 
254 		hide();
255 		set_physics_process(false);
256 	}
257 }
258 
get_drag_data_fw(const Point2 & p_point,Control * p_from)259 Variant ResourcePreloaderEditor::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
260 
261 	TreeItem *ti = tree->get_item_at_position(p_point);
262 	if (!ti)
263 		return Variant();
264 
265 	String name = ti->get_metadata(0);
266 
267 	RES res = preloader->get_resource(name);
268 	if (!res.is_valid())
269 		return Variant();
270 
271 	return EditorNode::get_singleton()->drag_resource(res, p_from);
272 }
273 
can_drop_data_fw(const Point2 & p_point,const Variant & p_data,Control * p_from) const274 bool ResourcePreloaderEditor::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
275 
276 	Dictionary d = p_data;
277 
278 	if (!d.has("type"))
279 		return false;
280 
281 	if (d.has("from") && (Object *)(d["from"]) == tree)
282 		return false;
283 
284 	if (String(d["type"]) == "resource" && d.has("resource")) {
285 		RES r = d["resource"];
286 
287 		return r.is_valid();
288 	}
289 
290 	if (String(d["type"]) == "files") {
291 
292 		Vector<String> files = d["files"];
293 
294 		return files.size() != 0;
295 	}
296 	return false;
297 }
298 
drop_data_fw(const Point2 & p_point,const Variant & p_data,Control * p_from)299 void ResourcePreloaderEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
300 
301 	if (!can_drop_data_fw(p_point, p_data, p_from))
302 		return;
303 
304 	Dictionary d = p_data;
305 
306 	if (!d.has("type"))
307 		return;
308 
309 	if (String(d["type"]) == "resource" && d.has("resource")) {
310 		RES r = d["resource"];
311 
312 		if (r.is_valid()) {
313 
314 			String basename;
315 			if (r->get_name() != "") {
316 				basename = r->get_name();
317 			} else if (r->get_path().is_resource_file()) {
318 				basename = r->get_path().get_basename();
319 			} else {
320 				basename = "Resource";
321 			}
322 
323 			String name = basename;
324 			int counter = 0;
325 			while (preloader->has_resource(name)) {
326 				counter++;
327 				name = basename + "_" + itos(counter);
328 			}
329 
330 			undo_redo->create_action(TTR("Add Resource"));
331 			undo_redo->add_do_method(preloader, "add_resource", name, r);
332 			undo_redo->add_undo_method(preloader, "remove_resource", name);
333 			undo_redo->add_do_method(this, "_update_library");
334 			undo_redo->add_undo_method(this, "_update_library");
335 			undo_redo->commit_action();
336 		}
337 	}
338 
339 	if (String(d["type"]) == "files") {
340 
341 		Vector<String> files = d["files"];
342 
343 		_files_load_request(files);
344 	}
345 }
346 
_bind_methods()347 void ResourcePreloaderEditor::_bind_methods() {
348 
349 	ClassDB::bind_method(D_METHOD("_gui_input"), &ResourcePreloaderEditor::_gui_input);
350 	ClassDB::bind_method(D_METHOD("_load_pressed"), &ResourcePreloaderEditor::_load_pressed);
351 	ClassDB::bind_method(D_METHOD("_item_edited"), &ResourcePreloaderEditor::_item_edited);
352 	ClassDB::bind_method(D_METHOD("_paste_pressed"), &ResourcePreloaderEditor::_paste_pressed);
353 	ClassDB::bind_method(D_METHOD("_files_load_request"), &ResourcePreloaderEditor::_files_load_request);
354 	ClassDB::bind_method(D_METHOD("_update_library"), &ResourcePreloaderEditor::_update_library);
355 	ClassDB::bind_method(D_METHOD("_cell_button_pressed"), &ResourcePreloaderEditor::_cell_button_pressed);
356 	ClassDB::bind_method(D_METHOD("_remove_resource", "to_remove"), &ResourcePreloaderEditor::_remove_resource);
357 
358 	ClassDB::bind_method(D_METHOD("get_drag_data_fw"), &ResourcePreloaderEditor::get_drag_data_fw);
359 	ClassDB::bind_method(D_METHOD("can_drop_data_fw"), &ResourcePreloaderEditor::can_drop_data_fw);
360 	ClassDB::bind_method(D_METHOD("drop_data_fw"), &ResourcePreloaderEditor::drop_data_fw);
361 }
362 
ResourcePreloaderEditor()363 ResourcePreloaderEditor::ResourcePreloaderEditor() {
364 
365 	//add_style_override("panel", EditorNode::get_singleton()->get_gui_base()->get_stylebox("panel","Panel"));
366 
367 	VBoxContainer *vbc = memnew(VBoxContainer);
368 	add_child(vbc);
369 
370 	HBoxContainer *hbc = memnew(HBoxContainer);
371 	vbc->add_child(hbc);
372 
373 	load = memnew(Button);
374 	load->set_tooltip(TTR("Load Resource"));
375 	hbc->add_child(load);
376 
377 	paste = memnew(Button);
378 	paste->set_text(TTR("Paste"));
379 	hbc->add_child(paste);
380 
381 	file = memnew(EditorFileDialog);
382 	add_child(file);
383 
384 	tree = memnew(Tree);
385 	tree->connect("button_pressed", this, "_cell_button_pressed");
386 	tree->set_columns(2);
387 	tree->set_column_min_width(0, 2);
388 	tree->set_column_min_width(1, 3);
389 	tree->set_column_expand(0, true);
390 	tree->set_column_expand(1, true);
391 	tree->set_v_size_flags(SIZE_EXPAND_FILL);
392 
393 	tree->set_drag_forwarding(this);
394 	vbc->add_child(tree);
395 
396 	dialog = memnew(AcceptDialog);
397 	add_child(dialog);
398 
399 	load->connect("pressed", this, "_load_pressed");
400 	paste->connect("pressed", this, "_paste_pressed");
401 	file->connect("files_selected", this, "_files_load_request");
402 	tree->connect("item_edited", this, "_item_edited");
403 	loading_scene = false;
404 }
405 
edit(Object * p_object)406 void ResourcePreloaderEditorPlugin::edit(Object *p_object) {
407 
408 	preloader_editor->set_undo_redo(&get_undo_redo());
409 	ResourcePreloader *s = Object::cast_to<ResourcePreloader>(p_object);
410 	if (!s)
411 		return;
412 
413 	preloader_editor->edit(s);
414 }
415 
handles(Object * p_object) const416 bool ResourcePreloaderEditorPlugin::handles(Object *p_object) const {
417 
418 	return p_object->is_class("ResourcePreloader");
419 }
420 
make_visible(bool p_visible)421 void ResourcePreloaderEditorPlugin::make_visible(bool p_visible) {
422 
423 	if (p_visible) {
424 		//preloader_editor->show();
425 		button->show();
426 		editor->make_bottom_panel_item_visible(preloader_editor);
427 		//preloader_editor->set_process(true);
428 	} else {
429 
430 		if (preloader_editor->is_visible_in_tree())
431 			editor->hide_bottom_panel();
432 		button->hide();
433 		//preloader_editor->hide();
434 		//preloader_editor->set_process(false);
435 	}
436 }
437 
ResourcePreloaderEditorPlugin(EditorNode * p_node)438 ResourcePreloaderEditorPlugin::ResourcePreloaderEditorPlugin(EditorNode *p_node) {
439 
440 	editor = p_node;
441 	preloader_editor = memnew(ResourcePreloaderEditor);
442 	preloader_editor->set_custom_minimum_size(Size2(0, 250) * EDSCALE);
443 
444 	button = editor->add_bottom_panel_item(TTR("ResourcePreloader"), preloader_editor);
445 	button->hide();
446 
447 	//preloader_editor->set_anchor( MARGIN_TOP, Control::ANCHOR_END);
448 	//preloader_editor->set_margin( MARGIN_TOP, 120 );
449 }
450 
~ResourcePreloaderEditorPlugin()451 ResourcePreloaderEditorPlugin::~ResourcePreloaderEditorPlugin() {
452 }
453