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
|
<!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: CastleCameras</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 CastleCameras</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>
Cameras to navigate in 3D space (<a class="normal" href="CastleCameras.TExamineCamera.html">TExamineCamera</a>, <a class="normal" href="CastleCameras.TWalkCamera.html">TWalkCamera</a>, <a class="normal" href="CastleCameras.TUniversalCamera.html">TUniversalCamera</a>).</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li>SysUtils</li><li><a href="CastleVectors.html">CastleVectors</a></li><li><a href="CastleUtils.html">CastleUtils</a></li><li><a href="CastleKeysMouse.html">CastleKeysMouse</a></li><li><a href="CastleBoxes.html">CastleBoxes</a></li><li><a href="CastleQuaternions.html">CastleQuaternions</a></li><li><a href="CastleFrustum.html">CastleFrustum</a></li><li><a href="CastleUIControls.html">CastleUIControls</a></li><li>Classes</li><li><a href="CastleRays.html">CastleRays</a></li><li><a href="CastleTimeUtils.html">CastleTimeUtils</a></li><li><a href="CastleInputs.html">CastleInputs</a></li><li><a href="CastleTriangles.html">CastleTriangles</a></li><li><a href="CastleRectangles.html">CastleRectangles</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 <a class="bold" href="CastleCameras.TCamera.html"><code>TCamera</code></a></td>
<td class="itemdesc">Handle user navigation in 3D scene.</td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleCameras.TExamineCamera.html"><code>TExamineCamera</code></a></td>
<td class="itemdesc">Navigate the 3D model in examine mode, like you would hold a box with the model inside.</td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleCameras.TWalkCamera.html"><code>TWalkCamera</code></a></td>
<td class="itemdesc">Navigation by walking (first-person-shooter-like moving) in 3D scene.</td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleCameras.TUniversalCamera.html"><code>TUniversalCamera</code></a></td>
<td class="itemdesc">Camera that allows any kind of navigation (Examine, Walk).</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>procedure <b><a href="CastleCameras.html#CorrectPreferredHeight">CorrectPreferredHeight</a></b>(var PreferredHeight: Single; const Radius: Single; const CrouchHeight, HeadBobbing: Single);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleCameras.html#CamDirUp2Orient">CamDirUp2Orient</a></b>(const CamDir, CamUp: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): <a href="CastleVectors.html#TVector4Single">TVector4Single</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleCameras.html#CamDirUp2Orient">CamDirUp2Orient</a></b>(const CamDir, CamUp: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out OrientAxis: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out OrientRadAngle: Single);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleCameras.html#CamDirUp2OrientQuat">CamDirUp2OrientQuat</a></b>(CamDir, CamUp: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): <a href="CastleQuaternions.TQuaternion.html">TQuaternion</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleCameras.html#CameraViewpointForWholeScene">CameraViewpointForWholeScene</a></b>(const Box: <a href="CastleBoxes.TBox3D.html">TBox3D</a>; const WantedDirection, WantedUp: Integer; const WantedDirectionPositive, WantedUpPositive: boolean; out Position, Direction, Up, GravityUp: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="CastleCameras.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="CastleCameras.html#TCameraInput">TCameraInput</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleCameras.html#TCameraInputs">TCameraInputs</a></b> = set of <a href="CastleCameras.html#TCameraInput">TCameraInput</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleCameras.html#TNavigationClass">TNavigationClass</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleCameras.html#TNavigationType">TNavigationType</a></b> = (...);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleCameras.html#TCameraClass">TCameraClass</a></b> = class of <a href="CastleCameras.TCamera.html">TCamera</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleCameras.html#T3BoolInputs">T3BoolInputs</a></b> = array [0..2, boolean] of <a href="CastleInputs.TInputShortcut.html">TInputShortcut</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleCameras.html#TMouseDragMode">TMouseDragMode</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleCameras.html#TMoveAllowedFunc">TMoveAllowedFunc</a></b> = function(Camera: <a href="CastleCameras.TWalkCamera.html">TWalkCamera</a>; const ProposedNewPos: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out NewPos: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; const BecauseOfGravity: boolean): boolean of object;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleCameras.html#TFallNotifyFunc">TFallNotifyFunc</a></b> = procedure (Camera: <a href="CastleCameras.TWalkCamera.html">TWalkCamera</a>; const FallHeight: Single) of object;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleCameras.html#THeightEvent">THeightEvent</a></b> = function (Camera: <a href="CastleCameras.TWalkCamera.html">TWalkCamera</a>; const Position: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out AboveHeight: Single; out AboveGround: <a href="CastleTriangles.html#P3DTriangle">P3DTriangle</a>): boolean of object;</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="CastleCameras.html#DefaultCameraDirection">DefaultCameraDirection</a></b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a> = (0, 0, -1);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleCameras.html#DefaultCameraUp">DefaultCameraUp</a></b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a> = (0, 1, 0);</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="CorrectPreferredHeight"></a><code>procedure <b>CorrectPreferredHeight</b>(var PreferredHeight: Single; const Radius: Single; const CrouchHeight, HeadBobbing: Single);</code></td>
</tr>
<tr><td colspan="1">
<p>
See <a class="normal" href="CastleCameras.TWalkCamera.html#CorrectPreferredHeight">TWalkCamera.CorrectPreferredHeight</a>. This is a global version, sometimes may be useful.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="CamDirUp2Orient"></a><code>function <b>CamDirUp2Orient</b>(const CamDir, CamUp: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): <a href="CastleVectors.html#TVector4Single">TVector4Single</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Convert camera direction and up vectors into VRML/X3D "orientation" vector.
<p>Orientation expresses CamDir and CamUp as 4-item vector (SFRotation). First three items are the Axis (normalized) and the 4th is the Angle (in radians). Meaning: if you rotate the standard direction and up (see <a class="normal" href="CastleCameras.html#DefaultCameraDirection">DefaultCameraDirection</a>, <a class="normal" href="CastleCameras.html#DefaultCameraUp">DefaultCameraUp</a>) around Axis by the Angle, then you get CamDir and CamUp.
<p>Given here CamDir and CamUp must be orthogonal and non-zero. Their lengths are not relevant (that is, you don't need to normalize them before passing here).
<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="CamDirUp2Orient"></a><code>procedure <b>CamDirUp2Orient</b>(const CamDir, CamUp: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out OrientAxis: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out OrientRadAngle: Single);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="CamDirUp2OrientQuat"></a><code>function <b>CamDirUp2OrientQuat</b>(CamDir, CamUp: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): <a href="CastleQuaternions.TQuaternion.html">TQuaternion</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Convert camera direction and up vectors into "rotation quaternion" of VRML/X3D "orientation".
<p>VRML orientation expresses camera direction and up as a rotation. This means that you should rotate the standard direction and up (see <a class="normal" href="CastleCameras.html#DefaultCameraDirection">DefaultCameraDirection</a>, <a class="normal" href="CastleCameras.html#DefaultCameraUp">DefaultCameraUp</a>) by this rotation to get CamDir and CamUp.
<p>Given here CamDir and CamUp must be orthogonal and non-zero. Their lengths are not relevant (that is, you don't need to normalize them before passing here).
<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="CameraViewpointForWholeScene"></a><code>procedure <b>CameraViewpointForWholeScene</b>(const Box: <a href="CastleBoxes.TBox3D.html">TBox3D</a>; const WantedDirection, WantedUp: Integer; const WantedDirectionPositive, WantedUpPositive: boolean; out Position, Direction, Up, GravityUp: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>);</code></td>
</tr>
<tr><td colspan="1">
<p>
Calculate sensible camera configuration to see the whole Box.
<p>WantedDirection and WantedUp indicate desired look direction/up axis (0, 1 or 2 for X, Y or Z). WantedDirectionPositive and WantedUpPositive indicate if we want the positive axis. Obviously look direction and up cannot be parallel, so WantedDirection must be different than WantedUp.
<p>Returned Direction, Up, GravityUp are normalized.</p>
</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">
</td></tr>
</table>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCameraInput"></a><code><b>TCameraInput</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
Possible navigation input types in cameras, set in <a class="normal" href="CastleCameras.TCamera.html#Input">TCamera.Input</a>.</p>
<h6 class="description_section">Values</h6>
<ul>
<li>
ciNormal: Normal input types. This includes all inputs available as Input_Xxx properties in <a class="normal" href="CastleCameras.TCamera.html">TCamera</a> descendants. They are all fully configurable (as <a class="normal" href="CastleInputs.TInputShortcut.html">TInputShortcut</a> class), they may be mouse button presses, mouse wheel clicks, or key presses. You can always clear some shortcut (like <code>WalkCamera.Input_Forward.MakeClear</code>) to disable a specific shortcut. Excluding ciNormal from <a class="normal" href="CastleCameras.TCamera.html#Input">TCamera.Input</a> is an easy way to disable <i>all</i> shortcuts.</li>
<li>
ciMouseDragging: Mouse and touch dragging. Both <a class="normal" href="CastleCameras.TExamineCamera.html">TExamineCamera</a> and <a class="normal" href="CastleCameras.TWalkCamera.html">TWalkCamera</a> implement their own, special reactions to mouse dragging, that allows to navigate / rotate while pressing specific mouse buttons.</li>
<li>
ci3dMouse: Navigation using 3D mouse devices, like the ones from 3dconnexion.</li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCameraInputs"></a><code><b>TCameraInputs</b> = set of <a href="CastleCameras.html#TCameraInput">TCameraInput</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TNavigationClass"></a><code><b>TNavigationClass</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<h6 class="description_section">Values</h6>
<ul>
<li>
ncExamine: </li>
<li>
ncWalk: </li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TNavigationType"></a><code><b>TNavigationType</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<h6 class="description_section">Values</h6>
<ul>
<li>
ntExamine: </li>
<li>
ntTurntable: </li>
<li>
ntWalk: </li>
<li>
ntFly: </li>
<li>
ntNone: </li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCameraClass"></a><code><b>TCameraClass</b> = class of <a href="CastleCameras.TCamera.html">TCamera</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="T3BoolInputs"></a><code><b>T3BoolInputs</b> = array [0..2, boolean] of <a href="CastleInputs.TInputShortcut.html">TInputShortcut</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TMouseDragMode"></a><code><b>TMouseDragMode</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
What mouse dragging does in <a class="normal" href="CastleCameras.TWalkCamera.html">TWalkCamera</a>.</p>
<h6 class="description_section">Values</h6>
<ul>
<li>
mdWalk: Moves avatar continously in the direction of mouse drag (default for <a class="normal" href="CastleCameras.TWalkCamera.html#MouseDragMode">TWalkCamera.MouseDragMode</a>).</li>
<li>
mdRotate: Rotates the head when mouse is moved.</li>
<li>
mdNone: Ignores the dragging.</li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TMoveAllowedFunc"></a><code><b>TMoveAllowedFunc</b> = function(Camera: <a href="CastleCameras.TWalkCamera.html">TWalkCamera</a>; const ProposedNewPos: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out NewPos: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; const BecauseOfGravity: boolean): boolean of object;</code></td>
</tr>
<tr><td colspan="1">
<p>
See <a class="normal" href="CastleCameras.TWalkCamera.html#DoMoveAllowed">TWalkCamera.DoMoveAllowed</a> and <a class="normal" href="CastleCameras.TWalkCamera.html#OnMoveAllowed">TWalkCamera.OnMoveAllowed</a></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TFallNotifyFunc"></a><code><b>TFallNotifyFunc</b> = procedure (Camera: <a href="CastleCameras.TWalkCamera.html">TWalkCamera</a>; const FallHeight: Single) of object;</code></td>
</tr>
<tr><td colspan="1">
<p>
See <a class="normal" href="CastleCameras.TWalkCamera.html#OnFall">TWalkCamera.OnFall</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="THeightEvent"></a><code><b>THeightEvent</b> = function (Camera: <a href="CastleCameras.TWalkCamera.html">TWalkCamera</a>; const Position: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out AboveHeight: Single; out AboveGround: <a href="CastleTriangles.html#P3DTriangle">P3DTriangle</a>): boolean of object;</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="DefaultCameraDirection"></a><code><b>DefaultCameraDirection</b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a> = (0, 0, -1);</code></td>
</tr>
<tr><td colspan="1">
<p>
Default camera direction and up vectors, used to define the meaning of "camera orientation" for <a class="normal" href="CastleCameras.html#CamDirUp2Orient">CamDirUp2Orient</a> routines. These match VRML/X3D default camera values. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DefaultCameraUp"></a><code><b>DefaultCameraUp</b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a> = (0, 1, 0);</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:08</em>
</span>
</td></tr></table></body></html>
|
