Font.h

Go to the documentation of this file.

#ifndef FONT_UTIL_H
#define FONT_UTIL_H

#include <exception>
#include <stdexcept>
#include <utility>
#include <vector>
#include <boost/utility/string_ref.hpp>
#include <glm/glm.hpp>

namespace glutil
{

    namespace detail
    {
        class FontImpl;
    }

    class Font;

    enum FontSizes
    {
        FONT_SIZE_SMALL,        
        FONT_SIZE_MEDIUM,       
        FONT_SIZE_LARGE,        
        FONT_SIZE_GIANT,        
    };

    Font *GenerateFont(FontSizes eSize);

    class GlyphQuad
    {
    public:
        GlyphQuad(glm::vec2 ptBottomLeft, glm::vec2 tcBottomLeft,
            glm::vec2 ptTopRight, glm::vec2 tcTopRight)
            : m_ptBottomLeft(ptBottomLeft)
            , m_tcBottomLeft(tcBottomLeft)
            , m_ptTopRight(ptTopRight)
            , m_tcTopRight(tcTopRight)
        {}

        std::vector<glm::vec2> GetPositions() const;

        std::vector<glm::vec2> GetTexCoords() const;

    private:
        glm::vec2 m_ptBottomLeft;
        glm::vec2 m_tcBottomLeft;
        glm::vec2 m_ptTopRight;
        glm::vec2 m_tcTopRight;
    };

    enum PointReference
    {
        REF_BASELINE,       
        REF_BOTTOM,         
        REF_TOP,            
    };

    class InvalidEncodingException : public std::runtime_error
    {
    public:
        InvalidEncodingException() : std::runtime_error("UTF-8 text is not valid.") {}
    };

    //Deletion of this object must happen while OpenGL is still active.
    class Font
    {
    public:
        ~Font();

        GLuint GetTexture() const;

        std::pair<GlyphQuad, bool> GetSingleGlyph(unsigned int codepoint, const glm::vec2 &ptReference,
            PointReference eRef = REF_BASELINE) const;

        std::vector<GlyphQuad> LayoutLine(boost::string_ref text, const glm::vec2 &ptReference,
            PointReference eRef = REF_BASELINE) const;

        int GetLinePixelHeight() const;

        int GetGlyphAdvanceWidth() const;

    private:
        detail::FontImpl *m_pImpl;

        explicit Font(detail::FontImpl *pImpl);

        friend Font *GenerateFont(FontSizes eSize);

        //Prevent copying
        Font(const Font &);
        Font &operator=(const Font &);
    };

}

#endif //FONT_UTIL_H