Sprite.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_SPRITE_HPP
#define TGUI_SPRITE_HPP
 
#include <TGUI/Texture.hpp>
#include <TGUI/Vector2.hpp>
#include <TGUI/Rect.hpp>
#include <TGUI/Color.hpp>
#include <TGUI/RenderStates.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
    #include <vector>
    #include <memory>
#endif

 
TGUI_MODULE_EXPORT namespace tgui
{

    class TGUI_API Sprite
    {
    public:

        enum class ScalingType
        {
            Normal,     
            Horizontal, 
            Vertical,   
            NineSlice   
        };

    public:

        Sprite() = default;

        Sprite(const Texture& texture);

        Sprite(const Sprite&);

        Sprite(Sprite&&) noexcept;

        ~Sprite();

        Sprite& operator=(const Sprite&);

        Sprite& operator=(Sprite&&) noexcept;

        void setTexture(const Texture& texture);

        TGUI_NODISCARD const Texture& getTexture() const;

        TGUI_NODISCARD bool isSet() const;

        void setSize(Vector2f size);

        TGUI_NODISCARD Vector2f getSize() const;

        void setOpacity(float opacity);

        TGUI_NODISCARD float getOpacity() const;

        void setVisibleRect(const FloatRect& visibleRect);

        TGUI_NODISCARD FloatRect getVisibleRect() const;

        void setPosition(Vector2f position);

        TGUI_NODISCARD Vector2f getPosition() const;

        void setRotation(float angle);

        TGUI_NODISCARD float getRotation() const;

        TGUI_NODISCARD bool isTransparentPixel(Vector2f pos) const;

        TGUI_NODISCARD ScalingType getScalingType() const;

        TGUI_NODISCARD const std::shared_ptr<BackendTexture>& getSvgTexture() const
        {
            return m_svgTexture;
        }

        TGUI_NODISCARD const std::vector<Vertex>& getVertices() const
        {
            return m_vertices;
        }

        TGUI_NODISCARD const std::vector<unsigned int>& getIndices() const
        {
            return m_indices;
        }

        void updateVertices();

    private:
 
        Vector2f    m_size;
        Texture     m_texture;
        std::shared_ptr<BackendTexture> m_svgTexture;
        std::vector<Vertex> m_vertices;
        std::vector<unsigned int> m_indices;
 
        FloatRect   m_visibleRect;
 
        Color       m_vertexColor = Color::White;
        float       m_opacity = 1;
        float       m_rotation = 0;
        Vector2f    m_position;
 
        ScalingType m_scalingType = ScalingType::Normal;
    };

}

 
#endif // TGUI_SPRITE_HPP