text.hpp

Go to the documentation of this file.

/*
 Copyright (c) 2026 ETIB Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
 the Software without restriction, including without limitation the rights to
 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is furnished to do
 so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
#pragma once
 
#include <cmath>
#include <string>
 
#include <utility/graphic/renderable.hpp>
 
#include <utility/graphic/color.hpp>
#include <utility/graphic/pose.hpp>
 
#include <utility/graphic/mesh.hpp>
 
#include <utility/graphic/text/font.hpp>
 
#include <utility/graphic/color.hpp>
#include <utility/graphic/size.hpp>
#include <utility/math/vector.hpp>
 
#include <utility/system_io/file.hpp>
#include <utility/ressource_provider.hpp>
 
#include <utility/graphic/text/code_point.hpp>
 
#include <utility/logging/loggable.hpp>
#include <utility/logging/default_logger.hpp>
 
#define DEFAULT_FONT_COLOR \
    utility::graphic::Color<std::uint8_t>(255, 255, 255, 255)
 
namespace utility::graphic
{
 
    class Text:
        public Renderable,
        protected logging::Loggable<Text, logging::DefaultLogger>
    {
        private:
        std::string _content;     
        std::string _fontPath;    
        float _fontSize;          
 
        protected:
        std::shared_ptr<Font>
            _font;    
 
        void updateMesh(void);
 
        codePointString utf8ToCodepoints(const std::string &str)
            const;    //< Convert UTF-8 string to Unicode code points
 
        public:
        Text(std::shared_ptr<RessourceProvider> ressourceProvider,
             const PoseF &pose, const Color32Bit &color,
             const std::string &content, uint32_t fontSize,
             const std::string &font);
 
        Text(const Text &other) = delete;
 
        Text(Text &&other) noexcept = default;
 
        std::shared_ptr<Mesh> getMesh() const;
 
        const std::string &getFontFamily(void) const;
 
        Text &operator=(const Text &other) = delete;
 
        Text &operator=(Text &&other) noexcept = default;
 
        const std::string &getContent(void) const;
 
        Text &setContent(const std::string &content);
 
        uint32_t getFontSize(void) const;
 
        graphic::SizeF getTextDimensions(void) const;
 
        Text &setFontSize(uint32_t fontSize);
 
        RenderableType getRenderableType(void) const override;
 
        std::string getMaterialName() const override;
 
        bool empty(void) const noexcept
        {
            return _content.empty();
        }
 
        bool hasFontPath(void) const noexcept
        {
            return !_fontPath.empty();
        }
 
        Text &clearContent(void)
        {
            _content.clear();
            return *this;
        }
 
        bool operator==(const Text &other) const
        {
            return _content == other._content && _fontPath == other._fontPath
                && _fontSize == other._fontSize && _color == other._color
                && _pose == other._pose;
        }
 
        bool operator!=(const Text &other) const
        {
            return !(*this == other);
        }
    };
 
}    // namespace utility::graphic