Mercurial > fife-parpg

comparison engine/core/video/fonts/abstractfont.h @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children 90005975cdbb
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE team *
3 * http://www.fifengine.de *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program 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 *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_ABSTRACT_FONT_H
23 #define FIFE_ABSTRACT_FONT_H
24
25 // Standard C++ library includes
26 #include <string>
27
28 // Platform specific includes
29
30 // 3rd party library includes
31 #include <SDL.h>
32
33 // FIFE includes
34 // These includes are split up in two parts, separated by one empty line
35 // First block: files included from the FIFE root src directory
36 // Second block: files included from the same folder
37
38 namespace FIFE {
39 class Image;
40
41 /** Pure abstract Font interface
42 */
43 class AbstractFont {
44 public:
45 virtual ~AbstractFont() {}
46
47 /**
48 * Sets the spacing between rows in pixels. Default is 0 pixels.
49 * The spacing can be negative.
50 *
51 * @param spacing the spacing in pixels.
52 */
53 virtual void setRowSpacing (int spacing) = 0;
54
55 /**
56 * Gets the spacing between rows in pixels.
57 *
58 * @return the spacing.
59 */
60 virtual int getRowSpacing() const = 0;
61
62 /**
63 * Sets the spacing between letters in pixels. Default is 0 pixels.
64 * The spacing can be negative.
65 *
66 * @param spacing the spacing in pixels.
67 */
68 virtual void setGlyphSpacing(int spacing) = 0;
69
70 /**
71 * Gets the spacing between letters in pixels.
72 *
73 * @return the spacing.
74 */
75 virtual int getGlyphSpacing() const = 0;
76
77 /**
78 * Sets the use of anti aliasing..
79 *
80 * @param antaAlias true for use of antia aliasing.
81 */
82 virtual void setAntiAlias(bool antiAlias) = 0;
83
84 /**
85 * Checks if anti aliasing is used.
86 *
87 * @return true if anti aliasing is used.
88 */
89 virtual bool isAntiAlias() = 0;
90
91 virtual int getStringIndexAt(const std::string &text, int x) = 0;
92
93 /** Gets given text as Image
94 * The rsulting image is pooled, so it's not that time critical
95 */
96 virtual Image* getAsImage(const std::string& text) = 0;
97
98 /** Gets given text as Image. Text is splitted on multiple lines based "\n" marks
99 * The rsulting image is pooled, so it's not that time critical
100 */
101 virtual Image* getAsImageMultiline(const std::string& text) = 0;
102
103 virtual std::string splitTextToWidth (const std::string& text, int render_width) = 0;
104
105 /** Set the color the text should be rendered in
106 */
107 virtual void setColor(uint8_t r,uint8_t g,uint8_t b) = 0;
108
109 /** Get the color the text was rendered in
110 */
111 virtual SDL_Color getColor() const = 0;
112
113 /** gets width of given text
114 */
115 virtual int getWidth(const std::string& text) const = 0;
116
117 /** gets height of this font
118 */
119 virtual int getHeight() const = 0;
120 };
121 }
122
123 #endif