FIFE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
gui_font.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2013 by the FIFE team *
3  * http://www.fifengine.net *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 // Standard C++ library includes
23 
24 // 3rd party library includes
25 #include <guichan.hpp>
26 
27 // FIFE includes
28 // These includes are split up in two parts, separated by one empty line
29 // First block: files included from the FIFE root src directory
30 // Second block: files included from the same folder
31 #include "util/structures/rect.h"
32 #include "video/image.h"
33 #include "video/renderbackend.h"
34 
35 #include "gui_font.h"
36 
37 namespace FIFE {
38  GuiFont::GuiFont(IFont* font): m_font(font) {
39  assert(font);
40  }
41 
43  delete m_font;
44  }
45 
46  int32_t GuiFont::getStringIndexAt(const std::string& text, int32_t x) const {
47  return m_font->getStringIndexAt(text, x);
48  }
49 
50  void GuiFont::drawString(gcn::Graphics* graphics, const std::string& text, int32_t x, int32_t y) {
51  if (text == "") {
52  return;
53  }
54 
55  int32_t yoffset = getRowSpacing() / 2;
56 
57  const gcn::ClipRectangle& clip = graphics->getCurrentClipArea();
58  FIFE::Rect rect;
59  rect.x = x + clip.xOffset;
60  rect.y = y + clip.yOffset + yoffset;
61  rect.w = getWidth(text);
62  rect.h = getHeight();
63 
64  if (!rect.intersects(Rect(clip.x,clip.y,clip.width,clip.height)) ) {
65  return;
66  }
67 
68  Image* image = getAsImage(text);
69  image->render(rect);
70  }
71 
72  void GuiFont::drawMultiLineString(gcn::Graphics* graphics, const std::string& text, int32_t x, int32_t y) {
73  if (text == "") {
74  return;
75  }
76 
77  int32_t yoffset = getRowSpacing() / 2;
78 
79  const gcn::ClipRectangle& clip = graphics->getCurrentClipArea();
80 
81  Image* image = getAsImageMultiline(text);
82 
83  FIFE::Rect rect;
84  rect.x = x + clip.xOffset;
85  rect.y = y + clip.yOffset + yoffset;
86  rect.w = image->getWidth();
87  rect.h = image->getHeight();
88  if (!rect.intersects(Rect(clip.x,clip.y,clip.width,clip.height)) ) {
89  return;
90  }
91  image->render(rect);
92  }
93 
94  void GuiFont::setRowSpacing (int32_t spacing) {
95  m_font->setRowSpacing(spacing);
96  }
97 
98  int32_t GuiFont::getRowSpacing() const {
99  return m_font->getRowSpacing();
100  }
101 
102  void GuiFont::setGlyphSpacing(int32_t spacing) {
103  m_font->setGlyphSpacing(spacing);
104  }
105 
106  int32_t GuiFont::getGlyphSpacing() const {
107  return m_font->getGlyphSpacing();
108  }
109 
110  void GuiFont::setAntiAlias(bool antiAlias) {
111  m_font->setAntiAlias(antiAlias);
112  }
113 
115  return m_font->isAntiAlias();
116  }
117 
118  Image* GuiFont::getAsImage(const std::string& text) {
119  return m_font->getAsImage(text);
120  }
121 
122  Image* GuiFont::getAsImageMultiline(const std::string& text) {
123  return m_font->getAsImageMultiline(text);
124  }
125 
126  std::string GuiFont::splitTextToWidth (const std::string& text, int32_t render_width) {
127  return m_font->splitTextToWidth(text,render_width);
128  }
129 
131  m_font->setColor(r, g, b, a);
132  }
133 
134  SDL_Color GuiFont::getColor() const {
135  return m_font->getColor();
136  }
137 
138  int32_t GuiFont::getWidth(const std::string& text) const {
139  return m_font->getWidth(text);
140  }
141 
142  int32_t GuiFont::getHeight() const {
143  return m_font->getHeight();
144  }
145 
147  m_font->invalidate();
148  }
149 }
int32_t getWidth(const std::string &text) const
gets width of given text
Definition: gui_font.cpp:138
void invalidate()
Definition: gui_font.cpp:146
std::string splitTextToWidth(const std::string &text, int32_t render_width)
Definition: gui_font.cpp:126
SDL_Color getColor() const
Get the color the text was rendered in.
Definition: gui_font.cpp:134
void drawMultiLineString(gcn::Graphics *graphics, const std::string &text, int32_t x, int32_t y)
Definition: gui_font.cpp:72
Base Class for Images.
Definition: image.h:47
T h
Height of the rectangle.
Definition: rect.h:93
T x
The X Coordinate.
Definition: rect.h:84
virtual bool isAntiAlias()=0
Checks if anti aliasing is used.
GuiFont(IFont *font)
Constructor Takes the ownership of given font.
Definition: gui_font.cpp:38
Image * getAsImage(const std::string &text)
Gets given text as Image The rsulting image is pooled, so it&#39;s not that time critical.
Definition: gui_font.cpp:118
virtual Image * getAsImage(const std::string &text)=0
Gets given text as Image The rsulting image is pooled, so it&#39;s not that time critical.
virtual Image * getAsImageMultiline(const std::string &text)=0
Gets given text as Image.
virtual void setColor(uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)=0
Set the color the text should be rendered in.
virtual std::string splitTextToWidth(const std::string &text, int32_t render_width)=0
virtual int32_t getRowSpacing() const =0
Gets the spacing between rows in pixels.
virtual ~GuiFont()
Definition: gui_font.cpp:42
virtual void invalidate()=0
int32_t getStringIndexAt(const std::string &text, int32_t x) const
Definition: gui_font.cpp:46
virtual SDL_Color getColor() const =0
Get the color the text was rendered in.
void setRowSpacing(int32_t spacing)
Sets the spacing between rows in pixels.
Definition: gui_font.cpp:94
void drawString(gcn::Graphics *graphics, const std::string &text, int32_t x, int32_t y)
Definition: gui_font.cpp:50
Image * getAsImageMultiline(const std::string &text)
Gets given text as Image.
Definition: gui_font.cpp:122
uint32_t getHeight() const
Definition: image.cpp:155
unsigned char uint8_t
Definition: core.h:38
virtual int32_t getStringIndexAt(const std::string &text, int32_t x) const =0
IFont * m_font
Definition: gui_font.h:67
void setGlyphSpacing(int32_t spacing)
Sets the spacing between letters in pixels.
Definition: gui_font.cpp:102
virtual int32_t getHeight() const =0
gets height of this font
virtual void setGlyphSpacing(int32_t spacing)=0
Sets the spacing between letters in pixels.
int32_t getHeight() const
gets height of this font
Definition: gui_font.cpp:142
uint32_t getWidth() const
Definition: image.cpp:146
T y
The Y Coordinate.
Definition: rect.h:87
virtual int32_t getGlyphSpacing() const =0
Gets the spacing between letters in pixels.
bool intersects(const RectType< T > &rect) const
Check whether two rectangles share some area.
Definition: rect.h:227
Pure abstract Font interface.
Definition: ifont.h:43
virtual void render(const Rect &rect, uint8_t alpha=255, uint8_t const *rgb=0)=0
Renders itself to the current render target (main screen or attached destination image) at the rectan...
void setAntiAlias(bool antiAlias)
Sets the use of anti aliasing.
Definition: gui_font.cpp:110
virtual void setRowSpacing(int32_t spacing)=0
Sets the spacing between rows in pixels.
int32_t getGlyphSpacing() const
Gets the spacing between letters in pixels.
Definition: gui_font.cpp:106
bool isAntiAlias()
Checks if anti aliasing is used.
Definition: gui_font.cpp:114
virtual int32_t getWidth(const std::string &text) const =0
gets width of given text
virtual void setAntiAlias(bool antiAlias)=0
Sets the use of anti aliasing.
T w
Width of the rectangle.
Definition: rect.h:90
void setColor(uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)
Set the color the text should be rendered in.
Definition: gui_font.cpp:130
int32_t getRowSpacing() const
Gets the spacing between rows in pixels.
Definition: gui_font.cpp:98