BitmapFont.h

Go to the documentation of this file.

// ****************************************************************************
// This file is part of the Integrating Vision Toolkit (IVT).
//
// The IVT is maintained by the Karlsruhe Institute of Technology (KIT)
// (www.kit.edu) in cooperation with the company Keyetech (www.keyetech.de).
//
// Copyright (C) 2014 Karlsruhe Institute of Technology (KIT).
// 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 KIT 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 KIT 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 KIT 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.
// ****************************************************************************
// ****************************************************************************
// Filename:  BitmapFont.h
// Copyright: Keyetech UG (haftungsbeschraenkt)
// Author:    Pedram Azad
// Date:      17.02.2012
// ****************************************************************************

#ifndef _BITMAP_FONT_H_
#define _BITMAP_FONT_H_


// ****************************************************************************
// Necessary includes
// ****************************************************************************

#include "Color/Color.h"


// ****************************************************************************
// Forward declarations
// ****************************************************************************

class CByteImage;



// ****************************************************************************
// CBitmapFont
// ****************************************************************************

class CBitmapFont
{
public:
        // constructor
        CBitmapFont();

        // destructor
        ~CBitmapFont();


        // public methods
        bool LoadPCFFont(const char *pFilePath);

        void DrawText(CByteImage *pImage, const char *pText, int x, int y, unsigned char r = 0, unsigned char g = 0, unsigned char b = 0) const;
        void DrawText(CByteImage *pImage, const char *pText, int x, int y, Color::Color color) const;

        int GetFontHeight() const { return m_nFontHeight; }


private:
        // private structs
        struct BitmapCharacter
        {
                int *pCoordinatesX;
                int *pCoordinatesY;
                int nCoordinates;
                int nWidth;
                int nAscent;
                int nDescent;
        };


        // private methods
        void Init(int nCharacters);
        void Reset();
        bool GetCharacterInformation(unsigned char encoding, int *&pCoordinatesX, int *&pCoordinatesY, int &nCoordinates, int &nWidth) const;
        void SetGlyph(int nIndex, int *pCoordinatesX, int *pCoordinatesY, int nCoordinates, int nWidth, int nAscent, int nDescent);
        void AddEncoding(int nEncoding, int nIndex);


        // private attributes
        int *m_pEncodingTable;
        int m_nMaxEncoding;

        BitmapCharacter *m_pCharacters;
        int m_nCharacters;

        int m_nFontHeight;
};



#endif // _BITMAP_FONT_H_