TextRenderer.h

Go to the documentation of this file.

/*

Copyright (c) 2017, Dr Franck P. Vidal (franck.p.vidal@fpvidal.net),
http://www.fpvidal.net/
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

3. Neither the name of the Bangor University nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/


#ifndef __TextRenderer_h
#define __TextRenderer_h


//******************************************************************************
//  Include
//******************************************************************************
#ifndef __gVirtualXRayConfig_h
#include "gVirtualXRay/gVirtualXRayConfig.h"
#endif

#include <map>
#include <memory>

#ifdef HAS_FREETYPE
#include <ft2build.h>
#include FT_FREETYPE_H
#endif

#ifdef __VBO_h
#include "VBO.h"
#endif

#ifndef __Shader_h
#include "gVirtualXRay/Shader.h"
#endif

#ifdef __Vec3_h
#include "Vec3.h"
#endif


//******************************************************************************
//  namespace
//******************************************************************************
namespace gVirtualXRay {


//==============================================================================
//==============================================================================
class TextRenderer
//------------------------------------------------------------------------------
{
//******************************************************************************
private:
    //==========================================================================
    //==========================================================================
    class Character
    {
    //**************************************************************************
    public:
        //----------------------------------------------------------------------

        //----------------------------------------------------------------------
        Character(unsigned int aTextureID = 0,
                  int aWidth = 0,
                  int aHeight = 0,
                  float aVX = 0,
                  float aVY = 0,
                  float aXOffset = 0,
                  float aYOffset = 0);


        //----------------------------------------------------------------------
        //----------------------------------------------------------------------
        virtual ~Character();


        void release();
            

        unsigned int m_texture_id;  
        int          m_width;       
        int          m_height;      
        float        m_vx;          
        float        m_vy;          
        float        m_x_offset;    
        float        m_y_offset;    
    };

    
//******************************************************************************
public:
    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    inline TextRenderer();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    virtual ~TextRenderer();


    void release();

    
    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void initialise(unsigned int aFontSize = 16*38);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void initialize(unsigned int aFontSize = 16*38);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void initialise(const std::string aFontFile, unsigned int aFontSize = 16*38);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void initialize(const std::string aFontFile, unsigned int aFontSize = 16*38);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void renderText(const std::string& aText,
            float x, float y,
            Matrix4x4<GLfloat>& aProjectionMatrix,
            GLfloat* apBackgroundColour,
            GLfloat* apFontColour);

    
    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    bool isInitialised() const;


//******************************************************************************
protected:
    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void initialiseInternalStates(unsigned int aFontSize);


#ifdef HAS_FREETYPE
    FT_Library m_free_type;


    FT_Face m_face;


    std::map<char, Character> m_character_set;


#if __cplusplus < 199711L
    std::auto_ptr<VBO> m_text_vbo;
#else
    std::unique_ptr<VBO> m_text_vbo;
#endif


    Shader m_display_text_shader;
#endif

    bool m_initialised;
};


} // namespace gVirtualXRay


//******************************************************************************
#include "TextRenderer.inl"


#endif // __TextRenderer_h