spine-runtimes/spine-godot/spine_godot/SpineAtlasResource.h

/******************************************************************************
 * Spine Runtimes License Agreement
 * Last updated April 5, 2025. Replaces all prior versions.
 *
 * Copyright (c) 2013-2025, 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.
 *****************************************************************************/

#pragma once

#include "SpineCommon.h"
#ifdef SPINE_GODOT_EXTENSION
#include <godot_cpp/classes/resource.hpp>
#include <godot_cpp/classes/resource_loader.hpp>
#include <godot_cpp/classes/resource_format_loader.hpp>
#include <godot_cpp/classes/resource_saver.hpp>
#include <godot_cpp/classes/resource_format_saver.hpp>
#include <spine/Atlas.h>
#else
#include "core/io/resource_loader.h"
#include "core/io/resource_saver.h"
#include "core/io/image_loader.h"
#include <spine/Atlas.h>
#endif

class GodotSpineTextureLoader;

class SpineAtlasResource : public Resource {
	GDCLASS(SpineAtlasResource, Resource)

	void clear();

protected:
	static void _bind_methods();

	mutable spine::Atlas *atlas;
	mutable GodotSpineTextureLoader *texture_loader;

	String source_path;
	String atlas_data;
	String normal_map_prefix;
	String specular_map_prefix;

	Array textures;
	Array normal_maps;
	Array specular_maps;

public:
	SpineAtlasResource();
	~SpineAtlasResource() override;

	spine::Atlas *get_spine_atlas() {
		return atlas;
	}

	void set_normal_texture_prefix(const String &prefix) {
		normal_map_prefix = prefix;
	}

	void set_specular_texture_prefix(const String &prefix) {
		specular_map_prefix = prefix;
	}

	Error load_from_atlas_file(const String &path);// .atlas

	Error load_from_atlas_file_internal(const String &path, bool is_importing);// .atlas

	Error load_from_file(const String &path);// .spatlas

	Error save_to_file(const String &path);// .spatlas

#ifndef SPINE_GODOT_EXTENSION
#if VERSION_MAJOR > 3
	virtual Error copy_from(const Ref<Resource> &p_resource);
#endif
#endif

	String get_source_path();

	Array get_textures();

	Array get_normal_maps();

	Array get_specular_maps();

	void clear_native_data() const {
		this->atlas = nullptr;
		this->texture_loader = nullptr;
	}
};

class SpineAtlasResourceFormatLoader : public ResourceFormatLoader {
	GDCLASS(SpineAtlasResourceFormatLoader, ResourceFormatLoader)

public:
#ifdef SPINE_GODOT_EXTENSION
	static void _bind_methods() {};

	PackedStringArray _get_recognized_extensions();

	bool _handles_type(const StringName &type);

	String _get_resource_type(const String &path);

	Variant _load(const String &path, const String &original_path, bool use_sub_threads, int32_t cache_mode);
#else
#if VERSION_MAJOR > 3
	RES load(const String &path, const String &original_path, Error *error, bool use_sub_threads, float *progress, CacheMode cache_mode) override;
#else
#if VERSION_MINOR > 5
	RES load(const String &path, const String &original_path, Error *error, bool no_subresource_cache = false) override;
#else
	RES load(const String &path, const String &original_path, Error *error) override;
#endif
#endif

	void get_recognized_extensions(List<String> *extensions) const override;

	bool handles_type(const String &type) const override;

	String get_resource_type(const String &path) const override;
#endif
};

class SpineAtlasResourceFormatSaver : public ResourceFormatSaver {
	GDCLASS(SpineAtlasResourceFormatSaver, ResourceFormatSaver)

public:
#ifdef SPINE_GODOT_EXTENSION
	static void _bind_methods() {};

	Error _save(const Ref<Resource> &resource, const String &path, uint32_t flags) override;

	bool _recognize(const Ref<Resource> &resource);

	PackedStringArray _get_recognized_extensions(const Ref<Resource> &resource);
#else
#if VERSION_MAJOR > 3
	Error save(const RES &resource, const String &path, uint32_t flags) override;
#else
	Error save(const String &path, const RES &resource, uint32_t flags) override;
#endif

	void get_recognized_extensions(const RES &resource, List<String> *extensions) const override;

	bool recognize(const RES &resource) const override;
#endif
};