Merge pull request #208 from OpenVicProject/sprite-texture

Added multipurpose GFXSpriteTexture + reworked GFXButtonStateTexture

1 files changed, 159 insertions, 0 deletions

diff --git a/extension/src/openvic-extension/classes/GFXSpriteTexture.cpp b/extension/src/openvic-extension/classes/GFXSpriteTexture.cpp
new file mode 100644
index 0000000..e002461
--- /dev/null
+++ b/extension/src/openvic-extension/classes/GFXSpriteTexture.cpp
@@ -0,0 +1,159 @@
+#include "GFXSpriteTexture.hpp"
+
+#include <godot_cpp/classes/rendering_server.hpp>
+#include <godot_cpp/variant/utility_functions.hpp>
+
+#include "openvic-extension/singletons/AssetManager.hpp"
+#include "openvic-extension/utility/ClassBindings.hpp"
+#include "openvic-extension/utility/UITools.hpp"
+#include "openvic-extension/utility/Utilities.hpp"
+
+using namespace godot;
+using namespace OpenVic;
+
+using OpenVic::Utilities::std_view_to_godot_string;
+using OpenVic::Utilities::std_view_to_godot_string_name;
+
+void GFXSpriteTexture::_bind_methods() {
+	OV_BIND_METHOD(GFXSpriteTexture::clear);
+
+	OV_BIND_METHOD(GFXSpriteTexture::set_gfx_texture_sprite_name, { "gfx_texture_sprite_name", "icon" }, DEFVAL(GFX::NO_FRAMES));
+	OV_BIND_METHOD(GFXSpriteTexture::get_gfx_texture_sprite_name);
+
+	OV_BIND_METHOD(GFXSpriteTexture::set_icon_index, { "new_icon_index" });
+	OV_BIND_METHOD(GFXSpriteTexture::get_icon_index);
+	OV_BIND_METHOD(GFXSpriteTexture::get_icon_count);
+
+	OV_BIND_METHOD(GFXSpriteTexture::is_cornered_tile_texture);
+	OV_BIND_METHOD(GFXSpriteTexture::draw_rect_cornered, { "to_canvas_item", "rect" });
+
+	ADD_PROPERTY(PropertyInfo(Variant::INT, "icon_index"), "set_icon_index", "get_icon_index");
+}
+
+GFXSpriteTexture::GFXSpriteTexture()
+  : gfx_texture_sprite { nullptr }, icon_index { GFX::NO_FRAMES }, icon_count { GFX::NO_FRAMES },
+	cornered_tile_texture { false }, cornered_tile_border_size {} {}
+
+Ref<GFXSpriteTexture> GFXSpriteTexture::make_gfx_sprite_texture(GFX::TextureSprite const* gfx_texture_sprite, GFX::frame_t icon) {
+	Ref<GFXSpriteTexture> texture;
+	texture.instantiate();
+	ERR_FAIL_NULL_V(texture, nullptr);
+	ERR_FAIL_COND_V(texture->set_gfx_texture_sprite(gfx_texture_sprite, icon) != OK, nullptr);
+	return texture;
+}
+
+void GFXSpriteTexture::clear() {
+	gfx_texture_sprite = nullptr;
+	_clear_button_states();
+	icon_index = GFX::NO_FRAMES;
+	icon_count = GFX::NO_FRAMES;
+	cornered_tile_texture = false;
+	cornered_tile_border_size = {};
+}
+
+Error GFXSpriteTexture::set_gfx_texture_sprite(GFX::TextureSprite const* new_gfx_texture_sprite, GFX::frame_t icon) {
+	if (gfx_texture_sprite != new_gfx_texture_sprite) {
+		if (new_gfx_texture_sprite == nullptr) {
+			clear();
+			return OK;
+		}
+		AssetManager* asset_manager = AssetManager::get_singleton();
+		ERR_FAIL_NULL_V(asset_manager, FAILED);
+
+		const StringName texture_file = std_view_to_godot_string_name(new_gfx_texture_sprite->get_texture_file());
+
+		/* Needed for GFXButtonStateTexture, AssetManager::get_texture will re-use this image from its internal cache. */
+		const Ref<Image> image = asset_manager->get_image(texture_file);
+		ERR_FAIL_NULL_V_MSG(image, FAILED, vformat("Failed to load image: %s", texture_file));
+
+		const Ref<ImageTexture> texture = asset_manager->get_texture(texture_file);
+		ERR_FAIL_NULL_V_MSG(texture, FAILED, vformat("Failed to load texture: %s", texture_file));
+
+		button_image = image;
+		gfx_texture_sprite = new_gfx_texture_sprite;
+		set_atlas(texture);
+		icon_index = GFX::NO_FRAMES;
+
+		GFX::IconTextureSprite const* const icon_texture_sprite = gfx_texture_sprite->cast_to<GFX::IconTextureSprite>();
+		if (icon_texture_sprite != nullptr) {
+			icon_count = icon_texture_sprite->get_no_of_frames();
+		} else {
+			icon_count = GFX::NO_FRAMES;
+		}
+
+		GFX::CorneredTileTextureSprite const* const cornered_tile_texture_sprite =
+			gfx_texture_sprite->cast_to<GFX::CorneredTileTextureSprite>();
+		if (cornered_tile_texture_sprite != nullptr) {
+			cornered_tile_texture = true;
+			cornered_tile_border_size = Utilities::to_godot_ivec2(cornered_tile_texture_sprite->get_border_size());
+		} else {
+			cornered_tile_texture = false;
+			cornered_tile_border_size = {};
+		}
+	}
+	return set_icon_index(icon);
+}
+
+Error GFXSpriteTexture::set_gfx_texture_sprite_name(String const& gfx_texture_sprite_name, GFX::frame_t icon) {
+	if (gfx_texture_sprite_name.is_empty()) {
+		return set_gfx_texture_sprite(nullptr);
+	}
+	GFX::Sprite const* sprite = UITools::get_gfx_sprite(gfx_texture_sprite_name);
+	ERR_FAIL_NULL_V(sprite, FAILED);
+	GFX::TextureSprite const* new_texture_sprite = sprite->cast_to<GFX::TextureSprite>();
+	ERR_FAIL_NULL_V_MSG(
+		new_texture_sprite, FAILED, vformat(
+			"Invalid type for GFX sprite %s: %s (expected %s)", gfx_texture_sprite_name,
+			std_view_to_godot_string(sprite->get_type()), std_view_to_godot_string(GFX::TextureSprite::get_type_static())
+		)
+	);
+	return set_gfx_texture_sprite(new_texture_sprite, icon);
+}
+
+String GFXSpriteTexture::get_gfx_texture_sprite_name() const {
+	return gfx_texture_sprite != nullptr ? std_view_to_godot_string(gfx_texture_sprite->get_name()) : String {};
+}
+
+Error GFXSpriteTexture::set_icon_index(int32_t new_icon_index) {
+	const Ref<Texture2D> atlas_texture = get_atlas();
+	ERR_FAIL_NULL_V(atlas_texture, FAILED);
+	const Vector2 size = atlas_texture->get_size();
+	if (icon_count <= GFX::NO_FRAMES) {
+		if (new_icon_index > GFX::NO_FRAMES) {
+			UtilityFunctions::push_warning("Invalid icon index ", new_icon_index, " for texture with no frames!");
+		}
+		icon_index = GFX::NO_FRAMES;
+		set_region({ {}, size });
+	} else {
+		if (GFX::NO_FRAMES < new_icon_index && new_icon_index <= icon_count) {
+			icon_index = new_icon_index;
+		} else {
+			icon_index = 1;
+			if (new_icon_index > icon_count) {
+				UtilityFunctions::push_warning(
+					"Invalid icon index ", new_icon_index, " out of count ", icon_count, " - defaulting to ", icon_index
+				);
+			}
+		}
+		set_region({ (icon_index - 1) * size.x / icon_count, 0, size.x / icon_count, size.y });
+	}
+	_update_button_states();
+	return OK;
+}
+
+void GFXSpriteTexture::draw_rect_cornered(RID const& to_canvas_item, Rect2 const& rect) const {
+	const Ref<Texture2D> atlas_texture = get_atlas();
+	if (atlas_texture.is_valid()) {
+		if (cornered_tile_texture) {
+			RenderingServer* rendering_server = RenderingServer::get_singleton();
+			if (rendering_server != nullptr) {
+				rendering_server->canvas_item_add_nine_patch(
+					to_canvas_item, rect, { {}, atlas_texture->get_size() }, atlas_texture->get_rid(),
+					cornered_tile_border_size, atlas_texture->get_size() - cornered_tile_border_size
+				);
+			}
+		} else {
+			draw_rect(to_canvas_item, rect, false);
+		}
+	}
+}