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
|
<!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: CastleSceneManager: Class TCastleViewport</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="TCastleViewport"></a><h1 class="cio">Class TCastleViewport</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="CastleSceneManager.html">CastleSceneManager</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCastleViewport = class(<a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html">TCastleAbstractViewport</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Custom 2D viewport showing 3D world. This uses assigned <a class="normal" href="CastleSceneManager.TCastleViewport.html#SceneManager">SceneManager</a> to show 3D world on the screen.
<p>For simple games, using this is not needed, because <a class="normal" href="CastleSceneManager.TCastleSceneManager.html">TCastleSceneManager</a> also acts as a viewport (when <a class="normal" href="CastleSceneManager.TCastleSceneManager.html#DefaultViewport">TCastleSceneManager.DefaultViewport</a> is <code>True</code>, which is the default). Using custom viewports (implemented by this class) is useful when you want to have more than one viewport showing the same 3D world. Different viewports may have different cameras, but they always share the same 3D world (in scene manager).
<p>You can control the size of this viewport by <a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html#FullSize">FullSize</a>, <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Left">Left</a>, <a class="normal" href="CastleUIControls.TUIRectangularControl.html#Bottom">Bottom</a>, <a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html#Width">Width</a>, <a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html#Height">Height</a> properties. For custom viewports, you often want to set <a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html#FullSize">FullSize</a> = <code>False</code> and control viewport's position and size explicitly.
<p>Example usages: in a typical 3D modeling programs, you like to have 4 viewports with 4 different cameras (front view, side view, top view, and free perspective view). See examples/vrml/multiple_viewports.lpr in engine sources for demo of this. Or when you make a split-screen game, played by 2 people on a single monitor.
<p>Viewports may be overlapping, that is one viewport may (partially) obscure another viewport. Just like with any other <a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a>, position of viewport on the Controls list (like <a class="normal" href="CastleControl.TCastleControlCustom.html#Controls">TCastleControlCustom.Controls</a> or <a class="normal" href="CastleWindow.TCastleWindowCustom.html#Controls">TCastleWindowCustom.Controls</a>) is important: Controls are specified in the front-to-back order. That is, if the viewport X may obscure viewport Y, then X must be before Y on the Controls list.
<p>Example usage of overlapping viewports: imagine a space shooter, like Epic or Wing Commander. You can imagine that a camera is mounted on each rocket fired by the player. You can display in one viewport (with <a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html#FullSize">FullSize</a> = <code>True</code>) normal (first person) view from your space ship. And additionally you can place a small viewport (with <a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html#FullSize">FullSize</a> = <code>False</code> and small <a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html#Width">Width</a> / <a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html#Height">Height</a>) in the upper-right corner that displays view from last fired rocket.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TComponent</li>
<li class="ancestor"><a class="normal" href="CastleUIControls.TInputListener.html">TInputListener</a></li>
<li class="ancestor"><a class="normal" href="CastleUIControls.TUIControl.html">TUIControl</a></li>
<li class="ancestor"><a class="normal" href="CastleUIControls.TUIRectangularControl.html">TUIRectangularControl</a></li>
<li class="ancestor"><a class="normal" href="CastleSceneManager.TCastleAbstractViewport.html">TCastleAbstractViewport</a></li>
<li class="thisitem">TCastleViewport</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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#GetItems">GetItems</a></b>: <a href="Castle3D.T3DWorld.html">T3DWorld</a>; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#GetMainScene">GetMainScene</a></b>: <a href="CastleScene.TCastleScene.html">TCastleScene</a>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#GetShadowVolumeRenderer">GetShadowVolumeRenderer</a></b>: <a href="CastleGLShadowVolumes.TGLShadowVolumeRenderer.html">TGLShadowVolumeRenderer</a>; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#GetMouseRayHit">GetMouseRayHit</a></b>: <a href="Castle3D.TRayCollision.html">TRayCollision</a>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#GetHeadlightCamera">GetHeadlightCamera</a></b>: <a href="CastleCameras.TCamera.html">TCamera</a>; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#GetPlayer">GetPlayer</a></b>: <a href="CastlePlayer.TPlayer.html">TPlayer</a>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#GetTimeScale">GetTimeScale</a></b>: Single; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#PointingDeviceActivate">PointingDeviceActivate</a></b>(const Active: boolean): boolean; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#PointingDeviceMove">PointingDeviceMove</a></b>(const RayOrigin, RayDirection: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): boolean; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#CameraMoveAllowed">CameraMoveAllowed</a></b>(ACamera: <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; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#CameraHeight">CameraHeight</a></b>(ACamera: <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; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#CameraRayCollision">CameraRayCollision</a></b>(const RayOrigin, RayDirection: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): <a href="Castle3D.TRayCollision.html">TRayCollision</a>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a href="CastleSceneManager.TCastleViewport.html#CameraVisibleChange">CameraVisibleChange</a></b>(ACamera: TObject); override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSceneManager.TCastleViewport.html#Headlight">Headlight</a></b>: <a href="X3DNodes.TAbstractLightNode.html">TAbstractLightNode</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>destructor <b><a href="CastleSceneManager.TCastleViewport.html#Destroy">Destroy</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>procedure <b><a href="CastleSceneManager.TCastleViewport.html#Render">Render</a></b>; 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="CastleSceneManager.TCastleViewport.html#CreateDefaultCamera">CreateDefaultCamera</a></b>(AOwner: TComponent): <a href="CastleCameras.TCamera.html">TCamera</a>; override;</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSceneManager.TCastleViewport.html#SceneManager">SceneManager</a></b>: <a href="CastleSceneManager.TCastleSceneManager.html">TCastleSceneManager</a> read FSceneManager write SetSceneManager;</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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetItems"></a><code>function <b>GetItems</b>: <a href="Castle3D.T3DWorld.html">T3DWorld</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetMainScene"></a><code>function <b>GetMainScene</b>: <a href="CastleScene.TCastleScene.html">TCastleScene</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetShadowVolumeRenderer"></a><code>function <b>GetShadowVolumeRenderer</b>: <a href="CastleGLShadowVolumes.TGLShadowVolumeRenderer.html">TGLShadowVolumeRenderer</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetMouseRayHit"></a><code>function <b>GetMouseRayHit</b>: <a href="Castle3D.TRayCollision.html">TRayCollision</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetHeadlightCamera"></a><code>function <b>GetHeadlightCamera</b>: <a href="CastleCameras.TCamera.html">TCamera</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetPlayer"></a><code>function <b>GetPlayer</b>: <a href="CastlePlayer.TPlayer.html">TPlayer</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetTimeScale"></a><code>function <b>GetTimeScale</b>: Single; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="PointingDeviceActivate"></a><code>function <b>PointingDeviceActivate</b>(const Active: boolean): boolean; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="PointingDeviceMove"></a><code>function <b>PointingDeviceMove</b>(const RayOrigin, RayDirection: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): boolean; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CameraMoveAllowed"></a><code>function <b>CameraMoveAllowed</b>(ACamera: <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; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CameraHeight"></a><code>function <b>CameraHeight</b>(ACamera: <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; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CameraRayCollision"></a><code>function <b>CameraRayCollision</b>(const RayOrigin, RayDirection: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): <a href="Castle3D.TRayCollision.html">TRayCollision</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CameraVisibleChange"></a><code>procedure <b>CameraVisibleChange</b>(ACamera: TObject); override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="Headlight"></a><code>function <b>Headlight</b>: <a href="X3DNodes.TAbstractLightNode.html">TAbstractLightNode</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</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="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
</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="Render"></a><code>procedure <b>Render</b>; override;</code></td>
</tr>
<tr><td colspan="2">
</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="CreateDefaultCamera"></a><code>function <b>CreateDefaultCamera</b>(AOwner: TComponent): <a href="CastleCameras.TCamera.html">TCamera</a>; override;</code></td>
</tr>
<tr><td colspan="2">
</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="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><a name="SceneManager"></a><code>property <b>SceneManager</b>: <a href="CastleSceneManager.TCastleSceneManager.html">TCastleSceneManager</a> read FSceneManager write SetSceneManager;</code></td>
</tr>
<tr><td colspan="2">
</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:11</em>
</span>
</td></tr></table></body></html>
|
