Crazy Eddie's GUI System  0.8.4
FontGlyph.h
00001 /***********************************************************************
00002     created:    Sun Jul 19 2009
00003     author:     Paul D Turner <paul@cegui.org.uk>
00004 *************************************************************************/
00005 /***************************************************************************
00006  *   Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
00007  *
00008  *   Permission is hereby granted, free of charge, to any person obtaining
00009  *   a copy of this software and associated documentation files (the
00010  *   "Software"), to deal in the Software without restriction, including
00011  *   without limitation the rights to use, copy, modify, merge, publish,
00012  *   distribute, sublicense, and/or sell copies of the Software, and to
00013  *   permit persons to whom the Software is furnished to do so, subject to
00014  *   the following conditions:
00015  *
00016  *   The above copyright notice and this permission notice shall be
00017  *   included in all copies or substantial portions of the Software.
00018  *
00019  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00020  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00021  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00022  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00023  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00024  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00025  *   OTHER DEALINGS IN THE SOFTWARE.
00026  ***************************************************************************/
00027 #ifndef _CEGUIFontGlyph_h_
00028 #define _CEGUIFontGlyph_h_
00029 
00030 #include "CEGUI/Image.h"
00031 
00032 // Start of CEGUI namespace section
00033 namespace CEGUI
00034 {
00042 class CEGUIEXPORT FontGlyph:
00043     public AllocatedObject<FontGlyph>
00044 {
00045 public:
00047     FontGlyph(float advance = 0.0f, Image* image = 0, bool valid = false) :
00048         d_image(image),
00049         d_advance(advance),
00050         d_valid(valid)
00051     {}
00052 
00054     Image* getImage() const
00055     { return d_image; }
00056 
00058     Sizef getSize(float x_scale, float y_scale) const
00059     { return Sizef(getWidth(x_scale), getHeight(y_scale)); }
00060 
00062     float getWidth(float x_scale) const
00063     { return d_image->getRenderedSize().d_width * x_scale; }
00064 
00066     float getHeight(float y_scale) const
00067     { return d_image->getRenderedSize().d_height * y_scale; }
00068 
00076     float getRenderedAdvance(float x_scale) const
00077     { return (d_image->getRenderedSize().d_width +
00078               d_image->getRenderedOffset().d_x) * x_scale; }
00079 
00089     float getAdvance(float x_scale = 1.0) const
00090     { return d_advance * x_scale; }
00091 
00093     void setAdvance(float advance)
00094     { d_advance = advance; }
00095 
00097     void setImage(Image* image)
00098     { d_image = image; }
00099 
00101     void setValid(bool valid)
00102     { d_valid = valid; }
00103 
00105     bool isValid() const
00106     { return d_valid; }
00107 
00108 private:
00110     Image* d_image;
00112     float d_advance;
00114     bool d_valid;
00115 };
00116 
00117 } // End of  CEGUI namespace section
00118 
00119 #endif  // end of guard _CEGUIFontGlyph_h_
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends