CEGUIFont.h

/***********************************************************************
    filename:   CEGUIFont.h
    created:    21/2/2004
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 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 _CEGUIFont_h_
#define _CEGUIFont_h_

#include "CEGUIBase.h"
#include "CEGUIPropertySet.h"
#include "CEGUIString.h"
#include "CEGUIXMLSerializer.h"
#include "CEGUIFontGlyph.h"

#include <map>

#if defined(_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT Font : public PropertySet
{
public:
    static const argb_t DefaultColour;

    virtual ~Font();

    const String& getName() const;

    const String& getTypeName() const;

    bool isCodepointAvailable(utf32 cp) const
    { return (d_cp_map.find(cp) != d_cp_map.end()); }

    void drawText(GeometryBuffer& buffer, const String& text,
                  const Vector2& position, const Rect* clip_rect,
                  const ColourRect& colours, const float space_extra = 0.0f,
                  const float x_scale = 1.0f, const float y_scale = 1.0f);

    void setNativeResolution(const Size& size);

    Size getNativeResolution() const;

    void setAutoScaled(const bool auto_scaled);

    bool isAutoScaled() const;

    virtual void notifyDisplaySizeChanged(const Size& size);

    float getLineSpacing(float y_scale = 1.0f) const
    { return d_height * y_scale; }

    float getFontHeight(float y_scale = 1.0f) const
    { return (d_ascender - d_descender) * y_scale; }

    float getBaseline(float y_scale = 1.0f) const
    { return d_ascender * y_scale; }

    float getTextExtent(const String& text, float x_scale = 1.0f) const;

    size_t getCharAtPixel(const String& text, float pixel,
                          float x_scale = 1.0f) const
    { return getCharAtPixel(text, 0, pixel, x_scale); }

    size_t getCharAtPixel(const String& text, size_t start_char, float pixel,
                          float x_scale = 1.0f) const;

    static void setDefaultResourceGroup(const String& resourceGroup)
    { d_defaultResourceGroup = resourceGroup; }

    static const String& getDefaultResourceGroup()
    { return d_defaultResourceGroup; }

    void writeXMLToStream(XMLSerializer& xml_stream) const;

    const FontGlyph* getGlyphData(utf32 codepoint) const;

protected:
    Font(const String& name, const String& type_name, const String& filename,
         const String& resource_group, const bool auto_scaled,
         const float native_horz_res, const float native_vert_res);

    virtual void rasterise(utf32 start_codepoint, utf32 end_codepoint) const;

    virtual void updateFont() = 0;

    virtual void writeXMLToStream_impl(XMLSerializer& xml_stream) const = 0;

    void addFontProperties();

    void setMaxCodepoint(utf32 codepoint);

    String d_name;
    String d_type;
    String d_filename;
    String d_resourceGroup;
    static String d_defaultResourceGroup;

    float d_ascender;
    float d_descender;
    float d_height;

    bool d_autoScale;
    float d_nativeHorzRes;
    float d_nativeVertRes;
    float d_horzScaling;
    float d_vertScaling;

    utf32 d_maxCodepoint;

    uint* d_glyphPageLoaded;

    typedef std::map<utf32, FontGlyph> CodepointMap;
    CodepointMap d_cp_map;
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#   pragma warning(pop)
#endif


#endif  // end of guard _CEGUIFont_h_