1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/*
* FTGL - OpenGL font library
*
* Copyright (c) 2001-2004 Henry Maddocks <ftgl@opengl.geek.nz>
* Copyright (c) 2008 Sam Hocevar <sam@zoy.org>
*
* 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 OR COPYRIGHT HOLDERS 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 __FTSimpleLayoutImpl__
#define __FTSimpleLayoutImpl__
#include "FTLayoutImpl.h"
class FTFont;
class FTSimpleLayoutImpl : public FTLayoutImpl
{
friend class FTSimpleLayout;
protected:
FTSimpleLayoutImpl();
virtual ~FTSimpleLayoutImpl() {};
virtual FTBBox BBox(const char* string, const int len,
FTPoint position);
virtual FTBBox BBox(const wchar_t* string, const int len,
FTPoint position);
virtual void Render(const char *string, const int len,
FTPoint position, int renderMode);
virtual void Render(const wchar_t *string, const int len,
FTPoint position, int renderMode);
/**
* Render a string of characters and distribute extra space amongst
* the whitespace regions of the string.
*
* @param string A buffer of wchar_t characters to output.
* @param len The length of the string. If < 0 then all characters
* will be displayed until a null character is encountered.
* @param position TODO
* @param renderMode Render mode to display
* @param extraSpace The amount of extra space to distribute amongst
* the characters.
*/
virtual void RenderSpace(const char *string, const int len,
FTPoint position, int renderMode,
const float extraSpace);
/**
* Render a string of characters and distribute extra space amongst
* the whitespace regions of the string.
*
* @param string A buffer of wchar_t characters to output.
* @param len The length of the string. If < 0 then all characters
* will be displayed until a null character is encountered.
* @param position TODO
* @param renderMode Render mode to display
* @param extraSpace The amount of extra space to distribute amongst
* the characters.
*/
virtual void RenderSpace(const wchar_t *string, const int len,
FTPoint position, int renderMode,
const float extraSpace);
private:
/**
* Either render a string of characters and wrap lines
* longer than a threshold or compute the bounds
* of a string of characters when wrapped. The functionality
* of this method is exposed by the BBoxWrapped and
* RenderWrapped methods.
*
* @param buf A char string to output.
* @param len The length of the string. If < 0 then all characters
* will be displayed until a null character is encountered.
* @param position TODO
* @param renderMode Render mode to display
* @param bounds A pointer to a bounds object. If non null
* the bounds of the text when laid out
* will be stored in bounds. If null the
* text will be rendered.
*/
virtual void WrapText(const char *buf, const int len,
FTPoint position, int renderMode,
FTBBox *bounds);
/**
* Either render a string of characters and wrap lines
* longer than a threshold or compute the bounds
* of a string of characters when wrapped. The functionality
* of this method is exposed by the BBoxWrapped and
* RenderWrapped methods.
*
* @param buf A wchar_t style string to output.
* @param len The length of the string. If < 0 then all characters
* will be displayed until a null character is encountered.
* @param position TODO
* @param renderMode Render mode to display
* @param bounds A pointer to a bounds object. If non null
* the bounds of the text when laid out
* will be stored in bounds. If null the
* text will be rendered.
*/
virtual void WrapText(const wchar_t *buf, const int len,
FTPoint position, int renderMode,
FTBBox *bounds);
/**
* A helper method used by WrapText to either output the text or
* compute it's bounds.
*
* @param buf A pointer to an array of character data.
* @param len The length of the string. If < 0 then all characters
* will be displayed until a null character is encountered.
* @param position TODO
* @param renderMode Render mode to display
* @param RemainingWidth The amount of extra space left on the line.
* @param bounds A pointer to a bounds object. If non null the
* bounds will be initialized or expanded by the
* bounds of the line. If null the text will be
* rendered. If the bounds are invalid (lower > upper)
* they will be initialized. Otherwise they
* will be expanded.
*/
void OutputWrapped(const char *buf, const int len,
FTPoint position, int renderMode,
const float RemainingWidth, FTBBox *bounds);
/**
* A helper method used by WrapText to either output the text or
* compute it's bounds.
*
* @param buf A pointer to an array of character data.
* @param len The length of the string. If < 0 then all characters
* will be displayed until a null character is encountered.
* @param position TODO
* @param renderMode Render mode to display
* @param RemainingWidth The amount of extra space left on the line.
* @param bounds A pointer to a bounds object. If non null the
* bounds will be initialized or expanded by the
* bounds of the line. If null the text will be
* rendered. If the bounds are invalid (lower > upper)
* they will be initialized. Otherwise they
* will be expanded.
*/
void OutputWrapped(const wchar_t *buf, const int len,
FTPoint position, int renderMode,
const float RemainingWidth, FTBBox *bounds);
/**
* The font to use for rendering the text. The font is
* referenced by this but will not be disposed of when this
* is deleted.
*/
FTFont *currentFont;
/**
* The maximum line length for formatting text.
*/
float lineLength;
/**
* The text alignment mode used to distribute
* space within a line or rendered text.
*/
FTGL::TextAlignment alignment;
/**
* The height of each line of text expressed as
* a percentage of the font's line height.
*/
float lineSpacing;
/* Internal generic BBox() implementation */
template <typename T>
inline FTBBox BBoxI(const T* string, const int len, FTPoint position);
/* Internal generic Render() implementation */
template <typename T>
inline void RenderI(const T* string, const int len,
FTPoint position, int renderMode);
/* Internal generic RenderSpace() implementation */
template <typename T>
inline void RenderSpaceI(const T* string, const int len,
FTPoint position, int renderMode,
const float extraSpace);
/* Internal generic WrapText() implementation */
template <typename T>
void WrapTextI(const T* buf, const int len, FTPoint position,
int renderMode, FTBBox *bounds);
/* Internal generic OutputWrapped() implementation */
template <typename T>
void OutputWrappedI(const T* buf, const int len, FTPoint position,
int renderMode, const float RemainingWidth,
FTBBox *bounds);
};
#endif // __FTSimpleLayoutImpl__
|
