2022-04-07 13:49:28 +02:00
/**************************************************************************/
/* 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"
2024-05-14 09:40:21 +02:00
2022-04-07 13:49:28 +02:00
# include "editor/editor_node.h"
2022-11-19 12:45:49 +01:00
# include "editor/editor_settings.h"
2023-08-13 02:33:39 +02:00
# include "editor/editor_string_names.h"
2022-03-25 18:06:46 +01:00
# include "editor/editor_undo_redo_manager.h"
2023-04-07 18:59:49 +02:00
# include "editor/gui/editor_file_dialog.h"
2024-01-15 13:14:55 +01:00
# include "editor/themes/editor_scale.h"
2023-11-06 23:27:44 +01:00
# include "scene/animation/animation_mixer.h"
2022-04-07 13:49:28 +02:00
2023-07-20 17:34:06 +02:00
void AnimationLibraryEditor : : set_animation_mixer ( Object * p_mixer ) {
2023-11-06 23:27:44 +01:00
mixer = Object : : cast_to < AnimationMixer > ( p_mixer ) ;
2022-04-07 13:49:28 +02:00
}
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 ) {
2023-11-06 23:27:44 +01:00
Ref < AnimationLibrary > al = mixer - > get_animation_library ( adding_animation_to_library ) ;
2022-04-07 13:49:28 +02:00
ERR_FAIL_COND ( al . is_null ( ) ) ;
if ( p_name = = " " ) {
error = TTR ( " Animation name can't be empty. " ) ;
2022-05-05 05:19:54 +02:00
} else if ( ! AnimationLibrary : : is_valid_animation_name ( p_name ) ) {
2022-04-07 13:49:28 +02:00
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 {
2023-11-06 23:27:44 +01:00
if ( p_name = = " " & & mixer - > has_animation_library ( " " ) ) {
2022-04-07 13:49:28 +02:00
error = TTR ( " Enter a library name. " ) ;
2022-05-05 05:19:54 +02:00
} else if ( ! AnimationLibrary : : is_valid_library_name ( p_name ) ) {
2022-04-07 13:49:28 +02:00
error = TTR ( " Library name contains invalid characters: '/', ':', ',' or '['. " ) ;
2023-11-06 23:27:44 +01:00
} else if ( mixer - > has_animation_library ( p_name ) ) {
2022-04-07 13:49:28 +02:00
error = TTR ( " Library with the same name already exists. " ) ;
}
}
if ( error ! = " " ) {
2024-05-14 15:57:29 +02:00
add_library_validate - > add_theme_color_override ( SceneStringName ( font_color ) , get_theme_color ( SNAME ( " error_color " ) , EditorStringName ( Editor ) ) ) ;
2022-04-07 13:49:28 +02:00
add_library_validate - > set_text ( error ) ;
add_library_dialog - > get_ok_button ( ) - > set_disabled ( true ) ;
} else {
2022-05-14 18:54:14 +02:00
if ( adding_animation ) {
add_library_validate - > set_text ( TTR ( " Animation name is valid. " ) ) ;
2022-04-07 13:49:28 +02:00
} else {
2022-05-14 18:54:14 +02:00
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. " ) ) ;
}
2022-04-07 13:49:28 +02:00
}
2024-05-14 15:57:29 +02:00
add_library_validate - > add_theme_color_override ( SceneStringName ( font_color ) , get_theme_color ( SNAME ( " success_color " ) , EditorStringName ( Editor ) ) ) ;
2022-04-07 13:49:28 +02:00
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 ( ) ;
2022-12-23 23:53:16 +01:00
EditorUndoRedoManager * undo_redo = EditorUndoRedoManager : : get_singleton ( ) ;
2022-04-07 13:49:28 +02:00
2023-11-06 23:27:44 +01:00
Ref < AnimationLibrary > al = mixer - > get_animation_library ( adding_animation_to_library ) ;
2022-04-07 13:49:28 +02:00
ERR_FAIL_COND ( ! al . is_valid ( ) ) ;
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 ) ;
2023-07-20 17:34:06 +02:00
undo_redo - > add_do_method ( this , " _update_editor " , mixer ) ;
undo_redo - > add_undo_method ( this , " _update_editor " , mixer ) ;
2022-04-07 13:49:28 +02:00
undo_redo - > commit_action ( ) ;
} else {
String lib_name = add_library_name - > get_text ( ) ;
2022-12-23 23:53:16 +01:00
EditorUndoRedoManager * undo_redo = EditorUndoRedoManager : : get_singleton ( ) ;
2022-04-07 13:49:28 +02:00
Ref < AnimationLibrary > al ;
al . instantiate ( ) ;
undo_redo - > create_action ( vformat ( TTR ( " Add Animation Library: %s " ) , lib_name ) ) ;
2023-07-20 17:34:06 +02:00
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 ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
}
2023-10-17 16:30:19 +02:00
file_dialog - > set_file_mode ( EditorFileDialog : : FILE_MODE_OPEN_FILES ) ;
2022-04-07 13:49:28 +02:00
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 ) {
2023-11-06 23:27:44 +01:00
Ref < AnimationLibrary > al = mixer - > get_animation_library ( file_dialog_library ) ;
2022-04-07 13:49:28 +02:00
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 : {
2022-05-04 02:17:08 +02:00
if ( al - > get_path ( ) . is_resource_file ( ) & & ! FileAccess : : exists ( al - > get_path ( ) + " .import " ) ) {
2022-04-07 13:49:28 +02:00
EditorNode : : get_singleton ( ) - > save_resource ( al ) ;
break ;
}
[[fallthrough]] ;
}
case FILE_MENU_SAVE_AS_LIBRARY : {
2022-05-04 02:17:08 +02:00
// 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 ;
}
}
}
2022-04-07 13:49:28 +02:00
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 ;
2022-09-07 11:17:22 +02:00
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 ) ;
}
2022-05-04 02:17:08 +02:00
2022-12-23 23:53:16 +01:00
EditorUndoRedoManager * undo_redo = EditorUndoRedoManager : : get_singleton ( ) ;
2022-04-07 13:49:28 +02:00
undo_redo - > create_action ( vformat ( TTR ( " Make Animation Library Unique: %s " ) , lib_name ) ) ;
2023-07-20 17:34:06 +02:00
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 ) ;
2022-04-07 13:49:28 +02:00
undo_redo - > commit_action ( ) ;
2022-05-04 02:17:08 +02:00
update_tree ( ) ;
2022-04-07 13:49:28 +02:00
} break ;
case FILE_MENU_EDIT_LIBRARY : {
EditorNode : : get_singleton ( ) - > push_item ( al . ptr ( ) ) ;
} break ;
case FILE_MENU_SAVE_ANIMATION : {
2022-05-04 02:17:08 +02:00
if ( anim - > get_path ( ) . is_resource_file ( ) & & ! FileAccess : : exists ( anim - > get_path ( ) + " .import " ) ) {
2022-04-07 13:49:28 +02:00
EditorNode : : get_singleton ( ) - > save_resource ( anim ) ;
break ;
}
[[fallthrough]] ;
}
case FILE_MENU_SAVE_AS_ANIMATION : {
2022-05-04 02:17:08 +02:00
// 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 ;
}
}
}
2022-04-07 13:49:28 +02:00
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 ( ) ;
2022-12-23 23:53:16 +01:00
EditorUndoRedoManager * undo_redo = EditorUndoRedoManager : : get_singleton ( ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
2023-07-20 17:34:06 +02:00
undo_redo - > add_do_method ( this , " _update_editor " , mixer ) ;
undo_redo - > add_undo_method ( this , " _update_editor " , mixer ) ;
2022-04-07 13:49:28 +02:00
undo_redo - > commit_action ( ) ;
2022-05-04 02:17:08 +02:00
update_tree ( ) ;
2022-04-07 13:49:28 +02:00
} break ;
case FILE_MENU_EDIT_ANIMATION : {
EditorNode : : get_singleton ( ) - > push_item ( anim . ptr ( ) ) ;
} break ;
}
}
2023-10-17 16:30:19 +02:00
2024-02-15 17:25:58 +01:00
void AnimationLibraryEditor : : _load_file ( const String & p_path ) {
2022-04-07 13:49:28 +02:00
switch ( file_dialog_action ) {
case FILE_DIALOG_ACTION_SAVE_LIBRARY : {
2023-11-06 23:27:44 +01:00
Ref < AnimationLibrary > al = mixer - > get_animation_library ( file_dialog_library ) ;
2022-04-07 13:49:28 +02:00
String prev_path = al - > get_path ( ) ;
EditorNode : : get_singleton ( ) - > save_resource_in_path ( al , p_path ) ;
if ( al - > get_path ( ) ! = prev_path ) { // Save successful.
2022-12-23 23:53:16 +01:00
EditorUndoRedoManager * undo_redo = EditorUndoRedoManager : : get_singleton ( ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
2023-07-20 17:34:06 +02:00
undo_redo - > add_do_method ( this , " _update_editor " , mixer ) ;
undo_redo - > add_undo_method ( this , " _update_editor " , mixer ) ;
2022-04-07 13:49:28 +02:00
undo_redo - > commit_action ( ) ;
}
} break ;
case FILE_DIALOG_ACTION_SAVE_ANIMATION : {
2023-11-06 23:27:44 +01:00
Ref < AnimationLibrary > al = mixer - > get_animation_library ( file_dialog_library ) ;
2022-04-07 13:49:28 +02:00
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.
2022-12-23 23:53:16 +01:00
EditorUndoRedoManager * undo_redo = EditorUndoRedoManager : : get_singleton ( ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
2023-07-20 17:34:06 +02:00
undo_redo - > add_do_method ( this , " _update_editor " , mixer ) ;
undo_redo - > add_undo_method ( this , " _update_editor " , mixer ) ;
2022-04-07 13:49:28 +02:00
undo_redo - > commit_action ( ) ;
}
} break ;
2023-10-17 16:30:19 +02:00
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 ( ) ;
2022-04-07 13:49:28 +02:00
}
}
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 ;
2022-12-23 23:53:16 +01:00
EditorUndoRedoManager * undo_redo = EditorUndoRedoManager : : get_singleton ( ) ;
2022-04-07 13:49:28 +02:00
if ( String ( text ) . contains ( " / " ) | | String ( text ) . contains ( " : " ) | | String ( text ) . contains ( " , " ) | | String ( text ) . contains ( " [ " ) ) {
restore_text = true ;
} else {
if ( ti - > get_parent ( ) = = tree - > get_root ( ) ) {
// Renamed library
2023-11-06 23:27:44 +01:00
if ( mixer - > has_animation_library ( text ) ) {
2022-04-07 13:49:28 +02:00
restore_text = true ;
} else {
undo_redo - > create_action ( vformat ( TTR ( " Rename Animation Library: %s " ) , text ) ) ;
2023-07-20 17:34:06 +02:00
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 ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
2023-11-06 23:27:44 +01:00
Ref < AnimationLibrary > al = mixer - > get_animation_library ( library ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
2023-07-20 17:34:06 +02:00
undo_redo - > add_do_method ( this , " _update_editor " , mixer ) ;
undo_redo - > add_undo_method ( this , " _update_editor " , mixer ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
}
}
2022-06-17 17:53:42 +02:00
void AnimationLibraryEditor : : _button_pressed ( TreeItem * p_item , int p_column , int p_id , MouseButton p_button ) {
2022-04-07 13:49:28 +02:00
if ( p_item - > get_parent ( ) = = tree - > get_root ( ) ) {
// Library
StringName lib_name = p_item - > get_metadata ( 0 ) ;
2023-11-06 23:27:44 +01:00
Ref < AnimationLibrary > al = mixer - > get_animation_library ( lib_name ) ;
2022-06-17 17:53:42 +02:00
switch ( p_id ) {
2022-04-07 13:49:28 +02:00
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 " ) ) ;
2023-10-17 16:30:19 +02:00
file_dialog - > set_file_mode ( EditorFileDialog : : FILE_MODE_OPEN_FILES ) ;
2022-04-07 13:49:28 +02:00
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_valid ( ) ) {
error_dialog - > set_text ( TTR ( " No animation resource in clipboard! " ) ) ;
error_dialog - > popup_centered ( ) ;
return ;
}
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 + + ;
2022-05-14 18:54:14 +02:00
name = base_name + " ( " + itos ( attempt ) + " ) " ;
2022-04-07 13:49:28 +02:00
}
2022-12-23 23:53:16 +01:00
EditorUndoRedoManager * undo_redo = EditorUndoRedoManager : : get_singleton ( ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
2023-07-20 17:34:06 +02:00
undo_redo - > add_do_method ( this , " _update_editor " , mixer ) ;
undo_redo - > add_undo_method ( this , " _update_editor " , mixer ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
2023-01-18 13:49:14 +01:00
Vector2 popup_pos = tree - > get_screen_transform ( ) . xform ( pos . position + Vector2 ( 0 , pos . size . height ) ) ;
2022-04-07 13:49:28 +02:00
file_popup - > popup ( Rect2 ( popup_pos , Size2 ( ) ) ) ;
file_dialog_animation = StringName ( ) ;
file_dialog_library = lib_name ;
} break ;
case LIB_BUTTON_DELETE : {
2022-12-23 23:53:16 +01:00
EditorUndoRedoManager * undo_redo = EditorUndoRedoManager : : get_singleton ( ) ;
2022-04-07 13:49:28 +02:00
undo_redo - > create_action ( vformat ( TTR ( " Remove Animation Library: %s " ) , lib_name ) ) ;
2023-07-20 17:34:06 +02:00
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 ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
2023-11-06 23:27:44 +01:00
Ref < AnimationLibrary > al = mixer - > get_animation_library ( lib_name ) ;
2022-04-07 13:49:28 +02:00
Ref < Animation > anim = al - > get_animation ( anim_name ) ;
ERR_FAIL_COND ( ! anim . is_valid ( ) ) ;
2022-06-17 17:53:42 +02:00
switch ( p_id ) {
2022-04-07 13:49:28 +02:00
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 ) ;
2023-01-18 13:49:14 +01:00
Vector2 popup_pos = tree - > get_screen_transform ( ) . xform ( pos . position + Vector2 ( 0 , pos . size . height ) ) ;
2022-04-07 13:49:28 +02:00
file_popup - > popup ( Rect2 ( popup_pos , Size2 ( ) ) ) ;
file_dialog_animation = anim_name ;
file_dialog_library = lib_name ;
} break ;
case ANIM_BUTTON_DELETE : {
2022-12-23 23:53:16 +01:00
EditorUndoRedoManager * undo_redo = EditorUndoRedoManager : : get_singleton ( ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
2023-07-20 17:34:06 +02:00
undo_redo - > add_do_method ( this , " _update_editor " , mixer ) ;
undo_redo - > add_undo_method ( this , " _update_editor " , mixer ) ;
2022-04-07 13:49:28 +02:00
undo_redo - > commit_action ( ) ;
} break ;
}
}
}
void AnimationLibraryEditor : : update_tree ( ) {
if ( updating ) {
return ;
}
tree - > clear ( ) ;
2023-07-20 17:34:06 +02:00
ERR_FAIL_NULL ( mixer ) ;
2022-04-07 13:49:28 +02:00
2023-08-13 02:33:39 +02:00
Color ss_color = get_theme_color ( SNAME ( " prop_subsection " ) , EditorStringName ( Editor ) ) ;
2022-04-07 13:49:28 +02:00
TreeItem * root = tree - > create_item ( ) ;
2023-11-06 23:27:44 +01:00
List < StringName > libs ;
mixer - > get_animation_library_list ( & libs ) ;
2022-04-07 13:49:28 +02:00
2023-11-06 23:27:44 +01:00
for ( const StringName & K : libs ) {
2022-04-07 13:49:28 +02:00
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 , " " ) ;
}
2022-05-04 02:17:08 +02:00
2023-11-06 23:27:44 +01:00
Ref < AnimationLibrary > al = mixer - > get_animation_library ( K ) ;
2022-05-04 02:17:08 +02:00
bool animation_library_is_foreign = false ;
String al_path = al - > get_path ( ) ;
if ( ! al_path . is_resource_file ( ) ) {
2022-04-07 13:49:28 +02:00
libitem - > set_text ( 1 , TTR ( " [built-in] " ) ) ;
2022-08-29 15:55:49 +02:00
libitem - > set_tooltip_text ( 1 , al_path ) ;
2022-05-04 02:17:08 +02:00
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 ( ) ) ;
}
2022-04-07 13:49:28 +02:00
}
2022-05-04 02:17:08 +02:00
2022-10-28 00:09:17 +02:00
libitem - > set_editable ( 0 , true ) ;
2022-05-04 02:17:08 +02:00
libitem - > set_metadata ( 0 , K ) ;
2023-08-13 02:33:39 +02:00
libitem - > set_icon ( 0 , get_editor_theme_icon ( " AnimationLibrary " ) ) ;
2022-05-04 02:17:08 +02:00
2023-10-17 16:30:19 +02:00
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. " ) ) ;
2022-05-04 02:17:08 +02:00
2023-10-17 16:30:19 +02:00
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. " ) ) ;
2022-04-07 13:49:28 +02:00
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 ) ;
2022-05-04 02:17:08 +02:00
anitem - > set_editable ( 0 , ! animation_library_is_foreign ) ;
2022-04-07 13:49:28 +02:00
anitem - > set_metadata ( 0 , L ) ;
2023-08-13 02:33:39 +02:00
anitem - > set_icon ( 0 , get_editor_theme_icon ( " Animation " ) ) ;
2023-10-17 16:30:19 +02:00
anitem - > add_button ( 0 , get_editor_theme_icon ( " ActionCopy " ) , ANIM_BUTTON_COPY , animation_library_is_foreign , TTR ( " Copy animation to clipboard. " ) ) ;
2022-04-07 13:49:28 +02:00
2022-05-04 02:17:08 +02:00
Ref < Animation > anim = al - > get_animation ( L ) ;
String anim_path = anim - > get_path ( ) ;
if ( ! anim_path . is_resource_file ( ) ) {
2022-04-07 13:49:28 +02:00
anitem - > set_text ( 1 , TTR ( " [built-in] " ) ) ;
2022-08-29 15:55:49 +02:00
anitem - > set_tooltip_text ( 1 , anim_path ) ;
2022-05-04 02:17:08 +02:00
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 ( ) ) ;
}
2022-04-07 13:49:28 +02:00
}
2023-10-17 16:30:19 +02:00
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. " ) ) ;
2022-04-07 13:49:28 +02:00
}
}
}
void AnimationLibraryEditor : : show_dialog ( ) {
update_tree ( ) ;
popup_centered_ratio ( 0.5 ) ;
}
2024-01-03 08:03:13 +01:00
void AnimationLibraryEditor : : _notification ( int p_what ) {
switch ( p_what ) {
case NOTIFICATION_THEME_CHANGED : {
new_library_button - > set_icon ( get_editor_theme_icon ( SNAME ( " Add " ) ) ) ;
load_library_button - > set_icon ( get_editor_theme_icon ( SNAME ( " Load " ) ) ) ;
}
}
}
2023-07-20 17:34:06 +02:00
void AnimationLibraryEditor : : _update_editor ( Object * p_mixer ) {
emit_signal ( " update_editor " , p_mixer ) ;
2022-04-07 13:49:28 +02:00
}
void AnimationLibraryEditor : : _bind_methods ( ) {
2023-07-20 17:34:06 +02:00
ClassDB : : bind_method ( D_METHOD ( " _update_editor " , " mixer " ) , & AnimationLibraryEditor : : _update_editor ) ;
2022-04-07 13:49:28 +02:00
ADD_SIGNAL ( MethodInfo ( " update_editor " ) ) ;
}
AnimationLibraryEditor : : AnimationLibraryEditor ( ) {
set_title ( TTR ( " Edit Animation Libraries " ) ) ;
file_dialog = memnew ( EditorFileDialog ) ;
add_child ( file_dialog ) ;
file_dialog - > connect ( " file_selected " , callable_mp ( this , & AnimationLibraryEditor : : _load_file ) ) ;
2023-10-17 16:30:19 +02:00
file_dialog - > connect ( " files_selected " , callable_mp ( this , & AnimationLibraryEditor : : _load_files ) ) ;
2022-04-07 13:49:28 +02:00
add_library_dialog = memnew ( ConfirmationDialog ) ;
VBoxContainer * dialog_vb = memnew ( VBoxContainer ) ;
add_library_name = memnew ( LineEdit ) ;
dialog_vb - > add_child ( add_library_name ) ;
2024-05-14 11:42:00 +02:00
add_library_name - > connect ( SceneStringName ( text_changed ) , callable_mp ( this , & AnimationLibraryEditor : : _add_library_validate ) ) ;
2022-04-07 13:49:28 +02:00
add_child ( add_library_dialog ) ;
add_library_validate = memnew ( Label ) ;
dialog_vb - > add_child ( add_library_validate ) ;
add_library_dialog - > add_child ( dialog_vb ) ;
2024-05-14 14:28:18 +02:00
add_library_dialog - > connect ( SceneStringName ( confirmed ) , callable_mp ( this , & AnimationLibraryEditor : : _add_library_confirm ) ) ;
2022-04-07 13:49:28 +02:00
add_library_dialog - > register_text_enter ( add_library_name ) ;
VBoxContainer * vb = memnew ( VBoxContainer ) ;
HBoxContainer * hb = memnew ( HBoxContainer ) ;
hb - > add_spacer ( true ) ;
2024-01-03 08:03:13 +01:00
new_library_button = memnew ( Button ( TTR ( " New Library " ) ) ) ;
new_library_button - > set_tooltip_text ( TTR ( " Create new empty animation library. " ) ) ;
2024-05-14 09:40:21 +02:00
new_library_button - > connect ( SceneStringName ( pressed ) , callable_mp ( this , & AnimationLibraryEditor : : _add_library ) ) ;
2024-01-03 08:03:13 +01:00
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. " ) ) ;
2024-05-14 09:40:21 +02:00
load_library_button - > connect ( SceneStringName ( pressed ) , callable_mp ( this , & AnimationLibraryEditor : : _load_library ) ) ;
2024-01-03 08:03:13 +01:00
hb - > add_child ( load_library_button ) ;
2022-04-07 13:49:28 +02:00
vb - > add_child ( hb ) ;
tree = memnew ( Tree ) ;
vb - > add_child ( tree ) ;
2024-03-17 09:28:18 +01:00
tree - > set_auto_translate_mode ( AUTO_TRANSLATE_MODE_DISABLED ) ;
2022-04-07 13:49:28 +02:00
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 ( true ) ;
tree - > set_v_size_flags ( Control : : SIZE_EXPAND_FILL ) ;
tree - > connect ( " item_edited " , callable_mp ( this , & AnimationLibraryEditor : : _item_renamed ) ) ;
2021-09-18 09:33:18 +02:00
tree - > connect ( " button_clicked " , callable_mp ( this , & AnimationLibraryEditor : : _button_pressed ) ) ;
2022-04-07 13:49:28 +02:00
file_popup = memnew ( PopupMenu ) ;
add_child ( file_popup ) ;
2024-05-14 14:13:31 +02:00
file_popup - > connect ( SceneStringName ( id_pressed ) , callable_mp ( this , & AnimationLibraryEditor : : _file_popup_selected ) ) ;
2022-04-07 13:49:28 +02:00
add_child ( vb ) ;
error_dialog = memnew ( AcceptDialog ) ;
error_dialog - > set_title ( TTR ( " Error: " ) ) ;
add_child ( error_dialog ) ;
}