File: CastleControls.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (329 lines) | stat: -rw-r--r-- 14,297 bytes parent folder | download
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleControls</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<h1 class="unit">Unit CastleControls</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Uses">Uses</a></td><td><a class="section" href="#PasDoc-Classes">Classes, Interfaces, Objects and Records</a></td><td><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></td><td><a class="section" href="#PasDoc-Types">Types</a></td><td>Constants</td><td><a class="section" href="#PasDoc-Variables">Variables</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
Controls drawn inside OpenGL context.</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li>Classes</li><li><a  href="CastleVectors.html">CastleVectors</a></li><li><a  href="CastleUIControls.html">CastleUIControls</a></li><li><a  href="CastleFonts.html">CastleFonts</a></li><li><a  href="CastleTextureFontData.html">CastleTextureFontData</a></li><li><a  href="CastleKeysMouse.html">CastleKeysMouse</a></li><li><a  href="CastleImages.html">CastleImages</a></li><li><a  href="CastleUtils.html">CastleUtils</a></li><li><a  href="CastleGLImages.html">CastleGLImages</a></li><li><a  href="CastleRectangles.html">CastleRectangles</a></li><li><a  href="CastleColors.html">CastleColors</a></li><li><a  href="CastleProgress.html">CastleProgress</a></li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Classes"></a><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
<table class="classestable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TUIControlFont.html"><code>TUIControlFont</code></a></td>
<td class="itemdesc">Base class for all controls inside an OpenGL context using a font.</td>
</tr>
<tr class="list2">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TCastleButton.html"><code>TCastleButton</code></a></td>
<td class="itemdesc">Button inside OpenGL context.</td>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TCastlePanel.html"><code>TCastlePanel</code></a></td>
<td class="itemdesc">Panel inside OpenGL context.</td>
</tr>
<tr class="list2">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TCastleImageControl.html"><code>TCastleImageControl</code></a></td>
<td class="itemdesc">Image control inside OpenGL context.</td>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TCastleTouchControl.html"><code>TCastleTouchControl</code></a></td>
<td class="itemdesc">Control for touch interfaces.</td>
</tr>
<tr class="list2">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TCastleSimpleBackground.html"><code>TCastleSimpleBackground</code></a></td>
<td class="itemdesc">Simple background fill.</td>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TCastleDialog.html"><code>TCastleDialog</code></a></td>
<td class="itemdesc">Dialog box that can display a long text, with automatic vertical scrollbar.</td>
</tr>
<tr class="list2">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TCastleLabel.html"><code>TCastleLabel</code></a></td>
<td class="itemdesc">Label with possibly multiline text, in a box.</td>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TCastleCrosshair.html"><code>TCastleCrosshair</code></a></td>
<td class="itemdesc">&nbsp;</td>
</tr>
<tr class="list2">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TCastleProgressBar.html"><code>TCastleProgressBar</code></a></td>
<td class="itemdesc">&nbsp;</td>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleControls.TCastleTheme.html"><code>TCastleTheme</code></a></td>
<td class="itemdesc">Theme for 2D GUI controls.</td>
</tr>
</table>
<a name="PasDoc-FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>function <b><a  href="CastleControls.html#GetUIFont">GetUIFont</a></b>: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a  href="CastleControls.html#SetUIFont">SetUIFont</a></b>(const Value: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a>);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a  href="CastleControls.html#GetUIFontSmall">GetUIFontSmall</a></b>: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a  href="CastleControls.html#SetUIFontSmall">SetUIFontSmall</a></b>(const Value: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a>);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a  href="CastleControls.html#Theme">Theme</a></b>: <a  href="CastleControls.TCastleTheme.html">TCastleTheme</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a  href="CastleControls.html#Register">Register</a></b>;</code></td>
</tr>
</table>
<a name="PasDoc-Types"></a><h3 class="summary">Types</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a  href="CastleControls.html#TCastleButtonImageLayout">TCastleButtonImageLayout</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a  href="CastleControls.html#TCastleTouchCtlMode">TCastleTouchCtlMode</a></b> = (...);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a  href="CastleControls.html#TCastleTouchPosition">TCastleTouchPosition</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a  href="CastleControls.html#TThemeImage">TThemeImage</a></b> = (...);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a  href="CastleControls.html#TCastleCrosshairShape">TCastleCrosshairShape</a></b> = (...);</code></td>
</tr>
</table>
<a name="PasDoc-Variables"></a><h3 class="summary">Variables</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>property <b><a  href="CastleControls.html#UIFont">UIFont</a></b>: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a> read <a  href="CastleControls.html#GetUIFont">GetUIFont</a> write <a  href="CastleControls.html#SetUIFont">SetUIFont</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>property <b><a  href="CastleControls.html#UIFontSmall">UIFontSmall</a></b>: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a> read <a  href="CastleControls.html#GetUIFontSmall">GetUIFontSmall</a> write <a  href="CastleControls.html#SetUIFontSmall">SetUIFontSmall</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Functions and Procedures</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="GetUIFont"></a><code>function <b>GetUIFont</b>: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
The 2D fonts used throughout UI interface.

