/*************************************************************************/ /* import_dock.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2021 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 "import_dock.h" #include "editor_node.h" #include "editor_resource_preview.h" class ImportDockParameters : public Object { GDCLASS(ImportDockParameters, Object); public: Map values; List properties; Ref importer; Vector paths; Set checked; bool checking; bool _set(const StringName &p_name, const Variant &p_value) { if (values.has(p_name)) { values[p_name] = p_value; if (checking) { checked.insert(p_name); notify_property_list_changed(); } return true; } return false; } bool _get(const StringName &p_name, Variant &r_ret) const { if (values.has(p_name)) { r_ret = values[p_name]; return true; } return false; } void _get_property_list(List *p_list) const { for (const PropertyInfo &E : properties) { if (!importer->get_option_visibility(E.name, values)) { continue; } PropertyInfo pi = E; if (checking) { pi.usage |= PROPERTY_USAGE_CHECKABLE; if (checked.has(E.name)) { pi.usage |= PROPERTY_USAGE_CHECKED; } } p_list->push_back(pi); } } void update() { notify_property_list_changed(); } ImportDockParameters() { checking = false; } }; void ImportDock::set_edit_path(const String &p_path) { Ref config; config.instantiate(); Error err = config->load(p_path + ".import"); if (err != OK) { clear(); return; } String importer_name = config->get_value("remap", "importer"); params->importer = ResourceFormatImporter::get_singleton()->get_importer_by_name(importer_name); params->paths.clear(); params->paths.push_back(p_path); _update_options(config); List> importers; ResourceFormatImporter::get_singleton()->get_importers_for_extension(p_path.get_extension(), &importers); List> importer_names; for (Ref E : importers) { importer_names.push_back(Pair(E->get_visible_name(), E->get_importer_name())); } importer_names.sort_custom>(); import_as->clear(); for (Pair &E : importer_names) { import_as->add_item(E.first); import_as->set_item_metadata(import_as->get_item_count() - 1, E.second); if (E.second == importer_name) { import_as->select(import_as->get_item_count() - 1); } } import_as->add_separator(); import_as->add_item(TTR("Keep File (No Import)")); import_as->set_item_metadata(import_as->get_item_count() - 1, "keep"); if (importer_name == "keep") { import_as->select(import_as->get_item_count() - 1); } import->set_disabled(false); import_as->set_disabled(false); preset->set_disabled(false); imported->set_text(p_path.get_file()); } void ImportDock::_update_options(const Ref &p_config) { List options; if (params->importer.is_valid()) { params->importer->get_import_options(&options); } params->properties.clear(); params->values.clear(); params->checking = params->paths.size() > 1; params->checked.clear(); for (ResourceImporter::ImportOption &E : options) { params->properties.push_back(E.option); if (p_config.is_valid() && p_config->has_section_key("params", E.option.name)) { params->values[E.option.name] = p_config->get_value("params", E.option.name); } else { params->values[E.option.name] = E.default_value; } } params->update(); _update_preset_menu(); if (params->importer.is_valid() && params->paths.size() == 1 && params->importer->has_advanced_options()) { advanced->show(); advanced_spacer->show(); } else { advanced->hide(); advanced_spacer->hide(); } } void ImportDock::set_edit_multiple_paths(const Vector &p_paths) { clear(); // Use the value that is repeated the most. Map value_frequency; for (int i = 0; i < p_paths.size(); i++) { Ref config; config.instantiate(); Error err = config->load(p_paths[i] + ".import"); ERR_CONTINUE(err != OK); if (i == 0) { params->importer = ResourceFormatImporter::get_singleton()->get_importer_by_name(config->get_value("remap", "importer")); if (params->importer.is_null()) { clear(); return; } } if (!config->has_section("params")) { continue; } List keys; config->get_section_keys("params", &keys); for (String &E : keys) { if (!value_frequency.has(E)) { value_frequency[E] = Dictionary(); } Variant value = config->get_value("params", E); if (value_frequency[E].has(value)) { value_frequency[E][value] = int(value_frequency[E][value]) + 1; } else { value_frequency[E][value] = 1; } } } ERR_FAIL_COND(params->importer.is_null()); List options; params->importer->get_import_options(&options); params->properties.clear(); params->values.clear(); params->checking = true; params->checked.clear(); for (ResourceImporter::ImportOption &E : options) { params->properties.push_back(E.option); if (value_frequency.has(E.option.name)) { Dictionary d = value_frequency[E.option.name]; int freq = 0; List v; d.get_key_list(&v); Variant value; for (Variant &F : v) { int f = d[F]; if (f > freq) { value = F; } } params->values[E.option.name] = value; } else { params->values[E.option.name] = E.default_value; } } params->update(); List> importers; ResourceFormatImporter::get_singleton()->get_importers_for_extension(p_paths[0].get_extension(), &importers); List> importer_names; for (Ref E : importers) { importer_names.push_back(Pair(E->get_visible_name(), E->get_importer_name())); } importer_names.sort_custom>(); import_as->clear(); for (Pair &E : importer_names) { import_as->add_item(E.first); import_as->set_item_metadata(import_as->get_item_count() - 1, E.second); if (E.second == params->importer->get_importer_name()) { import_as->select(import_as->get_item_count() - 1); } } _update_preset_menu(); params->paths = p_paths; import->set_disabled(false); import_as->set_disabled(false); preset->set_disabled(false); imported->set_text(vformat(TTR("%d Files"), p_paths.size())); if (params->paths.size() == 1 && params->importer->has_advanced_options()) { advanced->show(); advanced_spacer->show(); } else { advanced->hide(); advanced_spacer->hide(); } } void ImportDock::_update_preset_menu() { preset->get_popup()->clear(); if (params->importer.is_null()) { preset->get_popup()->add_item(TTR("Default")); preset->hide(); return; } preset->show(); if (params->importer->get_preset_count() == 0) { preset->get_popup()->add_item(TTR("Default")); } else { for (int i = 0; i < params->importer->get_preset_count(); i++) { preset->get_popup()->add_item(params->importer->get_preset_name(i)); } } preset->get_popup()->add_separator(); preset->get_popup()->add_item(vformat(TTR("Set as Default for '%s'"), params->importer->get_visible_name()), ITEM_SET_AS_DEFAULT); if (ProjectSettings::get_singleton()->has_setting("importer_defaults/" + params->importer->get_importer_name())) { preset->get_popup()->add_item(TTR("Load Default"), ITEM_LOAD_DEFAULT); preset->get_popup()->add_separator(); preset->get_popup()->add_item(vformat(TTR("Clear Default for '%s'"), params->importer->get_visible_name()), ITEM_CLEAR_DEFAULT); } } void ImportDock::_importer_selected(int i_idx) { String name = import_as->get_selected_metadata(); if (name == "keep") { params->importer.unref(); _update_options(Ref()); } else { Ref importer = ResourceFormatImporter::get_singleton()->get_importer_by_name(name); ERR_FAIL_COND(importer.is_null()); params->importer = importer; Ref config; if (params->paths.size()) { config.instantiate(); Error err = config->load(params->paths[0] + ".import"); if (err != OK) { config.unref(); } } _update_options(config); } } void ImportDock::_preset_selected(int p_idx) { int item_id = preset->get_popup()->get_item_id(p_idx); switch (item_id) { case ITEM_SET_AS_DEFAULT: { Dictionary d; for (const PropertyInfo &E : params->properties) { d[E.name] = params->values[E.name]; } ProjectSettings::get_singleton()->set("importer_defaults/" + params->importer->get_importer_name(), d); ProjectSettings::get_singleton()->save(); _update_preset_menu(); } break; case ITEM_LOAD_DEFAULT: { ERR_FAIL_COND(!ProjectSettings::get_singleton()->has_setting("importer_defaults/" + params->importer->get_importer_name())); Dictionary d = ProjectSettings::get_singleton()->get("importer_defaults/" + params->importer->get_importer_name()); List v; d.get_key_list(&v); if (params->checking) { params->checked.clear(); } for (Variant &E : v) { params->values[E] = d[E]; if (params->checking) { params->checked.insert(E); } } params->update(); } break; case ITEM_CLEAR_DEFAULT: { ProjectSettings::get_singleton()->set("importer_defaults/" + params->importer->get_importer_name(), Variant()); ProjectSettings::get_singleton()->save(); _update_preset_menu(); } break; default: { List options; params->importer->get_import_options(&options, p_idx); if (params->checking) { params->checked.clear(); } for (ResourceImporter::ImportOption &E : options) { params->values[E.option.name] = E.default_value; if (params->checking) { params->checked.insert(E.option.name); } } params->update(); } break; } } void ImportDock::clear() { imported->set_text(""); import->set_disabled(true); import_as->clear(); import_as->set_disabled(true); preset->set_disabled(true); params->values.clear(); params->properties.clear(); params->update(); preset->get_popup()->clear(); } static bool _find_owners(EditorFileSystemDirectory *efsd, const String &p_path) { if (!efsd) { return false; } for (int i = 0; i < efsd->get_subdir_count(); i++) { if (_find_owners(efsd->get_subdir(i), p_path)) { return true; } } for (int i = 0; i < efsd->get_file_count(); i++) { Vector deps = efsd->get_file_deps(i); if (deps.find(p_path) != -1) { return true; } } return false; } void ImportDock::_reimport_attempt() { bool need_restart = false; bool used_in_resources = false; String importer_name; if (params->importer.is_valid()) { importer_name = params->importer->get_importer_name(); } else { importer_name = "keep"; } for (int i = 0; i < params->paths.size(); i++) { Ref config; config.instantiate(); Error err = config->load(params->paths[i] + ".import"); ERR_CONTINUE(err != OK); String imported_with = config->get_value("remap", "importer"); if (imported_with != importer_name) { need_restart = true; if (_find_owners(EditorFileSystem::get_singleton()->get_filesystem(), params->paths[i])) { used_in_resources = true; } } } if (need_restart) { label_warning->set_visible(used_in_resources); reimport_confirm->popup_centered(); return; } _reimport(); } void ImportDock::_reimport_and_restart() { EditorNode::get_singleton()->save_all_scenes(); EditorResourcePreview::get_singleton()->stop(); //don't try to re-create previews after import _reimport(); EditorNode::get_singleton()->restart_editor(); } void ImportDock::_advanced_options() { if (params->paths.size() == 1 && params->importer.is_valid()) { params->importer->show_advanced_options(params->paths[0]); } } void ImportDock::_reimport() { for (int i = 0; i < params->paths.size(); i++) { Ref config; config.instantiate(); Error err = config->load(params->paths[i] + ".import"); ERR_CONTINUE(err != OK); if (params->importer.is_valid()) { String importer_name = params->importer->get_importer_name(); if (params->checking && config->get_value("remap", "importer") == params->importer->get_importer_name()) { //update only what is edited (checkboxes) if the importer is the same for (PropertyInfo &E : params->properties) { if (params->checked.has(E.name)) { config->set_value("params", E.name, params->values[E.name]); } } } else { //override entirely config->set_value("remap", "importer", importer_name); if (config->has_section("params")) { config->erase_section("params"); } for (PropertyInfo &E : params->properties) { config->set_value("params", E.name, params->values[E.name]); } } //handle group file Ref importer = ResourceFormatImporter::get_singleton()->get_importer_by_name(importer_name); ERR_CONTINUE(!importer.is_valid()); String group_file_property = importer->get_option_group_file(); if (group_file_property != String()) { //can import from a group (as in, atlas) ERR_CONTINUE(!params->values.has(group_file_property)); String group_file = params->values[group_file_property]; config->set_value("remap", "group_file", group_file); } else { config->set_value("remap", "group_file", Variant()); //clear group file if unused } } else { //set to no import config->clear(); config->set_value("remap", "importer", "keep"); } config->save(params->paths[i] + ".import"); } EditorFileSystem::get_singleton()->reimport_files(params->paths); EditorFileSystem::get_singleton()->emit_signal(SNAME("filesystem_changed")); //it changed, so force emitting the signal } void ImportDock::_notification(int p_what) { switch (p_what) { case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: { imported->add_theme_style_override("normal", get_theme_stylebox(SNAME("normal"), SNAME("LineEdit"))); } break; case NOTIFICATION_ENTER_TREE: { import_opts->edit(params); label_warning->add_theme_color_override("font_color", get_theme_color(SNAME("warning_color"), SNAME("Editor"))); } break; } } void ImportDock::_property_toggled(const StringName &p_prop, bool p_checked) { if (p_checked) { params->checked.insert(p_prop); } else { params->checked.erase(p_prop); } } void ImportDock::_bind_methods() { ClassDB::bind_method(D_METHOD("_reimport"), &ImportDock::_reimport); } void ImportDock::initialize_import_options() const { ERR_FAIL_COND(!import_opts || !params); import_opts->edit(params); } ImportDock::ImportDock() { set_name("Import"); imported = memnew(Label); imported->add_theme_style_override("normal", EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("normal"), SNAME("LineEdit"))); imported->set_clip_text(true); add_child(imported); HBoxContainer *hb = memnew(HBoxContainer); add_margin_child(TTR("Import As:"), hb); import_as = memnew(OptionButton); import_as->set_disabled(true); import_as->connect("item_selected", callable_mp(this, &ImportDock::_importer_selected)); hb->add_child(import_as); import_as->set_h_size_flags(SIZE_EXPAND_FILL); preset = memnew(MenuButton); preset->set_text(TTR("Preset")); preset->set_disabled(true); preset->get_popup()->connect("index_pressed", callable_mp(this, &ImportDock::_preset_selected)); hb->add_child(preset); import_opts = memnew(EditorInspector); add_child(import_opts); import_opts->set_v_size_flags(SIZE_EXPAND_FILL); import_opts->connect("property_toggled", callable_mp(this, &ImportDock::_property_toggled)); hb = memnew(HBoxContainer); add_child(hb); import = memnew(Button); import->set_text(TTR("Reimport")); import->set_disabled(true); import->connect("pressed", callable_mp(this, &ImportDock::_reimport_attempt)); if (!DisplayServer::get_singleton()->get_swap_cancel_ok()) { advanced_spacer = hb->add_spacer(); advanced = memnew(Button); advanced->set_text(TTR("Advanced...")); hb->add_child(advanced); } hb->add_spacer(); hb->add_child(import); hb->add_spacer(); if (DisplayServer::get_singleton()->get_swap_cancel_ok()) { advanced = memnew(Button); advanced->set_text(TTR("Advanced...")); hb->add_child(advanced); advanced_spacer = hb->add_spacer(); } advanced->hide(); advanced_spacer->hide(); advanced->connect("pressed", callable_mp(this, &ImportDock::_advanced_options)); reimport_confirm = memnew(ConfirmationDialog); reimport_confirm->get_ok_button()->set_text(TTR("Save Scenes, Re-Import, and Restart")); add_child(reimport_confirm); reimport_confirm->connect("confirmed", callable_mp(this, &ImportDock::_reimport_and_restart)); VBoxContainer *vbc_confirm = memnew(VBoxContainer()); vbc_confirm->add_child(memnew(Label(TTR("Changing the type of an imported file requires editor restart.")))); label_warning = memnew(Label(TTR("WARNING: Assets exist that use this resource, they may stop loading properly."))); vbc_confirm->add_child(label_warning); reimport_confirm->add_child(vbc_confirm); params = memnew(ImportDockParameters); } ImportDock::~ImportDock() { memdelete(params); }