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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::PixmapFont Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1PixmapFont.html">PixmapFont</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::PixmapFont Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::PixmapFont" --><!-- doxytag: inherits="CEGUI::Font" -->
<p>Implementation of the <a class="el" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface.">Font</a> class interface using static Imageset's.
<a href="classCEGUI_1_1PixmapFont.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::PixmapFont:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1PixmapFont__inherit__graph.gif" border="0" usemap="#CEGUI_1_1PixmapFont_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1PixmapFont_inherit__map" id="CEGUI_1_1PixmapFont_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface." alt="" coords="27,83,125,112"/><area shape="rect" id="node4" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects." alt="" coords="5,5,147,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::PixmapFont:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1PixmapFont__coll__graph.gif" border="0" usemap="#CEGUI_1_1PixmapFont_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1PixmapFont_coll__map" id="CEGUI_1_1PixmapFont_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface." alt="" coords="27,85,125,115"/><area shape="rect" id="node4" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects." alt="" coords="5,5,147,35"/><area shape="rect" id="node6" href="classCEGUI_1_1Imageset.html" title="Offers functions to define, access, and draw, a set of image components on a single graphical surface..." alt="" coords="149,85,275,115"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1PixmapFont-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#a3a0928e620f926eb11f1a3074a5f797a">PixmapFont</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &font_name, const <a class="el" href="classCEGUI_1_1String.html">String</a> &imageset_filename, const <a class="el" href="classCEGUI_1_1String.html">String</a> &resource_group="", const bool auto_scaled=false, const float native_horz_res=640.0f, const float native_vert_res=480.0f)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for Pixmap type fonts. <a href="#a3a0928e620f926eb11f1a3074a5f797a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af35620ebe11c081e35b2af1efbb78e87"></a><!-- doxytag: member="CEGUI::PixmapFont::~PixmapFont" ref="af35620ebe11c081e35b2af1efbb78e87" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#af35620ebe11c081e35b2af1efbb78e87">~PixmapFont</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28946ec21478044c9f55e48cd90a4be1"></a><!-- doxytag: member="CEGUI::PixmapFont::defineMapping" ref="a28946ec21478044c9f55e48cd90a4be1" args="(const utf32 codepoint, const String &image_name, const float horz_advance)" -->
void </td><td class="memItemRight" valign="bottom"><b>defineMapping</b> (const utf32 codepoint, const <a class="el" href="classCEGUI_1_1String.html">String</a> &image_name, const float horz_advance)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d19f73dd036ce4e4fdcf5bae66318a0"></a><!-- doxytag: member="CEGUI::PixmapFont::getImageset" ref="a2d19f73dd036ce4e4fdcf5bae66318a0" args="() const " -->
const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#a2d19f73dd036ce4e4fdcf5bae66318a0">getImageset</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the imageset the font is using for it's glyphs. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#a8c070a13eaf01e7f8e6aa3b8d76a778d">setImageset</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &imageset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set <a class="el" href="classCEGUI_1_1Imageset.html" title="Offers functions to define, access, and draw, a set of image components on a single graphical surface...">Imageset</a> the font is using for it's glyphs. <a href="#a8c070a13eaf01e7f8e6aa3b8d76a778d"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48825e070eecdf097d14abf82e276cb7"></a><!-- doxytag: member="CEGUI::PixmapFont::reinit" ref="a48825e070eecdf097d14abf82e276cb7" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#a48825e070eecdf097d14abf82e276cb7">reinit</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the imageset. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1fe12778e09bd42469f363fd1b19126f"></a><!-- doxytag: member="CEGUI::PixmapFont::addPixmapFontProperties" ref="a1fe12778e09bd42469f363fd1b19126f" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#a1fe12778e09bd42469f363fd1b19126f">addPixmapFontProperties</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register all properties of this class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c3cc3ce8cc904cb4d44ab22c2f6a9a6"></a><!-- doxytag: member="CEGUI::PixmapFont::updateFont" ref="a1c3cc3ce8cc904cb4d44ab22c2f6a9a6" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#a1c3cc3ce8cc904cb4d44ab22c2f6a9a6">updateFont</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the font as needed, according to the current parameters. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1cb6874cf344de6d9f930d8beee7b285"></a><!-- doxytag: member="CEGUI::PixmapFont::writeXMLToStream_impl" ref="a1cb6874cf344de6d9f930d8beee7b285" args="(XMLSerializer &xml_stream) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#a1cb6874cf344de6d9f930d8beee7b285">writeXMLToStream_impl</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">implementaion version of writeXMLToStream. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee64b1673e00f0a09720b13b0b7c75a5"></a><!-- doxytag: member="CEGUI::PixmapFont::d_glyphImages" ref="aee64b1673e00f0a09720b13b0b7c75a5" args="" -->
<a class="el" href="classCEGUI_1_1Imageset.html">Imageset</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#aee64b1673e00f0a09720b13b0b7c75a5">d_glyphImages</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The imageset with the glyphs. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb2bc37bd1031e3dd8b68ad3b56572ae"></a><!-- doxytag: member="CEGUI::PixmapFont::d_origHorzScaling" ref="afb2bc37bd1031e3dd8b68ad3b56572ae" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#afb2bc37bd1031e3dd8b68ad3b56572ae">d_origHorzScaling</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current X scaling for glyph images. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2829fb6cc0c822b4701266bf9a41c2a"></a><!-- doxytag: member="CEGUI::PixmapFont::d_imagesetOwner" ref="ac2829fb6cc0c822b4701266bf9a41c2a" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PixmapFont.html#ac2829fb6cc0c822b4701266bf9a41c2a">d_imagesetOwner</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if we own the imageset <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Implementation of the <a class="el" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface.">Font</a> class interface using static Imageset's. </p>
<p>To create such a font you must create a <a class="el" href="classCEGUI_1_1Imageset.html" title="Offers functions to define, access, and draw, a set of image components on a single graphical surface...">Imageset</a> with all the glyphs, and then define individual glyphs via defineMapping. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3a0928e620f926eb11f1a3074a5f797a"></a><!-- doxytag: member="CEGUI::PixmapFont::PixmapFont" ref="a3a0928e620f926eb11f1a3074a5f797a" args="(const String &font_name, const String &imageset_filename, const String &resource_group="", const bool auto_scaled=false, const float native_horz_res=640.0f, const float native_vert_res=480.0f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::PixmapFont::PixmapFont </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>font_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>imageset_filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>resource_group</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool </td>
<td class="paramname"><em>auto_scaled</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float </td>
<td class="paramname"><em>native_horz_res</em> = <code>640.0f</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float </td>
<td class="paramname"><em>native_vert_res</em> = <code>480.0f</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor for Pixmap type fonts. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font_name</td><td>The name that the font will use within the <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> system.</td></tr>
<tr><td class="paramname">imageset_filename</td><td>The filename of an imageset to load that will be used as the source for glyph images for this font. If <em>resource_group</em> is the special value of "*", this parameter may instead refer to the name of an already loaded Imagset.</td></tr>
<tr><td class="paramname">resource_group</td><td>The resource group identifier to use when loading the imageset file specified by <em>imageset_filename</em>. If this group is set to the special value of "*", then <em>imageset_filename</em> instead will refer to the name of an existing <a class="el" href="classCEGUI_1_1Imageset.html" title="Offers functions to define, access, and draw, a set of image components on a single graphical surface...">Imageset</a>.</td></tr>
<tr><td class="paramname">auto_scaled</td><td>Specifies whether the font imagery should be automatically scaled to maintain the same physical size (which is calculated by using the native resolution setting).</td></tr>
<tr><td class="paramname">native_horz_res</td><td>The horizontal native resolution value. This is only significant when auto scaling is enabled.</td></tr>
<tr><td class="paramname">native_vert_res</td><td>The vertical native resolution value. This is only significant when auto scaling is enabled. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8c070a13eaf01e7f8e6aa3b8d76a778d"></a><!-- doxytag: member="CEGUI::PixmapFont::setImageset" ref="a8c070a13eaf01e7f8e6aa3b8d76a778d" args="(const String &imageset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PixmapFont::setImageset </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>imageset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set <a class="el" href="classCEGUI_1_1Imageset.html" title="Offers functions to define, access, and draw, a set of image components on a single graphical surface...">Imageset</a> the font is using for it's glyphs. </p>
<p>This will potentially cause an existing imageset to be unloaded (if it was created specifically by, and for, this <a class="el" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface.">Font</a>). The new <a class="el" href="classCEGUI_1_1Imageset.html" title="Offers functions to define, access, and draw, a set of image components on a single graphical surface...">Imageset</a> must already exist within the system.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">imageset</td><td>Name ofan existing image set to be used as the glyph source for this <a class="el" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface.">Font</a>.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">UnknownObjectException</a></td><td>thrown if <em>imageset</em> is not known in the system. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
