FontGlyph.h

/***********************************************************************
    created:    Sun Jul 19 2009
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIFontGlyph_h_
#define _CEGUIFontGlyph_h_

#include "CEGUI/Image.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT FontGlyph:
    public AllocatedObject<FontGlyph>
{
public:
    FontGlyph(float advance = 0.0f, Image* image = 0, bool valid = false) :
        d_image(image),
        d_advance(advance),
        d_valid(valid)
    {}

    Image* getImage() const
    { return d_image; }

    Sizef getSize(float x_scale, float y_scale) const
    { return Sizef(getWidth(x_scale), getHeight(y_scale)); }

    float getWidth(float x_scale) const
    { return d_image->getRenderedSize().d_width * x_scale; }

    float getHeight(float y_scale) const
    { return d_image->getRenderedSize().d_height * y_scale; }

    float getRenderedAdvance(float x_scale) const
    { return (d_image->getRenderedSize().d_width +
              d_image->getRenderedOffset().d_x) * x_scale; }

    float getAdvance(float x_scale = 1.0) const
    { return d_advance * x_scale; }

    void setAdvance(float advance)
    { d_advance = advance; }

    void setImage(Image* image)
    { d_image = image; }

    void setValid(bool valid)
    { d_valid = valid; }

    bool isValid() const
    { return d_valid; }

private:
    Image* d_image;
    float d_advance;
    bool d_valid;
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIFontGlyph_h_