File: X3DCameraUtils.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 (184 lines) | stat: -rw-r--r-- 12,369 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
 
<!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: X3DCameraUtils</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 X3DCameraUtils</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>Classes, Interfaces, Objects and Records</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>
Utilities specifically for VRML/X3D cameras. </p>
<h6 class="description_section">See also</h6>
<dl class="see_also">
  <dt><a class="normal" href="CastleCameras.html">For our general classes and utilities
    for camera handling.</a></dt>
  <dd>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>).</dd>
</dl>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li><a  href="CastleUtils.html">CastleUtils</a></li><li><a  href="CastleVectors.html">CastleVectors</a></li><li><a  href="CastleBoxes.html">CastleBoxes</a></li><li><a  href="X3DNodes.html">X3DNodes</a></li></ul><h2 class="overview">Overview</h2>
<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="X3DCameraUtils.html#MakeCameraStr">MakeCameraStr</a></b>(const Version: <a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>; const Xml: boolean; const Position, Direction, Up, GravityUp: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>): string;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a  href="X3DCameraUtils.html#MakeCameraNode">MakeCameraNode</a></b>(const Version: <a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>; const BaseUrl: string; const Position, Direction, Up, GravityUp: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>): <a  href="X3DNodes.TX3DNode.html">TX3DNode</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a  href="X3DCameraUtils.html#MakeCameraNode">MakeCameraNode</a></b>(const Version: <a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>; const BaseUrl: string; const Position, Direction, Up, GravityUp: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>; out ViewpointNode: <a  href="X3DNodes.TAbstractViewpointNode.html">TAbstractViewpointNode</a>): <a  href="X3DNodes.TX3DNode.html">TX3DNode</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a  href="X3DCameraUtils.html#CameraNodeForWholeScene">CameraNodeForWholeScene</a></b>(const Version: <a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>; const BaseUrl: string; const Box: <a  href="CastleBoxes.TBox3D.html">TBox3D</a>; const WantedDirection, WantedUp: Integer; const WantedDirectionPositive, WantedUpPositive: boolean): <a  href="X3DNodes.TX3DNode.html">TX3DNode</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a  href="X3DCameraUtils.html#MakeCameraNavNode">MakeCameraNavNode</a></b>(const Version: <a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>; const BaseUrl: string; const NavigationType: string; const WalkSpeed, VisibilityLimit: Single; const AvatarSize: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>; const Headlight: boolean): <a  href="X3DNodes.TNavigationInfoNode.html">TNavigationInfoNode</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="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a></b> = (...);</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="X3DCameraUtils.html#DefaultX3DCameraPosition">DefaultX3DCameraPosition</a></b>: array [<a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>] of <a  href="CastleVectors.html#TVector3Single">TVector3Single</a> =
    ( (0, 0, 1), (0, 0, 10) );</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a  href="X3DCameraUtils.html#DefaultX3DCameraDirection">DefaultX3DCameraDirection</a></b>: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a> = (0, 0, -1);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a  href="X3DCameraUtils.html#DefaultX3DCameraUp">DefaultX3DCameraUp</a></b>: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a> = (0, 1, 0);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a  href="X3DCameraUtils.html#DefaultX3DGravityUp">DefaultX3DGravityUp</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="MakeCameraStr"></a><code>function <b>MakeCameraStr</b>(const Version: <a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>; const Xml: boolean; const Position, Direction, Up, GravityUp: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>): string;</code></td>
</tr>
<tr><td colspan="1">
<p>
Construct string with VRML/X3D node defining camera with given properties.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="MakeCameraNode"></a><code>function <b>MakeCameraNode</b>(const Version: <a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>; const BaseUrl: string; const Position, Direction, Up, GravityUp: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>): <a  href="X3DNodes.TX3DNode.html">TX3DNode</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Construct <a class="normal" href="X3DNodes.TX3DNode.html">TX3DNode</a> defining camera with given properties.

<p>Overloaded version with ViewpointNode parameter returns the <a class="normal" href="X3DNodes.TAbstractViewpointNode.html">TAbstractViewpointNode</a> descendant that is (somewhere within) the returned node.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="MakeCameraNode"></a><code>function <b>MakeCameraNode</b>(const Version: <a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>; const BaseUrl: string; const Position, Direction, Up, GravityUp: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>; out ViewpointNode: <a  href="X3DNodes.TAbstractViewpointNode.html">TAbstractViewpointNode</a>): <a  href="X3DNodes.TX3DNode.html">TX3DNode</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="CameraNodeForWholeScene"></a><code>function <b>CameraNodeForWholeScene</b>(const Version: <a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>; const BaseUrl: string; const Box: <a  href="CastleBoxes.TBox3D.html">TBox3D</a>; const WantedDirection, WantedUp: Integer; const WantedDirectionPositive, WantedUpPositive: boolean): <a  href="X3DNodes.TX3DNode.html">TX3DNode</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Make camera node (like <a class="normal" href="X3DCameraUtils.html#MakeCameraNode">MakeCameraNode</a>) that makes the whole box nicely visible (like <a class="normal" href="CastleCameras.html#CameraViewpointForWholeScene">CameraViewpointForWholeScene</a>).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="MakeCameraNavNode"></a><code>function <b>MakeCameraNavNode</b>(const Version: <a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>; const BaseUrl: string; const NavigationType: string; const WalkSpeed, VisibilityLimit: Single; const AvatarSize: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a>; const Headlight: boolean): <a  href="X3DNodes.TNavigationInfoNode.html">TNavigationInfoNode</a>;</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="TX3DCameraVersion"></a><code><b>TX3DCameraVersion</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
Version of VRML/X3D camera definition.</p>
<h6 class="description_section">Values</h6>
<ul>
<li>
cvVrml1_Inventor: &nbsp;</li>
<li>
cvVrml2_X3d: &nbsp;</li>
</ul>
</td></tr>
</table>
<h3 class="detail">Constants</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DefaultX3DCameraPosition"></a><code><b>DefaultX3DCameraPosition</b>: array [<a  href="X3DCameraUtils.html#TX3DCameraVersion">TX3DCameraVersion</a>] of <a  href="CastleVectors.html#TVector3Single">TVector3Single</a> =
    ( (0, 0, 1), (0, 0, 10) );</code></td>
</tr>
<tr><td colspan="1">
<p>
Standard camera settings given by VRML/X3D specifications. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DefaultX3DCameraDirection"></a><code><b>DefaultX3DCameraDirection</b>: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a> = (0, 0, -1);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DefaultX3DCameraUp"></a><code><b>DefaultX3DCameraUp</b>: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a> = (0, 1, 0);</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DefaultX3DGravityUp"></a><code><b>DefaultX3DGravityUp</b>: <a  href="CastleVectors.html#TVector3Single">TVector3Single</a> = (0, 1, 0);</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:13</em>
</span>
</td></tr></table></body></html>