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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
|
<!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: CastleUIControls</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 CastleUIControls</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><a class="section" href="#PasDoc-Constants">Constants</a></td><td>Variables</td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
User interface (2D) basic classes.</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li>SysUtils</li><li>Classes</li><li><a href="CastleKeysMouse.html">CastleKeysMouse</a></li><li><a href="CastleUtils.html">CastleUtils</a></li><li><a href="CastleClassUtils.html">CastleClassUtils</a></li><li><a href="CastleGenericLists.html">CastleGenericLists</a></li><li><a href="CastleRectangles.html">CastleRectangles</a></li><li><a href="CastleTimeUtils.html">CastleTimeUtils</a></li><li>pk3DConnexion</li><li><a href="CastleImages.html">CastleImages</a></li><li><a href="CastleVectors.html">CastleVectors</a></li><li>FGL</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">Object <a class="bold" href="CastleUIControls.TTouch.html"><code>TTouch</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleUIControls.TTouchList.html"><code>TTouchList</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleUIControls.TUIContainer.html"><code>TUIContainer</code></a></td>
<td class="itemdesc">Abstract user interface container.</td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleUIControls.TInputListener.html"><code>TInputListener</code></a></td>
<td class="itemdesc">Base class for things that listen to user input: cameras and 2D controls.</td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleUIControls.TUIControl.html"><code>TUIControl</code></a></td>
<td class="itemdesc">Basic user interface control class.</td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleUIControls.TUIRectangularControl.html"><code>TUIRectangularControl</code></a></td>
<td class="itemdesc"><a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a> that has a position and takes some rectangular space on the container.</td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleUIControls.TUIControlList.html"><code>TUIControlList</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleUIControls.TGLContextEventList.html"><code>TGLContextEventList</code></a></td>
<td class="itemdesc"> </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="CastleUIControls.html#OnGLContextOpen">OnGLContextOpen</a></b>: <a href="CastleUIControls.TGLContextEventList.html">TGLContextEventList</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleUIControls.html#OnGLContextClose">OnGLContextClose</a></b>: <a href="CastleUIControls.TGLContextEventList.html">TGLContextEventList</a>;</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="CastleUIControls.html#TRenderStyle">TRenderStyle</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#TContainerEvent">TContainerEvent</a></b> = procedure (Container: <a href="CastleUIControls.TUIContainer.html">TUIContainer</a>);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#TContainerObjectEvent">TContainerObjectEvent</a></b> = procedure (Container: <a href="CastleUIControls.TUIContainer.html">TUIContainer</a>) of object;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#TInputPressReleaseEvent">TInputPressReleaseEvent</a></b> = procedure (Container: <a href="CastleUIControls.TUIContainer.html">TUIContainer</a>; const Event: <a href="CastleKeysMouse.TInputPressRelease.html">TInputPressRelease</a>);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#TInputMotionEvent">TInputMotionEvent</a></b> = procedure (Container: <a href="CastleUIControls.TUIContainer.html">TUIContainer</a>; const Event: <a href="CastleKeysMouse.TInputMotion.html">TInputMotion</a>);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#PTouch">PTouch</a></b> = ˆ<a href="CastleUIControls.TTouch.html">TTouch</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#TPositionRelative">TPositionRelative</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#TUIControlPos">TUIControlPos</a></b> = <a href="CastleUIControls.TUIRectangularControl.html">TUIRectangularControl</a> deprecated;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#TGLContextEvent">TGLContextEvent</a></b> = procedure;</code></td>
</tr>
</table>
<a name="PasDoc-Constants"></a><h3 class="summary">Constants</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#DefaultDpi">DefaultDpi</a></b> = 96;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#DefaultTooltipDelay">DefaultTooltipDelay</a></b> = 1000;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#DefaultTooltipDistance">DefaultTooltipDistance</a></b> = 10;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#ds2D">ds2D</a></b> = rs2D deprecated;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#ds3D">ds3D</a></b> = rs3D deprecated;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#prLeft">prLeft</a></b> = prLow deprecated;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#prRight">prRight</a></b> = prHigh deprecated;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#prBottom">prBottom</a></b> = prLow deprecated;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#prTop">prTop</a></b> = prHigh deprecated;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#hpLeft">hpLeft</a></b> = CastleRectangles.hpLeft ;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#hpMiddle">hpMiddle</a></b> = CastleRectangles.hpMiddle;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#hpRight">hpRight</a></b> = CastleRectangles.hpRight ;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#vpBottom">vpBottom</a></b> = CastleRectangles.vpBottom;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleUIControls.html#vpMiddle">vpMiddle</a></b> = CastleRectangles.vpMiddle;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleUIControls.html#vpTop">vpTop</a></b> = CastleRectangles.vpTop ;</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="OnGLContextOpen"></a><code>function <b>OnGLContextOpen</b>: <a href="CastleUIControls.TGLContextEventList.html">TGLContextEventList</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Global callbacks called when OpenGL context (like Lazarus <a class="normal" href="CastleControl.TCastleControl.html">TCastleControl</a> or <a class="normal" href="CastleWindow.TCastleWindow.html">TCastleWindow</a>) is open/closed. Useful for things that want to be notified about OpenGL context existence, but cannot refer to a particular instance of <a class="normal" href="CastleControl.TCastleControl.html">TCastleControl</a> or <a class="normal" href="CastleWindow.TCastleWindow.html">TCastleWindow</a>.
<p>Note that we may have many OpenGL contexts (<a class="normal" href="CastleWindow.TCastleWindow.html">TCastleWindow</a> or <a class="normal" href="CastleControl.TCastleControl.html">TCastleControl</a>) open simultaneously. They all share OpenGL resources. <code>OnGLContextOpen</code> is called when first OpenGL context is open, that is: no previous context was open. <a class="normal" href="CastleUIControls.html#OnGLContextClose">OnGLContextClose</a> is called when last OpenGL context is closed, that is: no more contexts remain open. Note that this implies that they may be called many times: e.g. if you open one window, then close it, then open another window then close it.
<p>Callbacks on <code>OnGLContextOpen</code> are called from first to last. Callbacks on <a class="normal" href="CastleUIControls.html#OnGLContextClose">OnGLContextClose</a> are called in reverse order, so <a class="normal" href="CastleUIControls.html#OnGLContextClose">OnGLContextClose</a>[0] is called last.
<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="OnGLContextClose"></a><code>function <b>OnGLContextClose</b>: <a href="CastleUIControls.TGLContextEventList.html">TGLContextEventList</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TRenderStyle"></a><code><b>TRenderStyle</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
Determines the order in which <a class="normal" href="CastleUIControls.TUIControl.html#Render">TUIControl.Render</a> is called. All 3D controls are always under all 2D controls. See <a class="normal" href="CastleUIControls.TUIControl.html#Render">TUIControl.Render</a>, <a class="normal" href="CastleUIControls.TUIControl.html#RenderStyle">TUIControl.RenderStyle</a>.</p>
<h6 class="description_section">Values</h6>
<ul>
<li>
rs2D: </li>
<li>
rs3D: </li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TContainerEvent"></a><code><b>TContainerEvent</b> = procedure (Container: <a href="CastleUIControls.TUIContainer.html">TUIContainer</a>);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TContainerObjectEvent"></a><code><b>TContainerObjectEvent</b> = procedure (Container: <a href="CastleUIControls.TUIContainer.html">TUIContainer</a>) of object;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TInputPressReleaseEvent"></a><code><b>TInputPressReleaseEvent</b> = procedure (Container: <a href="CastleUIControls.TUIContainer.html">TUIContainer</a>; const Event: <a href="CastleKeysMouse.TInputPressRelease.html">TInputPressRelease</a>);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TInputMotionEvent"></a><code><b>TInputMotionEvent</b> = procedure (Container: <a href="CastleUIControls.TUIContainer.html">TUIContainer</a>; const Event: <a href="CastleKeysMouse.TInputMotion.html">TInputMotion</a>);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="PTouch"></a><code><b>PTouch</b> = ˆ<a href="CastleUIControls.TTouch.html">TTouch</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TPositionRelative"></a><code><b>TPositionRelative</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Position for relative layout of one control in respect to another. Deprecated, rather use cleaner <a class="normal" href="CastleRectangles.html#THorizontalPosition">THorizontalPosition</a> and <a class="normal" href="CastleRectangles.html#TVerticalPosition">TVerticalPosition</a>.</p>
<h6 class="description_section">Values</h6>
<ul>
<li>
prLow: </li>
<li>
prMiddle: </li>
<li>
prHigh: </li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TUIControlPos"></a><code><b>TUIControlPos</b> = <a href="CastleUIControls.TUIRectangularControl.html">TUIRectangularControl</a> deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p> </td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TGLContextEvent"></a><code><b>TGLContextEvent</b> = procedure;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<h3 class="detail">Constants</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DefaultDpi"></a><code><b>DefaultDpi</b> = 96;</code></td>
</tr>
<tr><td colspan="1">
<p>
Default value for container's Dpi, as is usually set on desktops.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DefaultTooltipDelay"></a><code><b>DefaultTooltipDelay</b> = 1000;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DefaultTooltipDistance"></a><code><b>DefaultTooltipDistance</b> = 10;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="ds2D"></a><code><b>ds2D</b> = rs2D deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Deprecated name for rs2D.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="ds3D"></a><code><b>ds3D</b> = rs3D deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Deprecated name for rs3D.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="prLeft"></a><code><b>prLeft</b> = prLow deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p> </td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="prRight"></a><code><b>prRight</b> = prHigh deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p> </td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="prBottom"></a><code><b>prBottom</b> = prLow deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p> </td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="prTop"></a><code><b>prTop</b> = prHigh deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p> </td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="hpLeft"></a><code><b>hpLeft</b> = CastleRectangles.hpLeft ;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="hpMiddle"></a><code><b>hpMiddle</b> = CastleRectangles.hpMiddle;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="hpRight"></a><code><b>hpRight</b> = CastleRectangles.hpRight ;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="vpBottom"></a><code><b>vpBottom</b> = CastleRectangles.vpBottom;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="vpMiddle"></a><code><b>vpMiddle</b> = CastleRectangles.vpMiddle;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="vpTop"></a><code><b>vpTop</b> = CastleRectangles.vpTop ;</code></td>
</tr>
<tr><td colspan="1">
</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&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:12</em>
</span>
</td></tr></table></body></html>
|
