Crazy Eddie's GUI System  ${CEGUI_VERSION}
debian/tmp/usr/include/cegui-0.8.7/CEGUI/Font.h
1 /***********************************************************************
2  created: 21/2/2004
3  author: Paul D Turner <paul@cegui.org.uk>
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining
9  * a copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sublicense, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be
17  * included in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  ***************************************************************************/
27 #ifndef _CEGUIFont_h_
28 #define _CEGUIFont_h_
29 
30 #include "CEGUI/Base.h"
31 #include "CEGUI/PropertySet.h"
32 #include "CEGUI/EventSet.h"
33 #include "CEGUI/String.h"
34 #include "CEGUI/XMLSerializer.h"
35 #include "CEGUI/FontGlyph.h"
36 
37 #include <map>
38 
39 #if defined(_MSC_VER)
40 # pragma warning(push)
41 # pragma warning(disable : 4251)
42 #endif
43 
44 // Start of CEGUI namespace section
45 namespace CEGUI
46 {
58 class CEGUIEXPORT Font :
59  public PropertySet,
60  public EventSet,
61  public AllocatedObject<Font>
62 {
63 public:
65  static const argb_t DefaultColour;
66 
68  static const String EventNamespace;
74  static const String EventRenderSizeChanged;
75 
77  virtual ~Font();
78 
80  const String& getName() const;
81 
83  const String& getTypeName() const;
84 
86  const String& getFileName() const;
87 
99  bool isCodepointAvailable(utf32 cp) const
100  { return (d_cp_map.find(cp) != d_cp_map.end()); }
101 
141  float drawText(GeometryBuffer& buffer, const String& text,
142  const Vector2f& position, const Rectf* clip_rect,
143  const ColourRect& colours, const float space_extra = 0.0f,
144  const float x_scale = 1.0f, const float y_scale = 1.0f) const;
145 
153  void setNativeResolution(const Sizef& size);
154 
163  const Sizef& getNativeResolution() const;
164 
174  void setAutoScaled(const AutoScaledMode auto_scaled);
175 
183  AutoScaledMode getAutoScaled() const;
184 
192  virtual void notifyDisplaySizeChanged(const Sizef& size);
193 
206  float getLineSpacing(float y_scale = 1.0f) const
207  { return d_height * y_scale; }
208 
221  float getFontHeight(float y_scale = 1.0f) const
222  { return (d_ascender - d_descender) * y_scale; }
223 
236  float getBaseline(float y_scale = 1.0f) const
237  { return d_ascender * y_scale; }
238 
270  float getTextExtent(const String& text, float x_scale = 1.0f) const;
271 
300  float getTextAdvance(const String& text, float x_scale = 1.0f) const;
301 
325  size_t getCharAtPixel(const String& text, float pixel,
326  float x_scale = 1.0f) const
327  { return getCharAtPixel(text, 0, pixel, x_scale); }
328 
357  size_t getCharAtPixel(const String& text, size_t start_char, float pixel,
358  float x_scale = 1.0f) const;
359 
370  static void setDefaultResourceGroup(const String& resourceGroup)
371  { d_defaultResourceGroup = resourceGroup; }
372 
382  { return d_defaultResourceGroup; }
383 
394  void writeXMLToStream(XMLSerializer& xml_stream) const;
395 
408  const FontGlyph* getGlyphData(utf32 codepoint) const;
409 
410 protected:
412  Font(const String& name, const String& type_name, const String& filename,
413  const String& resource_group, const AutoScaledMode auto_scaled,
414  const Sizef& native_res);
415 
430  virtual void rasterise(utf32 start_codepoint, utf32 end_codepoint) const;
431 
433  virtual void updateFont() = 0;
434 
436  virtual void writeXMLToStream_impl(XMLSerializer& xml_stream) const = 0;
437 
439  void addFontProperties();
440 
442  virtual void onRenderSizeChanged(FontEventArgs& args);
443 
449  void setMaxCodepoint(utf32 codepoint);
450 
452  virtual const FontGlyph* findFontGlyph(const utf32 codepoint) const;
453 
455  String d_name;
457  String d_type;
459  String d_filename;
461  String d_resourceGroup;
463  static String d_defaultResourceGroup;
464 
466  float d_ascender;
468  float d_descender;
470  float d_height;
471 
473  AutoScaledMode d_autoScaled;
475  Sizef d_nativeResolution;
477  float d_horzScaling;
479  float d_vertScaling;
480 
482  utf32 d_maxCodepoint;
483 
497  uint* d_glyphPageLoaded;
498 
500  typedef std::map<utf32, FontGlyph, std::less<utf32>
501  CEGUI_MAP_ALLOC(utf32, FontGlyph)> CodepointMap;
503  mutable CodepointMap d_cp_map;
504 };
505 
506 
507 
508 } // End of CEGUI namespace section
509 
510 #if defined(_MSC_VER)
511 # pragma warning(pop)
512 #endif
513 
514 
515 #endif // end of guard _CEGUIFont_h_
Main namespace for Crazy Eddie&#39;s GUI Library.
Definition: cegui/include/CEGUI/Affector.h:42
EventArgs based class that is used for notifications regarding Font objects.
Definition: cegui/include/CEGUI/InputEvent.h:380
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: cegui/include/CEGUI/GeometryBuffer.h:42
uint32 argb_t
32 bit ARGB representation of a colour.
Definition: cegui/include/CEGUI/Colour.h:38
Class that holds details of colours for the four corners of a rectangle.
Definition: cegui/include/CEGUI/ColourRect.h:43
AutoScaledMode
Definition: cegui/include/CEGUI/Image.h:39
float getFontHeight(float y_scale=1.0f) const
return the exact pixel height of the font.
Definition: debian/tmp/usr/include/cegui-0.8.7/CEGUI/Font.h:221
internal class representing a single font glyph.
Definition: cegui/include/CEGUI/FontGlyph.h:42
static void setDefaultResourceGroup(const String &resourceGroup)
Sets the default resource group to be used when loading font data.
Definition: debian/tmp/usr/include/cegui-0.8.7/CEGUI/Font.h:370
Class that encapsulates a typeface.
Definition: cegui/include/CEGUI/Font.h:58
float getBaseline(float y_scale=1.0f) const
Return the number of pixels from the top of the highest glyph to the baseline.
Definition: debian/tmp/usr/include/cegui-0.8.7/CEGUI/Font.h:236
static const String & getDefaultResourceGroup()
Returns the default resource group currently set for Fonts.
Definition: debian/tmp/usr/include/cegui-0.8.7/CEGUI/Font.h:381
size_t getCharAtPixel(const String &text, float pixel, float x_scale=1.0f) const
Return the index of the closest text character in String text that corresponds to pixel location pixe...
Definition: debian/tmp/usr/include/cegui-0.8.7/CEGUI/Font.h:325
std::map< utf32, FontGlyph, std::less< utf32 > CEGUI_MAP_ALLOC(utf32, FontGlyph)> CodepointMap
Definition of CodepointMap type.
Definition: debian/tmp/usr/include/cegui-0.8.7/CEGUI/Font.h:501
Class used to create XML Document.
Definition: cegui/include/CEGUI/XMLSerializer.h:85
String class used within the GUI system.
Definition: cegui/include/CEGUI/String.h:62
float getLineSpacing(float y_scale=1.0f) const
Return the pixel line spacing value for.
Definition: debian/tmp/usr/include/cegui-0.8.7/CEGUI/Font.h:206
bool isCodepointAvailable(utf32 cp) const
Return whether this Font can draw the specified code-point.
Definition: debian/tmp/usr/include/cegui-0.8.7/CEGUI/Font.h:99