SLTexFont.h

Go to the documentation of this file.

/**
 * \file      SLTexFont.h
 * \date      July 2014
 * \authors   Marcus Hudritsch, original author is Philippe Decaudin
 * \copyright http://opensource.org/licenses/GPL-3.0
 * \remarks   Please use clangformat to format the code. See more code style on
 *            https://github.com/cpvrlab/SLProject4/wiki/SLProject-Coding-Style
*/
 
#ifndef SLTEXFONT
#define SLTEXFONT
 
#include <SLGLTexture.h>
 
class SLGLProgram;
 
//-----------------------------------------------------------------------------
//! Texture Font class inherits SLGLTexture for alpha blended font rendering.
/*!
This texture font class was originally inspired by the the font class of the
AntTweakBar library (http://www.antisphere.com/Wiki/tools:anttweakbar)
The source bitmap includes 224 characters starting from ascii char 32 (space) to
ascii char 255:
<PRE>
 !"#$%&'()*+,-./0123456789:;<=>?
\@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_
`abcdefghijklmnopqrstuvwxyz{|}~
���������������������������������������������������������������
��������������������������������
��������������������������������
</PRE>
First column of a source bitmap is a delimiter with color=zero at the end of
each line of characters. Last row of a line of characters is a delimiter with
color=zero at the last pixel of each character.
The source bitmaps for the fonts are in the folder _data/fonts. The where used
for design only. Their data is directly included a binary array in the source
file SLTexFont.cpp.
*/
class SLTexFont : public SLGLTexture
{
public:
    SLTexFont(SLstring fontFilename, SLGLProgram* fontTexProgram);
    SLTexFont(SLstring fontFilename, SLstring shaderDir);
    ~SLTexFont();
 
    void         create(SLstring fontFilename);
    SLVec2f      calcTextSize(const SLstring& text,
                              SLfloat         maxWidth         = 0.0f,
                              SLfloat         lineHeightFactor = 1.5f);
    SLVstring    wrapTextToLines(SLstring text,
                                 SLfloat  maxW);
    void         buildTextBuffers(SLGLVertexArray& vao,
                                  const SLstring&  text,
                                  SLfloat          maxWidth   = 0.0f,
                                  SLfloat          lineHeight = 1.5f);
    SLGLProgram* fontTexProgram() { return _fontTexProgram; }
 
    //! Single Character info struct w. min. and max. texcoords.
    typedef struct
    {
        SLfloat width; //!< Width of char. in tex-coord.
        SLfloat tx1;   //!< Min. Texture x-coord.
        SLfloat ty1;   //!< Max. Texture y-coord.
        SLfloat tx2;   //!< Max. Texture x-coord.
        SLfloat ty2;   //!< Min. Texture y-coord.
    } SLTexFontChar;
 
    SLTexFontChar chars[256];  //<! array of character info structs
    SLint         charsHeight; //<! height of characters
 
    SLGLProgram* _fontTexProgram = nullptr;
    bool         _deleteProgram  = false;
};
//-----------------------------------------------------------------------------
#endif