FreeTypeFont.h

/***********************************************************************
        filename:       CEGUIFreeTypeFont.h
        created:        3/6/2006
        author:         Andrew Zabolotny

        purpose:    Implementation of the Font class via the FreeType library
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
 *
 *   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 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.
 ***************************************************************************/
#ifndef _CEGUIFreeTypeFont_h_
#define _CEGUIFreeTypeFont_h_

#include "CEGUI/Font.h"
#include "CEGUI/DataContainer.h"
#include "CEGUI/BasicImage.h"

#include <ft2build.h>
#include FT_FREETYPE_H

// Start of CEGUI namespace section
namespace CEGUI
{
class FreeTypeFont : public Font
{
public:
    FreeTypeFont(const String& font_name, const float point_size,
                 const bool anti_aliased, const String& font_filename,
                 const String& resource_group = "",
                 const AutoScaledMode auto_scaled = ASM_Disabled,
                 const Sizef& native_res = Sizef(640.0f, 480.0f),
                 const float specific_line_spacing = 0.0f);

    ~FreeTypeFont();

    float getPointSize() const;

    bool isAntiAliased() const;

    void setPointSize(const float point_size);

    void setAntiAliased(const bool anti_alaised);

protected:
    void drawGlyphToBuffer(argb_t* buffer, uint buf_width) const;

    uint getTextureSize(CodepointMap::const_iterator s,
                        CodepointMap::const_iterator e) const;

    void addFreeTypeFontProperties();
    void free();

    void initialiseFontGlyph(CodepointMap::iterator cp) const;

    void initialiseGlyphMap();

    // overrides of functions in Font base class.
    const FontGlyph* findFontGlyph(const utf32 codepoint) const;
    void rasterise(utf32 start_codepoint, utf32 end_codepoint) const;
    void updateFont();
    void writeXMLToStream_impl (XMLSerializer& xml_stream) const;

    float d_specificLineSpacing;
    float d_ptSize;
    bool d_antiAliased;
    FT_Face d_fontFace;
    RawDataContainer d_fontData;
    typedef std::vector<Texture*
        CEGUI_VECTOR_ALLOC(Texture*)> TextureVector;
    mutable TextureVector d_glyphTextures;
    typedef std::vector<BasicImage*
        CEGUI_VECTOR_ALLOC(BasicImage*)> ImageVector;
    mutable ImageVector d_glyphImages;
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIFreeTypeFont_h_