1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075 |
- /**************************************************************************/
- /* animation_library_editor.cpp */
- /**************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /**************************************************************************/
- /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
- /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
- /* */
- /* 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 "animation_library_editor.h"
- #include "core/string/print_string.h"
- #include "core/string/ustring.h"
- #include "core/templates/vector.h"
- #include "core/variant/variant.h"
- #include "editor/editor_node.h"
- #include "editor/editor_paths.h"
- #include "editor/editor_settings.h"
- #include "editor/editor_string_names.h"
- #include "editor/editor_undo_redo_manager.h"
- #include "editor/gui/editor_file_dialog.h"
- #include "editor/themes/editor_scale.h"
- #include "scene/animation/animation_mixer.h"
- void AnimationLibraryEditor::set_animation_mixer(Object *p_mixer) {
- mixer = Object::cast_to<AnimationMixer>(p_mixer);
- }
- void AnimationLibraryEditor::_add_library() {
- add_library_dialog->set_title(TTR("Library Name:"));
- add_library_name->set_text("");
- add_library_dialog->popup_centered();
- add_library_name->grab_focus();
- adding_animation = false;
- adding_animation_to_library = StringName();
- _add_library_validate("");
- }
- void AnimationLibraryEditor::_add_library_validate(const String &p_name) {
- String error;
- if (adding_animation) {
- Ref<AnimationLibrary> al = mixer->get_animation_library(adding_animation_to_library);
- ERR_FAIL_COND(al.is_null());
- if (p_name == "") {
- error = TTR("Animation name can't be empty.");
- } else if (!AnimationLibrary::is_valid_animation_name(p_name)) {
- error = TTR("Animation name contains invalid characters: '/', ':', ',' or '['.");
- } else if (al->has_animation(p_name)) {
- error = TTR("Animation with the same name already exists.");
- }
- } else {
- if (p_name == "" && mixer->has_animation_library("")) {
- error = TTR("Enter a library name.");
- } else if (!AnimationLibrary::is_valid_library_name(p_name)) {
- error = TTR("Library name contains invalid characters: '/', ':', ',' or '['.");
- } else if (mixer->has_animation_library(p_name)) {
- error = TTR("Library with the same name already exists.");
- }
- }
- if (error != "") {
- add_library_validate->add_theme_color_override(SceneStringName(font_color), get_theme_color(SNAME("error_color"), EditorStringName(Editor)));
- add_library_validate->set_text(error);
- add_library_dialog->get_ok_button()->set_disabled(true);
- } else {
- if (adding_animation) {
- add_library_validate->set_text(TTR("Animation name is valid."));
- } else {
- if (p_name == "") {
- add_library_validate->set_text(TTR("Global library will be created."));
- } else {
- add_library_validate->set_text(TTR("Library name is valid."));
- }
- }
- add_library_validate->add_theme_color_override(SceneStringName(font_color), get_theme_color(SNAME("success_color"), EditorStringName(Editor)));
- add_library_dialog->get_ok_button()->set_disabled(false);
- }
- }
- void AnimationLibraryEditor::_add_library_confirm() {
- if (adding_animation) {
- String anim_name = add_library_name->get_text();
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- Ref<AnimationLibrary> al = mixer->get_animation_library(adding_animation_to_library);
- ERR_FAIL_COND(al.is_null());
- Ref<Animation> anim;
- anim.instantiate();
- undo_redo->create_action(vformat(TTR("Add Animation to Library: %s"), anim_name));
- undo_redo->add_do_method(al.ptr(), "add_animation", anim_name, anim);
- undo_redo->add_undo_method(al.ptr(), "remove_animation", anim_name);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- undo_redo->commit_action();
- } else {
- String lib_name = add_library_name->get_text();
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- Ref<AnimationLibrary> al;
- al.instantiate();
- undo_redo->create_action(vformat(TTR("Add Animation Library: %s"), lib_name));
- undo_redo->add_do_method(mixer, "add_animation_library", lib_name, al);
- undo_redo->add_undo_method(mixer, "remove_animation_library", lib_name);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- undo_redo->commit_action();
- }
- }
- void AnimationLibraryEditor::_load_library() {
- List<String> extensions;
- ResourceLoader::get_recognized_extensions_for_type("AnimationLibrary", &extensions);
- file_dialog->set_title(TTR("Load Animation"));
- file_dialog->clear_filters();
- for (const String &K : extensions) {
- file_dialog->add_filter("*." + K);
- }
- file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILES);
- file_dialog->set_current_file("");
- file_dialog->popup_centered_ratio();
- file_dialog_action = FILE_DIALOG_ACTION_OPEN_LIBRARY;
- }
- void AnimationLibraryEditor::_file_popup_selected(int p_id) {
- Ref<AnimationLibrary> al = mixer->get_animation_library(file_dialog_library);
- Ref<Animation> anim;
- if (file_dialog_animation != StringName()) {
- anim = al->get_animation(file_dialog_animation);
- ERR_FAIL_COND(anim.is_null());
- }
- switch (p_id) {
- case FILE_MENU_SAVE_LIBRARY: {
- if (al->get_path().is_resource_file() && !FileAccess::exists(al->get_path() + ".import")) {
- EditorNode::get_singleton()->save_resource(al);
- break;
- }
- [[fallthrough]];
- }
- case FILE_MENU_SAVE_AS_LIBRARY: {
- // Check if we're allowed to save this
- {
- String al_path = al->get_path();
- if (!al_path.is_resource_file()) {
- int srpos = al_path.find("::");
- if (srpos != -1) {
- String base = al_path.substr(0, srpos);
- if (!get_tree()->get_edited_scene_root() || get_tree()->get_edited_scene_root()->get_scene_file_path() != base) {
- error_dialog->set_text(TTR("This animation library can't be saved because it does not belong to the edited scene. Make it unique first."));
- error_dialog->popup_centered();
- return;
- }
- }
- } else {
- if (FileAccess::exists(al_path + ".import")) {
- error_dialog->set_text(TTR("This animation library can't be saved because it was imported from another file. Make it unique first."));
- error_dialog->popup_centered();
- return;
- }
- }
- }
- file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
- file_dialog->set_title(TTR("Save Library"));
- if (al->get_path().is_resource_file()) {
- file_dialog->set_current_path(al->get_path());
- } else {
- file_dialog->set_current_file(String(file_dialog_library) + ".res");
- }
- file_dialog->clear_filters();
- List<String> exts;
- ResourceLoader::get_recognized_extensions_for_type("AnimationLibrary", &exts);
- for (const String &K : exts) {
- file_dialog->add_filter("*." + K);
- }
- file_dialog->popup_centered_ratio();
- file_dialog_action = FILE_DIALOG_ACTION_SAVE_LIBRARY;
- } break;
- case FILE_MENU_MAKE_LIBRARY_UNIQUE: {
- StringName lib_name = file_dialog_library;
- List<StringName> animation_list;
- Ref<AnimationLibrary> ald = memnew(AnimationLibrary);
- al->get_animation_list(&animation_list);
- for (const StringName &animation_name : animation_list) {
- Ref<Animation> animation = al->get_animation(animation_name);
- if (EditorNode::get_singleton()->is_resource_read_only(animation)) {
- animation = animation->duplicate();
- }
- ald->add_animation(animation_name, animation);
- }
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Make Animation Library Unique: %s"), lib_name));
- undo_redo->add_do_method(mixer, "remove_animation_library", lib_name);
- undo_redo->add_do_method(mixer, "add_animation_library", lib_name, ald);
- undo_redo->add_undo_method(mixer, "remove_animation_library", lib_name);
- undo_redo->add_undo_method(mixer, "add_animation_library", lib_name, al);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- undo_redo->commit_action();
- update_tree();
- } break;
- case FILE_MENU_EDIT_LIBRARY: {
- EditorNode::get_singleton()->push_item(al.ptr());
- } break;
- case FILE_MENU_SAVE_ANIMATION: {
- if (anim->get_path().is_resource_file() && !FileAccess::exists(anim->get_path() + ".import")) {
- EditorNode::get_singleton()->save_resource(anim);
- break;
- }
- [[fallthrough]];
- }
- case FILE_MENU_SAVE_AS_ANIMATION: {
- // Check if we're allowed to save this
- {
- String anim_path = al->get_path();
- if (!anim_path.is_resource_file()) {
- int srpos = anim_path.find("::");
- if (srpos != -1) {
- String base = anim_path.substr(0, srpos);
- if (!get_tree()->get_edited_scene_root() || get_tree()->get_edited_scene_root()->get_scene_file_path() != base) {
- error_dialog->set_text(TTR("This animation can't be saved because it does not belong to the edited scene. Make it unique first."));
- error_dialog->popup_centered();
- return;
- }
- }
- } else {
- if (FileAccess::exists(anim_path + ".import")) {
- error_dialog->set_text(TTR("This animation can't be saved because it was imported from another file. Make it unique first."));
- error_dialog->popup_centered();
- return;
- }
- }
- }
- file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
- file_dialog->set_title(TTR("Save Animation"));
- if (anim->get_path().is_resource_file()) {
- file_dialog->set_current_path(anim->get_path());
- } else {
- file_dialog->set_current_file(String(file_dialog_animation) + ".res");
- }
- file_dialog->clear_filters();
- List<String> exts;
- ResourceLoader::get_recognized_extensions_for_type("Animation", &exts);
- for (const String &K : exts) {
- file_dialog->add_filter("*." + K);
- }
- file_dialog->popup_centered_ratio();
- file_dialog_action = FILE_DIALOG_ACTION_SAVE_ANIMATION;
- } break;
- case FILE_MENU_MAKE_ANIMATION_UNIQUE: {
- StringName anim_name = file_dialog_animation;
- Ref<Animation> animd = anim->duplicate();
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Make Animation Unique: %s"), anim_name));
- undo_redo->add_do_method(al.ptr(), "remove_animation", anim_name);
- undo_redo->add_do_method(al.ptr(), "add_animation", anim_name, animd);
- undo_redo->add_undo_method(al.ptr(), "remove_animation", anim_name);
- undo_redo->add_undo_method(al.ptr(), "add_animation", anim_name, anim);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- undo_redo->commit_action();
- update_tree();
- } break;
- case FILE_MENU_EDIT_ANIMATION: {
- EditorNode::get_singleton()->push_item(anim.ptr());
- } break;
- }
- }
- void AnimationLibraryEditor::_load_file(const String &p_path) {
- switch (file_dialog_action) {
- case FILE_DIALOG_ACTION_SAVE_LIBRARY: {
- Ref<AnimationLibrary> al = mixer->get_animation_library(file_dialog_library);
- String prev_path = al->get_path();
- EditorNode::get_singleton()->save_resource_in_path(al, p_path);
- if (al->get_path() != prev_path) { // Save successful.
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Save Animation library to File: %s"), file_dialog_library));
- undo_redo->add_do_method(al.ptr(), "set_path", al->get_path());
- undo_redo->add_undo_method(al.ptr(), "set_path", prev_path);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- undo_redo->commit_action();
- }
- } break;
- case FILE_DIALOG_ACTION_SAVE_ANIMATION: {
- Ref<AnimationLibrary> al = mixer->get_animation_library(file_dialog_library);
- Ref<Animation> anim;
- if (file_dialog_animation != StringName()) {
- anim = al->get_animation(file_dialog_animation);
- ERR_FAIL_COND(anim.is_null());
- }
- String prev_path = anim->get_path();
- EditorNode::get_singleton()->save_resource_in_path(anim, p_path);
- if (anim->get_path() != prev_path) { // Save successful.
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Save Animation to File: %s"), file_dialog_animation));
- undo_redo->add_do_method(anim.ptr(), "set_path", anim->get_path());
- undo_redo->add_undo_method(anim.ptr(), "set_path", prev_path);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- undo_redo->commit_action();
- }
- } break;
- default: {
- }
- }
- }
- void AnimationLibraryEditor::_load_files(const PackedStringArray &p_paths) {
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- bool has_created_action = false;
- bool show_error_diag = false;
- List<String> name_list;
- switch (file_dialog_action) {
- case FILE_DIALOG_ACTION_OPEN_LIBRARY: {
- for (const String &path : p_paths) {
- Ref<AnimationLibrary> al = ResourceLoader::load(path);
- if (al.is_null()) {
- show_error_diag = true;
- error_dialog->set_text(TTR("Some AnimationLibrary files were invalid."));
- continue;
- }
- List<StringName> libs;
- mixer->get_animation_library_list(&libs);
- bool is_already_added = false;
- for (const StringName &K : libs) {
- if (mixer->get_animation_library(K) == al) {
- // Prioritize the "invalid" error message.
- if (!show_error_diag) {
- show_error_diag = true;
- error_dialog->set_text(TTR("Some of the selected libraries were already added to the mixer."));
- }
- is_already_added = true;
- break;
- }
- }
- if (is_already_added) {
- continue;
- }
- String name = AnimationLibrary::validate_library_name(path.get_file().get_basename());
- int attempt = 1;
- while (bool(mixer->has_animation_library(name)) || name_list.find(name)) {
- attempt++;
- name = path.get_file().get_basename() + " " + itos(attempt);
- }
- name_list.push_back(name);
- if (!has_created_action) {
- has_created_action = true;
- undo_redo->create_action(p_paths.size() > 1 ? TTR("Add Animation Libraries") : vformat(TTR("Add Animation Library: %s"), name));
- }
- undo_redo->add_do_method(mixer, "add_animation_library", name, al);
- undo_redo->add_undo_method(mixer, "remove_animation_library", name);
- }
- } break;
- case FILE_DIALOG_ACTION_OPEN_ANIMATION: {
- Ref<AnimationLibrary> al = mixer->get_animation_library(adding_animation_to_library);
- for (const String &path : p_paths) {
- Ref<Animation> anim = ResourceLoader::load(path);
- if (anim.is_null()) {
- show_error_diag = true;
- error_dialog->set_text(TTR("Some Animation files were invalid."));
- continue;
- }
- List<StringName> anims;
- al->get_animation_list(&anims);
- bool is_already_added = false;
- for (const StringName &K : anims) {
- if (al->get_animation(K) == anim) {
- // Prioritize the "invalid" error message.
- if (!show_error_diag) {
- show_error_diag = true;
- error_dialog->set_text(TTR("Some of the selected animations were already added to the library."));
- }
- is_already_added = true;
- break;
- }
- }
- if (is_already_added) {
- continue;
- }
- String name = path.get_file().get_basename();
- int attempt = 1;
- while (al->has_animation(name) || name_list.find(name)) {
- attempt++;
- name = path.get_file().get_basename() + " " + itos(attempt);
- }
- name_list.push_back(name);
- if (!has_created_action) {
- has_created_action = true;
- undo_redo->create_action(p_paths.size() > 1 ? TTR("Load Animations into Library") : vformat(TTR("Load Animation into Library: %s"), name));
- }
- undo_redo->add_do_method(al.ptr(), "add_animation", name, anim);
- undo_redo->add_undo_method(al.ptr(), "remove_animation", name);
- }
- } break;
- default: {
- }
- }
- if (has_created_action) {
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- undo_redo->commit_action();
- }
- if (show_error_diag) {
- error_dialog->popup_centered();
- }
- }
- void AnimationLibraryEditor::_item_renamed() {
- TreeItem *ti = tree->get_edited();
- String text = ti->get_text(0);
- String old_text = ti->get_metadata(0);
- bool restore_text = false;
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- if (String(text).contains_char('/') || String(text).contains_char(':') || String(text).contains_char(',') || String(text).contains_char('[')) {
- restore_text = true;
- } else {
- if (ti->get_parent() == tree->get_root()) {
- // Renamed library
- if (mixer->has_animation_library(text)) {
- restore_text = true;
- } else {
- undo_redo->create_action(vformat(TTR("Rename Animation Library: %s"), text));
- undo_redo->add_do_method(mixer, "rename_animation_library", old_text, text);
- undo_redo->add_undo_method(mixer, "rename_animation_library", text, old_text);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- updating = true;
- undo_redo->commit_action();
- updating = false;
- ti->set_metadata(0, text);
- if (text == "") {
- ti->set_suffix(0, TTR("[Global]"));
- } else {
- ti->set_suffix(0, "");
- }
- }
- } else {
- // Renamed anim
- StringName library = ti->get_parent()->get_metadata(0);
- Ref<AnimationLibrary> al = mixer->get_animation_library(library);
- if (al.is_valid()) {
- if (al->has_animation(text)) {
- restore_text = true;
- } else {
- undo_redo->create_action(vformat(TTR("Rename Animation: %s"), text));
- undo_redo->add_do_method(al.ptr(), "rename_animation", old_text, text);
- undo_redo->add_undo_method(al.ptr(), "rename_animation", text, old_text);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- updating = true;
- undo_redo->commit_action();
- updating = false;
- ti->set_metadata(0, text);
- }
- } else {
- restore_text = true;
- }
- }
- }
- if (restore_text) {
- ti->set_text(0, old_text);
- }
- _save_mixer_lib_folding(ti);
- }
- void AnimationLibraryEditor::_button_pressed(TreeItem *p_item, int p_column, int p_id, MouseButton p_button) {
- if (p_item->get_parent() == tree->get_root()) {
- // Library
- StringName lib_name = p_item->get_metadata(0);
- Ref<AnimationLibrary> al = mixer->get_animation_library(lib_name);
- switch (p_id) {
- case LIB_BUTTON_ADD: {
- add_library_dialog->set_title(TTR("Animation Name:"));
- add_library_name->set_text("");
- add_library_dialog->popup_centered();
- add_library_name->grab_focus();
- adding_animation = true;
- adding_animation_to_library = p_item->get_metadata(0);
- _add_library_validate("");
- } break;
- case LIB_BUTTON_LOAD: {
- adding_animation_to_library = p_item->get_metadata(0);
- List<String> extensions;
- ResourceLoader::get_recognized_extensions_for_type("Animation", &extensions);
- file_dialog->clear_filters();
- for (const String &K : extensions) {
- file_dialog->add_filter("*." + K);
- }
- file_dialog->set_title(TTR("Load Animation"));
- file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILES);
- file_dialog->set_current_file("");
- file_dialog->popup_centered_ratio();
- file_dialog_action = FILE_DIALOG_ACTION_OPEN_ANIMATION;
- } break;
- case LIB_BUTTON_PASTE: {
- Ref<Animation> anim = EditorSettings::get_singleton()->get_resource_clipboard();
- if (anim.is_null()) {
- error_dialog->set_text(TTR("No animation resource in clipboard!"));
- error_dialog->popup_centered();
- return;
- }
- if (!anim->get_path().is_resource_file()) {
- anim = anim->duplicate(); // Users simply dont care about referencing, so making a copy works better here.
- }
- String base_name;
- if (anim->get_name() != "") {
- base_name = anim->get_name();
- } else {
- base_name = TTR("Pasted Animation");
- }
- String name = base_name;
- int attempt = 1;
- while (al->has_animation(name)) {
- attempt++;
- name = base_name + " (" + itos(attempt) + ")";
- }
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Add Animation to Library: %s"), name));
- undo_redo->add_do_method(al.ptr(), "add_animation", name, anim);
- undo_redo->add_undo_method(al.ptr(), "remove_animation", name);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- undo_redo->commit_action();
- } break;
- case LIB_BUTTON_FILE: {
- file_popup->clear();
- file_popup->add_item(TTR("Save"), FILE_MENU_SAVE_LIBRARY);
- file_popup->add_item(TTR("Save As"), FILE_MENU_SAVE_AS_LIBRARY);
- file_popup->add_separator();
- file_popup->add_item(TTR("Make Unique"), FILE_MENU_MAKE_LIBRARY_UNIQUE);
- file_popup->add_separator();
- file_popup->add_item(TTR("Open in Inspector"), FILE_MENU_EDIT_LIBRARY);
- Rect2 pos = tree->get_item_rect(p_item, 1, 0);
- Vector2 popup_pos = tree->get_screen_transform().xform(pos.position + Vector2(0, pos.size.height));
- file_popup->popup(Rect2(popup_pos, Size2()));
- file_dialog_animation = StringName();
- file_dialog_library = lib_name;
- } break;
- case LIB_BUTTON_DELETE: {
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Remove Animation Library: %s"), lib_name));
- undo_redo->add_do_method(mixer, "remove_animation_library", lib_name);
- undo_redo->add_undo_method(mixer, "add_animation_library", lib_name, al);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- undo_redo->commit_action();
- } break;
- }
- } else {
- // Animation
- StringName lib_name = p_item->get_parent()->get_metadata(0);
- StringName anim_name = p_item->get_metadata(0);
- Ref<AnimationLibrary> al = mixer->get_animation_library(lib_name);
- Ref<Animation> anim = al->get_animation(anim_name);
- ERR_FAIL_COND(anim.is_null());
- switch (p_id) {
- case ANIM_BUTTON_COPY: {
- if (anim->get_name() == "") {
- anim->set_name(anim_name); // Keep the name around
- }
- EditorSettings::get_singleton()->set_resource_clipboard(anim);
- } break;
- case ANIM_BUTTON_FILE: {
- file_popup->clear();
- file_popup->add_item(TTR("Save"), FILE_MENU_SAVE_ANIMATION);
- file_popup->add_item(TTR("Save As"), FILE_MENU_SAVE_AS_ANIMATION);
- file_popup->add_separator();
- file_popup->add_item(TTR("Make Unique"), FILE_MENU_MAKE_ANIMATION_UNIQUE);
- file_popup->add_separator();
- file_popup->add_item(TTR("Open in Inspector"), FILE_MENU_EDIT_ANIMATION);
- Rect2 pos = tree->get_item_rect(p_item, 1, 0);
- Vector2 popup_pos = tree->get_screen_transform().xform(pos.position + Vector2(0, pos.size.height));
- file_popup->popup(Rect2(popup_pos, Size2()));
- file_dialog_animation = anim_name;
- file_dialog_library = lib_name;
- } break;
- case ANIM_BUTTON_DELETE: {
- EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
- undo_redo->create_action(vformat(TTR("Remove Animation from Library: %s"), anim_name));
- undo_redo->add_do_method(al.ptr(), "remove_animation", anim_name);
- undo_redo->add_undo_method(al.ptr(), "add_animation", anim_name, anim);
- undo_redo->add_do_method(this, "_update_editor", mixer);
- undo_redo->add_undo_method(this, "_update_editor", mixer);
- undo_redo->commit_action();
- } break;
- }
- }
- }
- void AnimationLibraryEditor::update_tree() {
- if (updating) {
- return;
- }
- tree->clear();
- ERR_FAIL_NULL(mixer);
- Color ss_color = get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor));
- TreeItem *root = tree->create_item();
- List<StringName> libs;
- Vector<uint64_t> collapsed_lib_ids = _load_mixer_libs_folding();
- mixer->get_animation_library_list(&libs);
- for (const StringName &K : libs) {
- TreeItem *libitem = tree->create_item(root);
- libitem->set_text(0, K);
- if (K == StringName()) {
- libitem->set_suffix(0, TTR("[Global]"));
- } else {
- libitem->set_suffix(0, "");
- }
- Ref<AnimationLibrary> al = mixer->get_animation_library(K);
- bool animation_library_is_foreign = false;
- String al_path = al->get_path();
- if (!al_path.is_resource_file()) {
- libitem->set_text(1, TTR("[built-in]"));
- libitem->set_tooltip_text(1, al_path);
- int srpos = al_path.find("::");
- if (srpos != -1) {
- String base = al_path.substr(0, srpos);
- if (ResourceLoader::get_resource_type(base) == "PackedScene") {
- if (!get_tree()->get_edited_scene_root() || get_tree()->get_edited_scene_root()->get_scene_file_path() != base) {
- animation_library_is_foreign = true;
- libitem->set_text(1, TTR("[foreign]"));
- }
- } else {
- if (FileAccess::exists(base + ".import")) {
- animation_library_is_foreign = true;
- libitem->set_text(1, TTR("[imported]"));
- }
- }
- }
- } else {
- if (FileAccess::exists(al_path + ".import")) {
- animation_library_is_foreign = true;
- libitem->set_text(1, TTR("[imported]"));
- } else {
- libitem->set_text(1, al_path.get_file());
- }
- }
- libitem->set_editable(0, true);
- libitem->set_metadata(0, K);
- libitem->set_icon(0, get_editor_theme_icon("AnimationLibrary"));
- libitem->add_button(0, get_editor_theme_icon("Add"), LIB_BUTTON_ADD, animation_library_is_foreign, TTR("Add animation to library."));
- libitem->add_button(0, get_editor_theme_icon("Load"), LIB_BUTTON_LOAD, animation_library_is_foreign, TTR("Load animation from file and add to library."));
- libitem->add_button(0, get_editor_theme_icon("ActionPaste"), LIB_BUTTON_PASTE, animation_library_is_foreign, TTR("Paste animation to library from clipboard."));
- libitem->add_button(1, get_editor_theme_icon("Save"), LIB_BUTTON_FILE, false, TTR("Save animation library to resource on disk."));
- libitem->add_button(1, get_editor_theme_icon("Remove"), LIB_BUTTON_DELETE, false, TTR("Remove animation library."));
- libitem->set_custom_bg_color(0, ss_color);
- List<StringName> animations;
- al->get_animation_list(&animations);
- for (const StringName &L : animations) {
- TreeItem *anitem = tree->create_item(libitem);
- anitem->set_text(0, L);
- anitem->set_editable(0, !animation_library_is_foreign);
- anitem->set_metadata(0, L);
- anitem->set_icon(0, get_editor_theme_icon("Animation"));
- anitem->add_button(0, get_editor_theme_icon("ActionCopy"), ANIM_BUTTON_COPY, animation_library_is_foreign, TTR("Copy animation to clipboard."));
- Ref<Animation> anim = al->get_animation(L);
- String anim_path = anim->get_path();
- if (!anim_path.is_resource_file()) {
- anitem->set_text(1, TTR("[built-in]"));
- anitem->set_tooltip_text(1, anim_path);
- int srpos = anim_path.find("::");
- if (srpos != -1) {
- String base = anim_path.substr(0, srpos);
- if (ResourceLoader::get_resource_type(base) == "PackedScene") {
- if (!get_tree()->get_edited_scene_root() || get_tree()->get_edited_scene_root()->get_scene_file_path() != base) {
- anitem->set_text(1, TTR("[foreign]"));
- }
- } else {
- if (FileAccess::exists(base + ".import")) {
- anitem->set_text(1, TTR("[imported]"));
- }
- }
- }
- } else {
- if (FileAccess::exists(anim_path + ".import")) {
- anitem->set_text(1, TTR("[imported]"));
- } else {
- anitem->set_text(1, anim_path.get_file());
- }
- }
- anitem->add_button(1, get_editor_theme_icon("Save"), ANIM_BUTTON_FILE, animation_library_is_foreign, TTR("Save animation to resource on disk."));
- anitem->add_button(1, get_editor_theme_icon("Remove"), ANIM_BUTTON_DELETE, animation_library_is_foreign, TTR("Remove animation from Library."));
- for (const uint64_t &lib_id : collapsed_lib_ids) {
- Object *lib_obj = ObjectDB::get_instance(ObjectID(lib_id));
- AnimationLibrary *cur_lib = Object::cast_to<AnimationLibrary>(lib_obj);
- StringName M = mixer->get_animation_library_name(cur_lib);
- if (M == K) {
- libitem->set_collapsed_recursive(true);
- }
- }
- }
- }
- }
- void AnimationLibraryEditor::_save_mixer_lib_folding(TreeItem *p_item) {
- //Check if ti is a library or animation
- if (p_item->get_parent()->get_parent() != nullptr) {
- return;
- }
- Ref<ConfigFile> config;
- config.instantiate();
- String path = EditorPaths::get_singleton()->get_project_settings_dir().path_join("lib_folding.cfg");
- Error err = config->load(path);
- if (err != OK && err != ERR_FILE_NOT_FOUND) {
- ERR_PRINT("Error loading lib_folding.cfg: " + itos(err));
- }
- // Get unique identifier for this scene+mixer combination
- String md = (mixer->get_tree()->get_edited_scene_root()->get_scene_file_path() + mixer->get_path()).md5_text();
- PackedStringArray collapsed_lib_names;
- PackedStringArray collapsed_lib_ids;
- if (config->has_section(md)) {
- collapsed_lib_names = String(config->get_value(md, "folding")).split("\n");
- collapsed_lib_ids = String(config->get_value(md, "id")).split("\n");
- }
- String lib_name = p_item->get_text(0);
- // Get library reference and check validity
- Ref<AnimationLibrary> al;
- uint64_t lib_id = 0;
- if (mixer->has_animation_library(lib_name)) {
- al = mixer->get_animation_library(lib_name);
- ERR_FAIL_COND(al.is_null());
- lib_id = uint64_t(al->get_instance_id());
- } else {
- ERR_PRINT("Library not found: " + lib_name);
- }
- int at = collapsed_lib_names.find(lib_name);
- if (p_item->is_collapsed()) {
- if (at != -1) {
- //Entry exists and needs updating
- collapsed_lib_ids.set(at, String::num_int64(lib_id + INT64_MIN));
- } else {
- //Check if it's a rename
- int id_at = collapsed_lib_ids.find(String::num_int64(lib_id + INT64_MIN));
- if (id_at != -1) {
- //It's actually a rename
- collapsed_lib_names.set(id_at, lib_name);
- } else {
- //It's a new entry
- collapsed_lib_names.append(lib_name);
- collapsed_lib_ids.append(String::num_int64(lib_id + INT64_MIN));
- }
- }
- } else {
- if (at != -1) {
- collapsed_lib_names.remove_at(at);
- collapsed_lib_ids.remove_at(at);
- }
- }
- //Runtime IDs
- config->set_value(md, "root", uint64_t(mixer->get_tree()->get_edited_scene_root()->get_instance_id()));
- config->set_value(md, "mixer", uint64_t(mixer->get_instance_id()));
- //Plan B recovery mechanism
- config->set_value(md, "mixer_signature", _get_mixer_signature());
- //Save folding state as text and runtime ID
- config->set_value(md, "folding", String("\n").join(collapsed_lib_names));
- config->set_value(md, "id", String("\n").join(collapsed_lib_ids));
- err = config->save(path);
- if (err != OK) {
- ERR_PRINT("Error saving lib_folding.cfg: " + itos(err));
- }
- }
- Vector<uint64_t> AnimationLibraryEditor::_load_mixer_libs_folding() {
- Ref<ConfigFile> config;
- config.instantiate();
- String path = EditorPaths::get_singleton()->get_project_settings_dir().path_join("lib_folding.cfg");
- Error err = config->load(path);
- if (err != OK && err != ERR_FILE_NOT_FOUND) {
- ERR_PRINT("Error loading lib_folding.cfg: " + itos(err));
- return Vector<uint64_t>();
- }
- // Get unique identifier for this scene+mixer combination
- String md = (mixer->get_tree()->get_edited_scene_root()->get_scene_file_path() + mixer->get_path()).md5_text();
- Vector<uint64_t> collapsed_lib_ids;
- if (config->has_section(md)) {
- _load_config_libs_folding(collapsed_lib_ids, config.ptr(), md);
- } else {
- //The scene/mixer combination is no longer valid and we'll try to recover
- uint64_t current_mixer_id = uint64_t(mixer->get_instance_id());
- String current_mixer_signature = _get_mixer_signature();
- List<String> sections;
- config->get_sections(§ions);
- for (const String §ion : sections) {
- Variant mixer_id = config->get_value(section, "mixer");
- if ((mixer_id.get_type() == Variant::INT && uint64_t(mixer_id) == current_mixer_id) || config->get_value(section, "mixer_signature") == current_mixer_signature) { // Ensure value exists and is correct type
- // Found the mixer in a different section!
- _load_config_libs_folding(collapsed_lib_ids, config.ptr(), section);
- //Cleanup old entry and copy fold data into new one!
- String collapsed_lib_names_str = String(config->get_value(section, "folding"));
- String collapsed_lib_ids_str = String(config->get_value(section, "id"));
- config->erase_section(section);
- config->set_value(md, "root", uint64_t(mixer->get_tree()->get_edited_scene_root()->get_instance_id()));
- config->set_value(md, "mixer", uint64_t(mixer->get_instance_id()));
- config->set_value(md, "mixer_signature", _get_mixer_signature());
- config->set_value(md, "folding", collapsed_lib_names_str);
- config->set_value(md, "id", collapsed_lib_ids_str);
- err = config->save(path);
- if (err != OK) {
- ERR_PRINT("Error saving lib_folding.cfg: " + itos(err));
- }
- break;
- }
- }
- }
- return collapsed_lib_ids;
- }
- void AnimationLibraryEditor::_load_config_libs_folding(Vector<uint64_t> &p_lib_ids, ConfigFile *p_config, String p_section) {
- if (uint64_t(p_config->get_value(p_section, "root", 0)) != uint64_t(mixer->get_tree()->get_edited_scene_root()->get_instance_id())) {
- // Root changed - tries to match by library names
- PackedStringArray collapsed_lib_names = String(p_config->get_value(p_section, "folding", "")).split("\n");
- for (const String &lib_name : collapsed_lib_names) {
- if (mixer->has_animation_library(lib_name)) {
- p_lib_ids.append(mixer->get_animation_library(lib_name)->get_instance_id());
- } else {
- print_line("Can't find ", lib_name, " in mixer");
- }
- }
- } else {
- // Root same - uses saved instance IDs
- for (const String &saved_id : String(p_config->get_value(p_section, "id")).split("\n")) {
- p_lib_ids.append(uint64_t(saved_id.to_int() - INT64_MIN));
- }
- }
- }
- String AnimationLibraryEditor::_get_mixer_signature() const {
- String signature = String();
- // Get all libraries sorted for consistency
- List<StringName> libs;
- mixer->get_animation_library_list(&libs);
- libs.sort_custom<StringName::AlphCompare>();
- // Add libraries and their animations to signature
- for (const StringName &lib_name : libs) {
- signature += "::" + String(lib_name);
- Ref<AnimationLibrary> lib = mixer->get_animation_library(lib_name);
- if (lib.is_valid()) {
- List<StringName> anims;
- lib->get_animation_list(&anims);
- anims.sort_custom<StringName::AlphCompare>();
- for (const StringName &anim_name : anims) {
- signature += "," + String(anim_name);
- }
- }
- }
- return signature.md5_text();
- }
- void AnimationLibraryEditor::show_dialog() {
- update_tree();
- popup_centered_ratio(0.5);
- }
- void AnimationLibraryEditor::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_THEME_CHANGED: {
- new_library_button->set_button_icon(get_editor_theme_icon(SNAME("Add")));
- load_library_button->set_button_icon(get_editor_theme_icon(SNAME("Load")));
- }
- }
- }
- void AnimationLibraryEditor::_update_editor(Object *p_mixer) {
- emit_signal("update_editor", p_mixer);
- }
- void AnimationLibraryEditor::shortcut_input(const Ref<InputEvent> &p_event) {
- const Ref<InputEventKey> k = p_event;
- if (k.is_valid() && k->is_pressed()) {
- bool handled = false;
- if (ED_IS_SHORTCUT("ui_undo", p_event)) {
- EditorNode::get_singleton()->undo();
- handled = true;
- }
- if (ED_IS_SHORTCUT("ui_redo", p_event)) {
- EditorNode::get_singleton()->redo();
- handled = true;
- }
- if (handled) {
- set_input_as_handled();
- }
- }
- }
- void AnimationLibraryEditor::_bind_methods() {
- ClassDB::bind_method(D_METHOD("_update_editor", "mixer"), &AnimationLibraryEditor::_update_editor);
- ADD_SIGNAL(MethodInfo("update_editor"));
- }
- AnimationLibraryEditor::AnimationLibraryEditor() {
- set_title(TTR("Edit Animation Libraries"));
- set_process_shortcut_input(true);
- file_dialog = memnew(EditorFileDialog);
- add_child(file_dialog);
- file_dialog->connect("file_selected", callable_mp(this, &AnimationLibraryEditor::_load_file));
- file_dialog->connect("files_selected", callable_mp(this, &AnimationLibraryEditor::_load_files));
- add_library_dialog = memnew(ConfirmationDialog);
- VBoxContainer *dialog_vb = memnew(VBoxContainer);
- add_library_name = memnew(LineEdit);
- dialog_vb->add_child(add_library_name);
- add_library_name->connect(SceneStringName(text_changed), callable_mp(this, &AnimationLibraryEditor::_add_library_validate));
- add_child(add_library_dialog);
- add_library_validate = memnew(Label);
- dialog_vb->add_child(add_library_validate);
- add_library_dialog->add_child(dialog_vb);
- add_library_dialog->connect(SceneStringName(confirmed), callable_mp(this, &AnimationLibraryEditor::_add_library_confirm));
- add_library_dialog->register_text_enter(add_library_name);
- VBoxContainer *vb = memnew(VBoxContainer);
- HBoxContainer *hb = memnew(HBoxContainer);
- hb->add_spacer(true);
- new_library_button = memnew(Button(TTR("New Library")));
- new_library_button->set_tooltip_text(TTR("Create new empty animation library."));
- new_library_button->connect(SceneStringName(pressed), callable_mp(this, &AnimationLibraryEditor::_add_library));
- hb->add_child(new_library_button);
- load_library_button = memnew(Button(TTR("Load Library")));
- load_library_button->set_tooltip_text(TTR("Load animation library from disk."));
- load_library_button->connect(SceneStringName(pressed), callable_mp(this, &AnimationLibraryEditor::_load_library));
- hb->add_child(load_library_button);
- vb->add_child(hb);
- tree = memnew(Tree);
- vb->add_child(tree);
- tree->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
- tree->set_columns(2);
- tree->set_column_titles_visible(true);
- tree->set_column_title(0, TTR("Resource"));
- tree->set_column_title(1, TTR("Storage"));
- tree->set_column_expand(0, true);
- tree->set_column_custom_minimum_width(1, EDSCALE * 250);
- tree->set_column_expand(1, false);
- tree->set_hide_root(true);
- tree->set_hide_folding(false);
- tree->set_v_size_flags(Control::SIZE_EXPAND_FILL);
- tree->connect("item_edited", callable_mp(this, &AnimationLibraryEditor::_item_renamed));
- tree->connect("button_clicked", callable_mp(this, &AnimationLibraryEditor::_button_pressed));
- tree->connect("item_collapsed", callable_mp(this, &AnimationLibraryEditor::_save_mixer_lib_folding));
- file_popup = memnew(PopupMenu);
- add_child(file_popup);
- file_popup->connect(SceneStringName(id_pressed), callable_mp(this, &AnimationLibraryEditor::_file_popup_selected));
- add_child(vb);
- error_dialog = memnew(AcceptDialog);
- error_dialog->set_title(TTR("Error:"));
- add_child(error_dialog);
- }
|