C_objText.hpp

/*
 * Copyright 2024 Guillaume Guillet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef _FGE_C_OBJTEXT_HPP_INCLUDED
#define _FGE_C_OBJTEXT_HPP_INCLUDED
 
/*
 * Original from : https://github.com/SFML/SFML
 * Copyright (C) 2007-2022 Laurent Gomila
 *
 * Altered/Modified by Guillaume Guillet
 */
 
#include "FastEngine/fge_extern.hpp"
#include "C_object.hpp"
#include "FastEngine/accessor/C_font.hpp"
#include "FastEngine/graphic/C_glyph.hpp"
#include "tinyutf8.h"
#include <vector>
 
#define FGE_OBJTEXT_CLASSNAME "FGE:OBJ:TEXT"
 
namespace fge
{
 
class ObjText;
 
class FGE_API Character : public fge::Transformable
{
public:
    Character();
    Character(fge::Color const& fillColor, fge::Color const& outlineColor);
 
    void clear();
    void addLine(bool outlineVertices,
                 float lineLength,
                 float lineTop,
                 float offset,
                 float thickness,
                 float outlineThickness = 0.0f);
    void addGlyphQuad(bool outlineVertices,
                      fge::Vector2f const& size,
                      fge::Glyph const& glyph,
                      fge::Vector2i const& textureSize,
                      float italicShear);
 
    void draw(fge::TransformUboData const& externalTransform,
              fge::RenderTarget const& target,
              fge::RenderStates const& states) const;
 
    void setFillColor(fge::Color const& color);
    void setOutlineColor(fge::Color const& color);
 
    [[nodiscard]] fge::Color const& getFillColor() const;
    [[nodiscard]] fge::Color const& getOutlineColor() const;
 
    void setVisibility(bool visibility);
    [[nodiscard]] bool isVisible() const;
 
    [[nodiscard]] uint32_t getUnicode() const;
 
private:
    friend ObjText;
 
    fge::vulkan::VertexBuffer g_vertices;        
    fge::vulkan::VertexBuffer g_outlineVertices; 
 
    fge::Color g_fillColor{255, 255, 255};
    fge::Color g_outlineColor{0, 0, 0};
 
    uint32_t g_unicodeChar{0};
 
    bool g_visibility{true};
};
 
class FGE_API ObjText : public fge::Object
{
public:
    enum Style : uint8_t
    {
        Regular = 0,           
        Bold = 1 << 0,         
        Italic = 1 << 1,       
        Underlined = 1 << 2,   
        StrikeThrough = 1 << 3 
    };
 
    ObjText() = default;
    ObjText(tiny_utf8::string string,
            fge::Font font,
            fge::Vector2f const& position = {},
            fge::CharacterSize characterSize = 30);
    explicit ObjText(fge::Font font, fge::Vector2f const& position = {}, fge::CharacterSize characterSize = 30);
 
    FGE_OBJ_DEFAULT_COPYMETHOD(fge::ObjText)
 
    void setFont(fge::Font font);
    fge::Font const& getFont() const;
 
    void setString(tiny_utf8::string string);
 
    void setCharacterSize(fge::CharacterSize size);
 
    void setLineSpacingFactor(float spacingFactor);
    void setLetterSpacingFactor(float spacingFactor);
 
    void setStyle(std::underlying_type<Style>::type style);
 
    void setFillColor(fge::Color const& color);
    void setOutlineColor(fge::Color const& color);
 
    void setOutlineThickness(float thickness);
 
    tiny_utf8::string const& getString() const;
 
    fge::CharacterSize getCharacterSize() const;
 
    [[nodiscard]] float getLetterSpacingFactor() const;
    [[nodiscard]] float getLineSpacingFactor() const;
    [[nodiscard]] float getLineSpacing() const;
    [[nodiscard]] float getGlyphAdvance(uint32_t c) const;
 
    std::underlying_type<Style>::type getStyle() const;
 
    fge::Color const& getFillColor() const;
    fge::Color const& getOutlineColor() const;
 
    float getOutlineThickness() const;
 
    fge::Vector2f findCharacterPos(std::size_t index) const;
 
    std::vector<fge::Character>& getCharacters();
    std::vector<fge::Character> const& getCharacters() const;
 
    FGE_OBJ_DRAW_DECLARE
 
    void save(nlohmann::json& jsonObject, fge::Scene* scene) override;
    void load(nlohmann::json& jsonObject, fge::Scene* scene) override;
    void pack(fge::net::Packet& pck) override;
    void unpack(fge::net::Packet const& pck) override;
 
    char const* getClassName() const override;
    char const* getReadableClassName() const override;
 
    fge::RectFloat getGlobalBounds() const override;
    fge::RectFloat getLocalBounds() const override;
 
private:
    void ensureGeometryUpdate() const;
 
    tiny_utf8::string g_string;                         
    fge::Font g_font;                                   
    fge::CharacterSize g_characterSize{30};             
    float g_letterSpacingFactor{1.0f};                  
    float g_lineSpacingFactor{1.0f};                    
    std::underlying_type<Style>::type g_style{Regular}; 
    fge::Color g_fillColor{255, 255, 255};              
    fge::Color g_outlineColor{0, 0, 0};                 
    float g_outlineThickness{0.0f};                     
 
    mutable std::vector<Character> g_characters;
    mutable fge::RectFloat g_bounds;                    
    mutable bool g_geometryNeedUpdate{false};           
    mutable uint32_t g_fontTextureModificationCount{0}; 
};
 
} // namespace fge
 
#endif // _FGE_C_OBJTEXT_HPP_INCLUDED