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
|
<!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::FontGlyph 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_1FontGlyph.html">FontGlyph</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::FontGlyph Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FontGlyph" -->
<p>internal class representing a single font glyph.
<a href="classCEGUI_1_1FontGlyph.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"/> Collaboration diagram for CEGUI::FontGlyph:</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_1FontGlyph__coll__graph.gif" border="0" usemap="#CEGUI_1_1FontGlyph_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FontGlyph_coll__map" id="CEGUI_1_1FontGlyph_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset." alt="" coords="69,101,179,131"/><area shape="rect" id="node4" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle." alt="" coords="5,5,107,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="131,5,256,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FontGlyph-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"><a class="anchor" id="a23e45018a65f57db1d694cac868ca6dd"></a><!-- doxytag: member="CEGUI::FontGlyph::FontGlyph" ref="a23e45018a65f57db1d694cac868ca6dd" args="(float advance=0.0f, const Image *image=0)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FontGlyph.html#a23e45018a65f57db1d694cac868ca6dd">FontGlyph</a> (float advance=0.0f, const Image *image=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29322b4203d0c866e3fd449449e589d9"></a><!-- doxytag: member="CEGUI::FontGlyph::getImage" ref="a29322b4203d0c866e3fd449449e589d9" args="() const " -->
const <a class="el" href="classCEGUI_1_1Image.html">Image</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FontGlyph.html#a29322b4203d0c866e3fd449449e589d9">getImage</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <a class="el" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">CEGUI::Image</a> object rendered for this glyph. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae24b150aa627a9c65fb074fef128cb99"></a><!-- doxytag: member="CEGUI::FontGlyph::getImageset" ref="ae24b150aa627a9c65fb074fef128cb99" args="() const " -->
const <a class="el" href="classCEGUI_1_1Imageset.html">Imageset</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FontGlyph.html#ae24b150aa627a9c65fb074fef128cb99">getImageset</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the parent <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...">CEGUI::Imageset</a> object for this glyph. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a88334aee41291b2e6e4d73d97a9345"></a><!-- doxytag: member="CEGUI::FontGlyph::getSize" ref="a3a88334aee41291b2e6e4d73d97a9345" args="(float x_scale, float y_scale) const " -->
<a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FontGlyph.html#a3a88334aee41291b2e6e4d73d97a9345">getSize</a> (float x_scale, float y_scale) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the scaled pixel size of the glyph. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c2d633fa14a547318337e2c537af549"></a><!-- doxytag: member="CEGUI::FontGlyph::getWidth" ref="a0c2d633fa14a547318337e2c537af549" args="(float x_scale) const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FontGlyph.html#a0c2d633fa14a547318337e2c537af549">getWidth</a> (float x_scale) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the scaled width of the glyph. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55fe907a36cf7bf3e8292469fb5b641a"></a><!-- doxytag: member="CEGUI::FontGlyph::getHeight" ref="a55fe907a36cf7bf3e8292469fb5b641a" args="(float y_scale) const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FontGlyph.html#a55fe907a36cf7bf3e8292469fb5b641a">getHeight</a> (float y_scale) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the scaled height of the glyph. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FontGlyph.html#aeda3401a037d384222b391ae3756ca98">getRenderedAdvance</a> (float x_scale) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the rendered advance value for this glyph. <a href="#aeda3401a037d384222b391ae3756ca98"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FontGlyph.html#a8b94b0a2687be573460b7d802e4c2565">getAdvance</a> (float x_scale=1.0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the horizontal advance value for the glyph. <a href="#a8b94b0a2687be573460b7d802e4c2565"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa26044fd0c541b3e58174b6cf84f314a"></a><!-- doxytag: member="CEGUI::FontGlyph::setAdvance" ref="aa26044fd0c541b3e58174b6cf84f314a" args="(float advance)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FontGlyph.html#aa26044fd0c541b3e58174b6cf84f314a">setAdvance</a> (float advance)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the horizontal advance value for the glyph. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a131491fdc803d7191a64df70db1823b0"></a><!-- doxytag: member="CEGUI::FontGlyph::setImage" ref="a131491fdc803d7191a64df70db1823b0" args="(const Image *image)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FontGlyph.html#a131491fdc803d7191a64df70db1823b0">setImage</a> (const <a class="el" href="classCEGUI_1_1Image.html">Image</a> *image)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">CEGUI::Image</a> object rendered for this glyph. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>internal class representing a single font glyph. </p>
<p>For TrueType fonts initially all FontGlyph's are empty (<a class="el" href="classCEGUI_1_1FontGlyph.html#a29322b4203d0c866e3fd449449e589d9" title="Return the CEGUI::Image object rendered for this glyph.">getImage()</a> will return 0), but they are filled by demand. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8b94b0a2687be573460b7d802e4c2565"></a><!-- doxytag: member="CEGUI::FontGlyph::getAdvance" ref="a8b94b0a2687be573460b7d802e4c2565" args="(float x_scale=1.0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::FontGlyph::getAdvance </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>x_scale</em> = <code>1.0</code></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the horizontal advance value for the glyph. </p>
<p>The returned value is the number of pixels the pen should move horizontally to position itself ready to render the next glyph. This is not always the same as the glyph image width or rendererd advance, since it allows for horizontal overhangs. </p>
</div>
</div>
<a class="anchor" id="aeda3401a037d384222b391ae3756ca98"></a><!-- doxytag: member="CEGUI::FontGlyph::getRenderedAdvance" ref="aeda3401a037d384222b391ae3756ca98" args="(float x_scale) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::FontGlyph::getRenderedAdvance </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>x_scale</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the rendered advance value for this glyph. </p>
<p>The rendered advance value is the total number of pixels from the current pen position that will be occupied by this glyph when rendered. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 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>
|