<p>They work fast. Actually, only the first &quot;create&quot; call does actual work. The font is kept until the GL context is destroyed. (We used to have reference-counting for this, but actually just keeping the resource for the rest of GL context life is 1. easier and 2. better, because we want to keep the resource even if you destroy and then recreate all your controls.)

<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="SetUIFont"></a><code>procedure <b>SetUIFont</b>(const Value: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a>);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="GetUIFontSmall"></a><code>function <b>GetUIFontSmall</b>: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a>;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="SetUIFontSmall"></a><code>procedure <b>SetUIFontSmall</b>(const Value: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a>);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="Theme"></a><code>function <b>Theme</b>: <a  href="CastleControls.TCastleTheme.html">TCastleTheme</a>;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="Register"></a><code>procedure <b>Register</b>;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCastleButtonImageLayout"></a><code><b>TCastleButtonImageLayout</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;<h6 class="description_section">Values</h6>
<ul>
<li>
ilTop: &nbsp;</li>
<li>
ilBottom: &nbsp;</li>
<li>
ilLeft: &nbsp;</li>
<li>
ilRight: &nbsp;</li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCastleTouchCtlMode"></a><code><b>TCastleTouchCtlMode</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;<h6 class="description_section">Values</h6>
<ul>
<li>
ctcmWalking: &nbsp;</li>
<li>
ctcmWalkWithSideRot: &nbsp;</li>
<li>
ctcmHeadRotation: &nbsp;</li>
<li>
ctcmFlyUpdown: &nbsp;</li>
<li>
ctcmPanXY: &nbsp;</li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCastleTouchPosition"></a><code><b>TCastleTouchPosition</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;<h6 class="description_section">Values</h6>
<ul>
<li>
tpManual: &nbsp;</li>
<li>
tpLeft: &nbsp;</li>
<li>
tpRight: &nbsp;</li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TThemeImage"></a><code><b>TThemeImage</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;<h6 class="description_section">Values</h6>
<ul>
<li>
tiPanel: &nbsp;</li>
<li>
tiPanelSeparator: &nbsp;</li>
<li>
tiProgressBar: &nbsp;</li>
<li>
tiProgressFill: &nbsp;</li>
<li>
tiButtonPressed: &nbsp;</li>
<li>
tiButtonFocused: &nbsp;</li>
<li>
tiButtonNormal: &nbsp;</li>
<li>
tiWindow: &nbsp;</li>
<li>
tiScrollbarFrame: &nbsp;</li>
<li>
tiScrollbarSlider: &nbsp;</li>
<li>
tiSlider: &nbsp;</li>
<li>
tiSliderPosition: &nbsp;</li>
<li>
tiLabel: &nbsp;</li>
<li>
tiActiveFrame: &nbsp;</li>
<li>
tiTooltip: &nbsp;</li>
<li>
tiTouchCtlInner: &nbsp;</li>
<li>
tiTouchCtlOuter: &nbsp;</li>
<li>
tiTouchCtlFlyInner: &nbsp;</li>
<li>
tiTouchCtlFlyOuter: &nbsp;</li>
<li>
tiCrosshair1: &nbsp;</li>
<li>
tiCrosshair2: &nbsp;</li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCastleCrosshairShape"></a><code><b>TCastleCrosshairShape</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;<h6 class="description_section">Values</h6>
<ul>
<li>
csCross: &nbsp;</li>
<li>
csCrossRect: &nbsp;</li>
</ul>
</td></tr>
</table>
<h3 class="detail">Variables</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="UIFont"></a><code>property <b>UIFont</b>: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a> read <a  href="CastleControls.html#GetUIFont">GetUIFont</a> write <a  href="CastleControls.html#SetUIFont">SetUIFont</a>;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="UIFontSmall"></a><code>property <b>UIFontSmall</b>: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a> read <a  href="CastleControls.html#GetUIFontSmall">GetUIFontSmall</a> write <a  href="CastleControls.html#SetUIFontSmall">SetUIFontSmall</a>;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  _paq.push(["trackPageView"]);
  _paq.push(["enableLinkTracking"]);

  (function() {
    var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
    _paq.push(["setTrackerUrl", u+"piwik.php"]);
    _paq.push(["setSiteId", "1"]);
    var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
    g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
  })();
</script>
<!-- End Piwik Code -->

<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&amp;rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:09</em>
</span>
</td></tr></table></body></html>