/*************************************************************************/ /* editor_resource_picker.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /*************************************************************************/ #include "editor_resource_picker.h" #include "editor/editor_resource_preview.h" #include "editor_node.h" #include "editor_scale.h" #include "editor_settings.h" #include "filesystem_dock.h" #include "scene/main/viewport.h" #include "core/object/class_db.h" #include "core/math/color.h" #include "core/variant/dictionary.h" #include "core/error/error_macros.h" #include "core/io/resource_loader.h" #include "core/containers/map.h" #include "core/math/math_defs.h" #include "core/math/rect2.h" #include "core/input/input_event.h" #include "core/os/memory.h" #include "core/containers/pair.h" #include "core/object/ref_ptr.h" #include "core/object/script_language.h" #include "core/string/string_name.h" #include "core/typedefs.h" #include "editor/editor_data.h" #include "editor/editor_file_dialog.h" #include "editor/editor_file_system.h" #include "editor/plugins/script_editor_plugin.h" #include "editor/property_editor.h" #include "editor/quick_open.h" #include "editor/scene_tree_dock.h" #include "scene/2d/canvas_item.h" #include "scene/gui/button.h" #include "scene/gui/control.h" #include "scene/gui/popup_menu.h" #include "scene/gui/tab_container.h" #include "scene/gui/texture_rect.h" #include "scene/main/node.h" #include "scene/resources/material.h" #include "scene/resources/shader.h" #include "scene/resources/style_box.h" #include "scene/resources/texture.h" HashMap> EditorResourcePicker::allowed_types_cache; void EditorResourcePicker::clear_caches() { allowed_types_cache.clear(); } void EditorResourcePicker::_update_resource() { preview_rect->set_texture(Ref()); assign_button->set_custom_minimum_size(Size2(1, 1)); if (edited_resource == RES()) { assign_button->set_icon(Ref()); assign_button->set_text(TTR("[empty]")); } else { assign_button->set_icon(EditorNode::get_singleton()->get_object_icon(edited_resource.operator->(), "Object")); if (edited_resource->get_name() != String()) { assign_button->set_text(edited_resource->get_name()); } else if (edited_resource->get_path().is_resource_file()) { assign_button->set_text(edited_resource->get_path().get_file()); assign_button->set_tooltip(edited_resource->get_path()); } else { assign_button->set_text(edited_resource->get_class()); } if (edited_resource->get_path().is_resource_file()) { assign_button->set_tooltip(edited_resource->get_path()); } // Preview will override the above, so called at the end. EditorResourcePreview::get_singleton()->queue_edited_resource_preview(edited_resource, this, "_update_resource_preview", edited_resource->get_instance_id()); } } void EditorResourcePicker::_update_resource_preview(const String &p_path, const Ref &p_preview, const Ref &p_small_preview, ObjectID p_obj) { if (!edited_resource.is_valid() || edited_resource->get_instance_id() != p_obj) { return; } String type = edited_resource->get_class_name(); if (ClassDB::class_exists(type) && ClassDB::is_parent_class(type, "Script")) { assign_button->set_text(edited_resource->get_path().get_file()); return; } if (p_preview.is_valid()) { preview_rect->set_margin(MARGIN_LEFT, assign_button->get_icon()->get_width() + assign_button->get_theme_stylebox("normal")->get_default_margin(MARGIN_LEFT) + get_theme_constant("hseparation", "Button")); if (type == "GradientTexture" || type == "Gradient") { preview_rect->set_stretch_mode(TextureRect::STRETCH_SCALE); assign_button->set_custom_minimum_size(Size2(1, 1)); } else { preview_rect->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED); int thumbnail_size = EditorSettings::get_singleton()->get("filesystem/file_dialog/thumbnail_size"); thumbnail_size *= EDSCALE; assign_button->set_custom_minimum_size(Size2(1, thumbnail_size)); } preview_rect->set_texture(p_preview); assign_button->set_text(""); } } void EditorResourcePicker::_resource_selected() { if (edited_resource.is_null()) { edit_button->set_pressed(true); _update_menu(); return; } emit_signal("resource_selected", edited_resource, false); } void EditorResourcePicker::_file_selected(const String &p_path) { RES loaded_resource = ResourceLoader::load(p_path); ERR_FAIL_COND_MSG(loaded_resource.is_null(), "Cannot load resource from path '" + p_path + "'."); if (base_type != "") { bool any_type_matches = false; for (int i = 0; i < base_type.get_slice_count(","); i++) { String base = base_type.get_slice(",", i); if (loaded_resource->is_class(base)) { any_type_matches = true; break; } } if (!any_type_matches) { EditorNode::get_singleton()->show_warning(vformat(TTR("The selected resource (%s) does not match any type expected for this property (%s)."), loaded_resource->get_class(), base_type)); return; } } edited_resource = loaded_resource; emit_signal("resource_changed", edited_resource); _update_resource(); } void EditorResourcePicker::_file_quick_selected() { _file_selected(quick_open->get_selected()); } void EditorResourcePicker::_update_menu() { _update_menu_items(); Rect2 gt = edit_button->get_global_rect(); edit_menu->set_as_minsize(); int ms = edit_menu->get_combined_minimum_size().width; Vector2 popup_pos = gt.position + gt.size - Vector2(ms, 0); edit_menu->set_global_position(popup_pos); edit_menu->popup(); } void EditorResourcePicker::_update_menu_items() { edit_menu->clear(); // Add options for creating specific subtypes of the base resource type. set_create_options(edit_menu); // Add an option to load a resource from a file using the QuickOpen dialog. edit_menu->add_icon_item(get_theme_icon("Load", "EditorIcons"), TTR("Quick Load"), OBJ_MENU_QUICKLOAD); // Add an option to load a resource from a file using the regular file dialog. edit_menu->add_icon_item(get_theme_icon("Load", "EditorIcons"), TTR("Load"), OBJ_MENU_LOAD); // Add options for changing existing value of the resource. if (edited_resource.is_valid()) { edit_menu->add_icon_item(get_theme_icon("Edit", "EditorIcons"), TTR("Edit"), OBJ_MENU_EDIT); edit_menu->add_icon_item(get_theme_icon("Clear", "EditorIcons"), TTR("Clear"), OBJ_MENU_CLEAR); edit_menu->add_icon_item(get_theme_icon("Duplicate", "EditorIcons"), TTR("Make Unique"), OBJ_MENU_MAKE_UNIQUE); edit_menu->add_icon_item(get_theme_icon("Save", "EditorIcons"), TTR("Save"), OBJ_MENU_SAVE); if (edited_resource->get_path().is_resource_file()) { edit_menu->add_separator(); edit_menu->add_item(TTR("Show in FileSystem"), OBJ_MENU_SHOW_IN_FILE_SYSTEM); } } // Add options to copy/paste resource. RES cb = EditorSettings::get_singleton()->get_resource_clipboard(); bool paste_valid = false; if (cb.is_valid()) { if (base_type == "") { paste_valid = true; } else { for (int i = 0; i < base_type.get_slice_count(","); i++) { if (ClassDB::class_exists(cb->get_class()) && ClassDB::is_parent_class(cb->get_class(), base_type.get_slice(",", i))) { paste_valid = true; break; } } } } if (edited_resource.is_valid() || paste_valid) { edit_menu->add_separator(); if (edited_resource.is_valid()) { edit_menu->add_item(TTR("Copy"), OBJ_MENU_COPY); } if (paste_valid) { edit_menu->add_item(TTR("Paste"), OBJ_MENU_PASTE); } } // Add options to convert existing resource to another type of resource. if (edited_resource.is_valid()) { Vector> conversions = EditorNode::get_singleton()->find_resource_conversion_plugin(edited_resource); if (conversions.size()) { edit_menu->add_separator(); } for (int i = 0; i < conversions.size(); i++) { String what = conversions[i]->converts_to(); Ref icon; if (has_theme_icon(what, "EditorIcons")) { icon = get_theme_icon(what, "EditorIcons"); } else { icon = get_theme_icon(what, "Resource"); } edit_menu->add_icon_item(icon, vformat(TTR("Convert to %s"), what), CONVERT_BASE_ID + i); } } } void EditorResourcePicker::_edit_menu_cbk(int p_which) { switch (p_which) { case OBJ_MENU_LOAD: { List extensions; for (int i = 0; i < base_type.get_slice_count(","); i++) { String base = base_type.get_slice(",", i); ResourceLoader::get_recognized_extensions_for_type(base, &extensions); } Set valid_extensions; for (List::Element *E = extensions.front(); E; E = E->next()) { valid_extensions.insert(E->get()); } if (!file_dialog) { file_dialog = memnew(EditorFileDialog); file_dialog->set_mode(EditorFileDialog::MODE_OPEN_FILE); add_child(file_dialog); file_dialog->connect("file_selected", this, "_file_selected"); } file_dialog->clear_filters(); for (Set::Element *E = valid_extensions.front(); E; E = E->next()) { file_dialog->add_filter("*." + E->get() + " ; " + E->get().to_upper()); } file_dialog->popup_centered_ratio(); } break; case OBJ_MENU_QUICKLOAD: { if (!quick_open) { quick_open = memnew(EditorQuickOpen); add_child(quick_open); quick_open->connect("quick_open", this, "_file_quick_selected"); } quick_open->popup_dialog(base_type); quick_open->set_title(TTR("Resource")); } break; case OBJ_MENU_EDIT: { if (edited_resource.is_valid()) { emit_signal("resource_selected", edited_resource, true); } } break; case OBJ_MENU_CLEAR: { edited_resource = RES(); emit_signal("resource_changed", edited_resource); _update_resource(); } break; case OBJ_MENU_MAKE_UNIQUE: { if (edited_resource.is_null()) { return; } List property_list; edited_resource->get_property_list(&property_list); List> propvalues; for (List::Element *E = property_list.front(); E; E = E->next()) { Pair p; PropertyInfo &pi = E->get(); if (pi.usage & PROPERTY_USAGE_STORAGE) { p.first = pi.name; p.second = edited_resource->get(pi.name); } propvalues.push_back(p); } String orig_type = edited_resource->get_class(); Object *inst = ClassDB::instance(orig_type); Ref unique_resource = Ref(Object::cast_to(inst)); ERR_FAIL_COND(unique_resource.is_null()); for (List>::Element *E = propvalues.front(); E; E = E->next()) { Pair &p = E->get(); unique_resource->set(p.first, p.second); } edited_resource = unique_resource; emit_signal("resource_changed", edited_resource); _update_resource(); } break; case OBJ_MENU_SAVE: { if (edited_resource.is_null()) { return; } EditorNode::get_singleton()->save_resource(edited_resource); } break; case OBJ_MENU_COPY: { EditorSettings::get_singleton()->set_resource_clipboard(edited_resource); } break; case OBJ_MENU_PASTE: { edited_resource = EditorSettings::get_singleton()->get_resource_clipboard(); emit_signal("resource_changed", edited_resource); _update_resource(); } break; case OBJ_MENU_SHOW_IN_FILE_SYSTEM: { FileSystemDock *file_system_dock = EditorNode::get_singleton()->get_filesystem_dock(); file_system_dock->navigate_to_path(edited_resource->get_path()); // Ensure that the FileSystem dock is visible. TabContainer *tab_container = (TabContainer *)file_system_dock->get_parent_control(); tab_container->set_current_tab(file_system_dock->get_index()); } break; default: { // Allow subclasses to handle their own options first, only then fallback on the default branch logic. if (handle_menu_selected(p_which)) { break; } if (p_which >= CONVERT_BASE_ID) { int to_type = p_which - CONVERT_BASE_ID; Vector> conversions = EditorNode::get_singleton()->find_resource_conversion_plugin(edited_resource); ERR_FAIL_INDEX(to_type, conversions.size()); edited_resource = conversions[to_type]->convert(edited_resource); emit_signal("resource_changed", edited_resource); _update_resource(); break; } ERR_FAIL_COND(inheritors_array.empty()); String intype = inheritors_array[p_which - TYPE_BASE_ID]; Variant obj; if (ScriptServer::is_global_class(intype)) { obj = ClassDB::instance(ScriptServer::get_global_class_native_base(intype)); if (obj) { Ref