/****************************************************************************** * Spine Runtimes License Agreement * Last updated July 28, 2023. Replaces all prior versions. * * Copyright (c) 2013-2023, Esoteric Software LLC * * Integration of the Spine Runtimes into software or otherwise creating * derivative works of the Spine Runtimes is permitted under the terms and * conditions of Section 2 of the Spine Editor License Agreement: * http://esotericsoftware.com/spine-editor-license * * Otherwise, it is permitted to integrate the Spine Runtimes into software or * otherwise create derivative works of the Spine Runtimes (collectively, * "Products"), provided that each user of the Products must obtain their own * Spine Editor license and redistribution of the Products in any form must * include this license and copyright notice. * * THE SPINE RUNTIMES ARE PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, * BUSINESS INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THE * SPINE RUNTIMES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *****************************************************************************/ #ifdef TOOLS_ENABLED #include "SpineEditorPlugin.h" #include "SpineAtlasResource.h" #include "SpineSkeletonFileResource.h" #if VERSION_MAJOR > 3 #include "editor/editor_undo_redo_manager.h" Error SpineAtlasResourceImportPlugin::import(const String &source_file, const String &save_path, const HashMap &options, List *platform_variants, List *gen_files, Variant *metadata) { #else Error SpineAtlasResourceImportPlugin::import(const String &source_file, const String &save_path, const Map &options, List *platform_variants, List *gen_files, Variant *metadata) { #endif Ref atlas(memnew(SpineAtlasResource)); atlas->set_normal_texture_prefix(options["normal_map_prefix"]); atlas->load_from_atlas_file(source_file); String file_name = vformat("%s.%s", save_path, get_save_extension()); #if VERSION_MAJOR > 3 auto error = ResourceSaver::save(atlas, file_name); #else auto error = ResourceSaver::save(file_name, atlas); #endif return error; } #if VERSION_MAJOR > 3 void SpineAtlasResourceImportPlugin::get_import_options(const String &path, List *options, int preset) const { #else void SpineAtlasResourceImportPlugin::get_import_options(List *options, int preset) const { #endif if (preset == 0) { ImportOption op; op.option.name = "normal_map_prefix"; op.option.type = Variant::STRING; op.option.hint_string = "String"; op.default_value = String("n"); options->push_back(op); } } #if VERSION_MAJOR > 3 Error SpineJsonResourceImportPlugin::import(const String &source_file, const String &save_path, const HashMap &options, List *platform_variants, List *gen_files, Variant *metadata) { #else Error SpineJsonResourceImportPlugin::import(const String &source_file, const String &save_path, const Map &options, List *platform_variants, List *gen_files, Variant *metadata) { #endif Ref skeleton_file_res(memnew(SpineSkeletonFileResource)); Error error = skeleton_file_res->load_from_file(source_file); if (error != OK) return error; String file_name = vformat("%s.%s", save_path, get_save_extension()); #if VERSION_MAJOR > 3 error = ResourceSaver::save(skeleton_file_res, file_name); #else error = ResourceSaver::save(file_name, skeleton_file_res); #endif return error; } #if VERSION_MAJOR > 3 Error SpineBinaryResourceImportPlugin::import(const String &source_file, const String &save_path, const HashMap &options, List *platform_variants, List *gen_files, Variant *metadata) { #else Error SpineBinaryResourceImportPlugin::import(const String &source_file, const String &save_path, const Map &options, List *platform_variants, List *gen_files, Variant *metadata) { #endif Ref skeleton_file_res(memnew(SpineSkeletonFileResource)); Error error = skeleton_file_res->load_from_file(source_file); if (error != OK) return error; String file_name = vformat("%s.%s", save_path, get_save_extension()); #if VERSION_MAJOR > 3 error = ResourceSaver::save(skeleton_file_res, file_name); #else error = ResourceSaver::save(file_name, skeleton_file_res); #endif return error; } SpineEditorPlugin::SpineEditorPlugin(EditorNode *node) { add_import_plugin(memnew(SpineAtlasResourceImportPlugin)); add_import_plugin(memnew(SpineJsonResourceImportPlugin)); add_import_plugin(memnew(SpineBinaryResourceImportPlugin)); add_inspector_plugin(memnew(SpineSkeletonDataResourceInspectorPlugin)); add_inspector_plugin(memnew(SpineSpriteInspectorPlugin)); } bool SpineSkeletonDataResourceInspectorPlugin::can_handle(Object *object) { return object->is_class("SpineSkeletonDataResource"); } #if VERSION_MAJOR > 3 bool SpineSkeletonDataResourceInspectorPlugin::parse_property(Object *object, const Variant::Type type, const String &path, const PropertyHint hint, const String &hint_text, const BitField p_usage, const bool wide) { #else bool SpineSkeletonDataResourceInspectorPlugin::parse_property(Object *object, Variant::Type type, const String &path, PropertyHint hint, const String &hint_text, int usage) { #endif if (path == "animation_mixes") { Ref skeleton_data = Object::cast_to(object); if (!skeleton_data.is_valid() || !skeleton_data->is_skeleton_data_loaded()) return true; auto mixes_property = memnew(SpineEditorPropertyAnimationMixes); mixes_property->setup(skeleton_data); add_property_editor(path, mixes_property); return true; } return false; } SpineEditorPropertyAnimationMixes::SpineEditorPropertyAnimationMixes() : skeleton_data(nullptr), container(nullptr), updating(false) { INSTANTIATE(array_object); } void SpineEditorPropertyAnimationMixes::_bind_methods() { ClassDB::bind_method(D_METHOD("add_mix"), &SpineEditorPropertyAnimationMixes::add_mix); ClassDB::bind_method(D_METHOD("delete_mix"), &SpineEditorPropertyAnimationMixes::delete_mix); ClassDB::bind_method(D_METHOD("update_mix_property"), &SpineEditorPropertyAnimationMixes::update_mix_property); } void SpineEditorPropertyAnimationMixes::add_mix() { if (!skeleton_data.is_valid() || !skeleton_data->is_skeleton_data_loaded() || updating) return; Vector animation_names; skeleton_data->get_animation_names(animation_names); Ref mix = Ref(memnew(SpineAnimationMix)); mix->set_from(animation_names[0]); mix->set_to(animation_names[0]); mix->set_mix(0); Array mixes = skeleton_data->get_animation_mixes().duplicate(); mixes.push_back(mix); emit_changed(get_edited_property(), mixes); } void SpineEditorPropertyAnimationMixes::delete_mix(int idx) { if (!skeleton_data.is_valid() || !skeleton_data->is_skeleton_data_loaded() || updating) return; auto mixes = skeleton_data->get_animation_mixes().duplicate(); #if VERSION_MAJOR > 3 mixes.remove_at((int) idx); #else mixes.remove((int) idx); #endif emit_changed(get_edited_property(), mixes); } void SpineEditorPropertyAnimationMixes::update_mix_property(int index) { if (index < 0 || index > mix_properties.size()) return; mix_properties[index]->update_property(); } void SpineEditorPropertyAnimationMixes::update_property() { if (updating) return; updating = true; mix_properties.clear(); if (container) { set_bottom_editor(nullptr); memdelete(container); container = nullptr; } if (!skeleton_data.is_valid() || !skeleton_data->is_skeleton_data_loaded()) { updating = false; return; } Vector animation_names; skeleton_data->get_animation_names(animation_names); container = memnew(VBoxContainer); add_child(container); set_bottom_editor(container); Array mixes = skeleton_data->get_animation_mixes(); array_object->set_array(mixes); for (int i = 0; i < mixes.size(); i++) { Ref mix = mixes[i]; String property_name = "indices/" + itos(i); auto hbox = memnew(HBoxContainer); hbox->set_h_size_flags(SIZE_EXPAND_FILL); container->add_child(hbox); auto mix_property = memnew(SpineEditorPropertyAnimationMix); mix_property->set_h_size_flags(SIZE_EXPAND_FILL); mix_property->set_name_split_ratio(0); hbox->add_child(mix_property); mix_property->setup(this, skeleton_data, i); mix_property->set_object_and_property(*array_object, property_name); mix_property->update_property(); mix_properties.push_back(mix_property); auto delete_button = memnew(Button); hbox->add_child(delete_button); delete_button->set_text("Remove"); #if VERSION_MAJOR > 3 delete_button->connect("pressed", callable_mp(this, &SpineEditorPropertyAnimationMixes::delete_mix).bind(varray(i))); #else delete_button->connect("pressed", this, "delete_mix", varray(i)); #endif } auto add_mix_button = memnew(Button); add_mix_button->set_text("Add mix"); #if VERSION_MAJOR > 3 add_mix_button->connect("pressed", callable_mp(this, &SpineEditorPropertyAnimationMixes::add_mix)); #else add_mix_button->connect("pressed", this, "add_mix"); #endif container->add_child(add_mix_button); updating = false; } SpineEditorPropertyAnimationMix::SpineEditorPropertyAnimationMix() : mixes_property(nullptr), skeleton_data(nullptr), index(0), container(nullptr), updating(false) { } void SpineEditorPropertyAnimationMix::setup(SpineEditorPropertyAnimationMixes *_mixes_property, const Ref &_skeleton_data, int _index) { this->mixes_property = _mixes_property; this->skeleton_data = _skeleton_data; this->index = _index; } void SpineEditorPropertyAnimationMix::_bind_methods() { ClassDB::bind_method(D_METHOD("data_changed"), &SpineEditorPropertyAnimationMix::data_changed); } void SpineEditorPropertyAnimationMix::data_changed(const String &property, const Variant &value, const String &name, bool changing) { auto mix = Object::cast_to(get_edited_object()->get(get_edited_property())); #if VERSION_MAJOR > 3 auto undo_redo = EditorUndoRedoManager::get_singleton(); #else auto undo_redo = EditorNode::get_undo_redo(); #endif undo_redo->create_action("Set mix property " + property); undo_redo->add_do_property(mix, property, value); undo_redo->add_undo_property(mix, property, mix->get(property)); undo_redo->add_do_method(mixes_property, "update_mix_property", index); undo_redo->add_undo_method(mixes_property, "update_mix_property", index); // temporarily disable rebuilding the UI, as commit_action() calls update() which calls update_property(). however, // data_changed is invoked by the control that changed the property, which would get deleted in update_property(). updating = true; undo_redo->commit_action(); updating = false; emit_changed(property, value, name, changing); } void SpineEditorPropertyAnimationMix::update_property() { if (updating) return; updating = true; if (container) { memdelete(container); #if VERSION_MAJOR > 3 SceneTree::get_singleton()->queue_delete(container); #else container->queue_delete(); #endif container = nullptr; } if (!skeleton_data.is_valid() || !skeleton_data->is_skeleton_data_loaded()) { updating = false; return; } auto mix = Object::cast_to(get_edited_object()->get(get_edited_property())); if (!mix) { updating = false; return; } Vector animation_names; skeleton_data->get_animation_names(animation_names); container = memnew(HBoxContainer); container->set_h_size_flags(SIZE_EXPAND_FILL); add_child(container); auto from_enum = memnew(EditorPropertyTextEnum); from_enum->set_h_size_flags(SIZE_EXPAND_FILL); from_enum->set_name_split_ratio(0); from_enum->set_selectable(false); from_enum->setup(animation_names); from_enum->set_object_and_property(mix, "from"); from_enum->update_property(); #if VERSION_MAJOR > 3 from_enum->connect("property_changed", callable_mp(this, &SpineEditorPropertyAnimationMix::data_changed)); #else from_enum->connect("property_changed", this, "data_changed"); #endif container->add_child(from_enum); auto to_enum = memnew(EditorPropertyTextEnum); to_enum->set_h_size_flags(SIZE_EXPAND_FILL); to_enum->set_name_split_ratio(0); to_enum->set_selectable(false); to_enum->setup(animation_names); to_enum->set_object_and_property(mix, "to"); to_enum->update_property(); #if VERSION_MAJOR > 3 to_enum->connect("property_changed", callable_mp(this, &SpineEditorPropertyAnimationMix::data_changed)); #else to_enum->connect("property_changed", this, "data_changed"); #endif container->add_child(to_enum); auto mix_float = memnew(EditorPropertyFloat); mix_float->set_h_size_flags(SIZE_EXPAND_FILL); mix_float->set_name_split_ratio(0); mix_float->set_selectable(false); mix_float->setup(0, 9999999, 0.001, true, false, false, false); mix_float->set_object_and_property(mix, "mix"); mix_float->update_property(); #if VERSION_MAJOR > 3 mix_float->connect("property_changed", callable_mp(this, &SpineEditorPropertyAnimationMix::data_changed)); #else mix_float->connect("property_changed", this, "data_changed"); #endif container->add_child(mix_float); updating = false; } void SpineSpriteInspectorPlugin::_bind_methods() { ClassDB::bind_method(D_METHOD("button_clicked"), &SpineSpriteInspectorPlugin::button_clicked); } void SpineSpriteInspectorPlugin::button_clicked(const String &button_name) { } bool SpineSpriteInspectorPlugin::can_handle(Object *object) { return Object::cast_to(object) != nullptr; } void SpineSpriteInspectorPlugin::parse_begin(Object *object) { sprite = Object::cast_to(object); if (!sprite) return; if (!sprite->get_skeleton_data_res().is_valid() || !sprite->get_skeleton_data_res()->is_skeleton_data_loaded()) return; } #endif