File: X3DNodes.TAbstractViewpointNode.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 (284 lines) | stat: -rw-r--r-- 17,978 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
<!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: X3DNodes: Class TAbstractViewpointNode</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">
<a name="TAbstractViewpointNode"></a><h1 class="cio">Class TAbstractViewpointNode</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a  href="X3DNodes.html">X3DNodes</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TAbstractViewpointNode = class(<a class="normal" href="X3DNodes.TAbstractBindableNode.html">TAbstractBindableNode</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Common ancestor for both VRML 1.0 camera nodes and VRML/X3D &gt;= 2.0 viewpoint nodes.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TPersistent</li>
<li class="ancestor"><a class="normal" href="CastleInterfaces.TNonRefCountedInterfacedPersistent.html">TNonRefCountedInterfacedPersistent</a></li>
<li class="ancestor"><a class="normal" href="X3DFields.TX3DFileItem.html">TX3DFileItem</a></li>
<li class="ancestor"><a class="normal" href="X3DNodes.TX3DNode.html">TX3DNode</a></li>
<li class="ancestor"><a class="normal" href="X3DNodes.TAbstractNode.html">TAbstractNode</a></li>
<li class="ancestor"><a class="normal" href="X3DNodes.TAbstractChildNode.html">TAbstractChildNode</a></li>
<li class="ancestor"><a class="normal" href="X3DNodes.TAbstractBindableNode.html">TAbstractBindableNode</a></li>
<li class="thisitem">TAbstractViewpointNode</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="X3DNodes.TAbstractViewpointNode.html#CreateNode">CreateNode</a></b>; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="X3DNodes.TAbstractViewpointNode.html#TransformationChange">TransformationChange</a></b>: <a  href="X3DNodes.html#TNodeTransformationChange">TNodeTransformationChange</a>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="X3DNodes.TAbstractViewpointNode.html#Position">Position</a></b>: <a  href="X3DFields.TSFVec3f.html">TSFVec3f</a>; virtual; abstract;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <b><a  href="X3DNodes.TAbstractViewpointNode.html#ProjectionType">ProjectionType</a></b>: <a  href="CastleRays.html#TProjectionType">TProjectionType</a>; virtual; abstract;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="X3DNodes.TAbstractViewpointNode.html#GetView">GetView</a></b>(out CamPos, CamDir, CamUp, GravityUp: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="X3DNodes.TAbstractViewpointNode.html#Description">Description</a></b>: string; virtual;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractViewpointNode.html#FdOrientation">FdOrientation</a></b>: <a  href="X3DFields.TSFRotation.html">TSFRotation</a> read FFdOrientation;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractViewpointNode.html#FdDirection">FdDirection</a></b>: <a  href="X3DFields.TMFVec3f.html">TMFVec3f</a> read FFdDirection;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractViewpointNode.html#FdUp">FdUp</a></b>: <a  href="X3DFields.TMFVec3f.html">TMFVec3f</a> read FFdUp;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractViewpointNode.html#FdGravityUp">FdGravityUp</a></b>: <a  href="X3DFields.TSFVec3f.html">TSFVec3f</a> read FFdGravityUp;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractViewpointNode.html#EventCameraMatrix">EventCameraMatrix</a></b>: <a  href="X3DFields.TSFMatrix4fEvent.html">TSFMatrix4fEvent</a> read FEventCameraMatrix;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractViewpointNode.html#EventCameraInverseMatrix">EventCameraInverseMatrix</a></b>: <a  href="X3DFields.TSFMatrix4fEvent.html">TSFMatrix4fEvent</a> read FEventCameraInverseMatrix;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractViewpointNode.html#EventCameraRotationMatrix">EventCameraRotationMatrix</a></b>: <a  href="X3DFields.TSFMatrix3fEvent.html">TSFMatrix3fEvent</a> read FEventCameraRotationMatrix;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractViewpointNode.html#EventCameraRotationInverseMatrix">EventCameraRotationInverseMatrix</a></b>: <a  href="X3DFields.TSFMatrix3fEvent.html">TSFMatrix3fEvent</a> read FEventCameraRotationInverseMatrix;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractViewpointNode.html#FdCameraMatrixSendAlsoOnOffscreenRendering">FdCameraMatrixSendAlsoOnOffscreenRendering</a></b>: <a  href="X3DFields.TSFBool.html">TSFBool</a> read FFdCameraMatrixSendAlsoOnOffscreenRendering;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractViewpointNode.html#FdDescription">FdDescription</a></b>: <a  href="X3DFields.TSFString.html">TSFString</a> read FFdDescription;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="CreateNode"></a><code>procedure <b>CreateNode</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="TransformationChange"></a><code>function <b>TransformationChange</b>: <a  href="X3DNodes.html#TNodeTransformationChange">TNodeTransformationChange</a>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Position"></a><code>function <b>Position</b>: <a  href="X3DFields.TSFVec3f.html">TSFVec3f</a>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Position of the viewpoint.

<p>This is an abstract function, not a simple FdPosition, because one of the descendants (<a class="normal" href="X3DNodes.TAbstractX3DViewpointNode.html">TAbstractX3DViewpointNode</a>) doesn't have FdPosition field. For now, all non-abstract descendants (for both VRML 1.0 and VRML &gt;= 2.0) override this and expose their position field correctly.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ProjectionType"></a><code>class function <b>ProjectionType</b>: <a  href="CastleRays.html#TProjectionType">TProjectionType</a>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="GetView"></a><code>procedure <b>GetView</b>(out CamPos, CamDir, CamUp, GravityUp: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
Calculate camera vectors (position, direction, up, gravity up). Follows VRML/X3D specification:

<p></p>

<ul class="paragraph_spacing">
  <li><p>position is taken directly from FdPosition field,</p></li>
  <li><p>direction and up are (respectively) -Z and +Y rotated by <a class="normal" href="X3DNodes.TAbstractViewpointNode.html#FdOrientation">FdOrientation</a>,</p></li>
  <li><p>gravity up is +Y.</p></li>
</ul>

<p>

<p>They are all then transformed by the current viewpoint transformation (determined by parent nodes like Transform).

<p>One conclusion from the above is that the only way to change the gravity up vector (this determines in which direction viewer falls down) is to use the Transform node around the viewpoint node.

<p>Additionally, as an extension, we also look at <a class="normal" href="X3DNodes.TAbstractViewpointNode.html#FdDirection">FdDirection</a> and <a class="normal" href="X3DNodes.TAbstractViewpointNode.html#FdUp">FdUp</a> and <a class="normal" href="X3DNodes.TAbstractViewpointNode.html#FdGravityUp">FdGravityUp</a> vectors. See <a  href="http://castle-engine.sourceforge.net/x3d_extensions.php#section_ext_cameras_alt_orient">http://castle-engine.sourceforge.net/x3d_extensions.php#section_ext_cameras_alt_orient</a>

<p>Returned CamDir, CamUp, GravityUp are <i>always normalized</i>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Description"></a><code>function <b>Description</b>: string; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Description generated smart (trying to use <a class="normal" href="X3DNodes.TAbstractViewpointNode.html#FdDescription">FdDescription</a> field, falling back on other information to help user identify the node).</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="FdOrientation"></a><code>property <b>FdOrientation</b>: <a  href="X3DFields.TSFRotation.html">TSFRotation</a> read FFdOrientation;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="FdDirection"></a><code>property <b>FdDirection</b>: <a  href="X3DFields.TMFVec3f.html">TMFVec3f</a> read FFdDirection;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="FdUp"></a><code>property <b>FdUp</b>: <a  href="X3DFields.TMFVec3f.html">TMFVec3f</a> read FFdUp;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="FdGravityUp"></a><code>property <b>FdGravityUp</b>: <a  href="X3DFields.TSFVec3f.html">TSFVec3f</a> read FFdGravityUp;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="EventCameraMatrix"></a><code>property <b>EventCameraMatrix</b>: <a  href="X3DFields.TSFMatrix4fEvent.html">TSFMatrix4fEvent</a> read FEventCameraMatrix;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="EventCameraInverseMatrix"></a><code>property <b>EventCameraInverseMatrix</b>: <a  href="X3DFields.TSFMatrix4fEvent.html">TSFMatrix4fEvent</a> read FEventCameraInverseMatrix;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="EventCameraRotationMatrix"></a><code>property <b>EventCameraRotationMatrix</b>: <a  href="X3DFields.TSFMatrix3fEvent.html">TSFMatrix3fEvent</a> read FEventCameraRotationMatrix;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="EventCameraRotationInverseMatrix"></a><code>property <b>EventCameraRotationInverseMatrix</b>: <a  href="X3DFields.TSFMatrix3fEvent.html">TSFMatrix3fEvent</a> read FEventCameraRotationInverseMatrix;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="FdCameraMatrixSendAlsoOnOffscreenRendering"></a><code>property <b>FdCameraMatrixSendAlsoOnOffscreenRendering</b>: <a  href="X3DFields.TSFBool.html">TSFBool</a> read FFdCameraMatrixSendAlsoOnOffscreenRendering;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="FdDescription"></a><code>property <b>FdDescription</b>: <a  href="X3DFields.TSFString.html">TSFString</a> read FFdDescription;</code></td>
</tr>
<tr><td colspan="2">
&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:15</em>
</span>
</td></tr></table></body></html>