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
|
<!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: CastleScene</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 CastleScene</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><a class="section" href="#PasDoc-Variables">Variables</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
VRML/X3D complete scene handling and OpenGL rendering (<a class="normal" href="CastleScene.TCastleScene.html">TCastleScene</a>).</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li>SysUtils</li><li>Classes</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><li><a href="CastleClassUtils.html">CastleClassUtils</a></li><li><a href="CastleUtils.html">CastleUtils</a></li><li><a href="CastleSceneCore.html">CastleSceneCore</a></li><li><a href="CastleRenderer.html">CastleRenderer</a></li><li>GL</li><li>GLU</li><li>GLExt</li><li><a href="CastleBackground.html">CastleBackground</a></li><li><a href="CastleGLUtils.html">CastleGLUtils</a></li><li><a href="CastleShapeOctree.html">CastleShapeOctree</a></li><li><a href="CastleGLShadowVolumes.html">CastleGLShadowVolumes</a></li><li><a href="X3DFields.html">X3DFields</a></li><li><a href="CastleTriangles.html">CastleTriangles</a></li><li><a href="CastleShapes.html">CastleShapes</a></li><li><a href="CastleFrustum.html">CastleFrustum</a></li><li><a href="Castle3D.html">Castle3D</a></li><li><a href="CastleGLShaders.html">CastleGLShaders</a></li><li>FGL</li><li><a href="CastleGenericLists.html">CastleGenericLists</a></li><li><a href="CastleRectangles.html">CastleRectangles</a></li><li>CastleSceneInternalShape</li><li>CastleSceneInternalOcclusion</li><li>CastleSceneInternalBlending</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="CastleScene.TSceneRenderingAttributes.html"><code>TSceneRenderingAttributes</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScene.TCastleScene.html"><code>TCastleScene</code></a></td>
<td class="itemdesc">Complete handling and rendering of a 3D VRML/X3D scene.</td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScene.TCastleSceneList.html"><code>TCastleSceneList</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>procedure <b><a href="CastleScene.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="CastleScene.html#TWireframeEffect">TWireframeEffect</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScene.html#TBeforeShapeRenderProc">TBeforeShapeRenderProc</a></b> = procedure (Shape: <a href="CastleShapes.TShape.html">TShape</a>) of object;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleScene.html#TRenderingAttributesEvent">TRenderingAttributesEvent</a></b> = procedure (Attributes: <a href="CastleScene.TSceneRenderingAttributes.html">TSceneRenderingAttributes</a>) of object;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScene.html#TBlendingSort">TBlendingSort</a></b> = (...);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleScene.html#TPrepareResourcesOption">TPrepareResourcesOption</a></b> = <a href="Castle3D.html#TPrepareResourcesOption">Castle3D.TPrepareResourcesOption</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScene.html#TPrepareResourcesOptions">TPrepareResourcesOptions</a></b> = <a href="Castle3D.html#TPrepareResourcesOptions">Castle3D.TPrepareResourcesOptions</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleScene.html#TFrustumCulling">TFrustumCulling</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScene.html#TTriangle4SingleList">TTriangle4SingleList</a></b> = specialize <a href="CastleGenericLists.TGenericStructList.html">TGenericStructList</a><<a href="CastleTriangles.html#TTriangle4Single">TTriangle4Single</a>>;</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="CastleScene.html#prRender">prRender</a></b> = Castle3D.prRender;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScene.html#prBackground">prBackground</a></b> = Castle3D.prBackground;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleScene.html#prBoundingBox">prBoundingBox</a></b> = Castle3D.prBoundingBox;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScene.html#prTrianglesListShadowCasters">prTrianglesListShadowCasters</a></b> = Castle3D.prTrianglesListShadowCasters;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleScene.html#prManifoldAndBorderEdges">prManifoldAndBorderEdges</a></b> = Castle3D.prManifoldAndBorderEdges;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScene.html#prShadowVolume">prShadowVolume</a></b> = [<a href="CastleScene.html#prTrianglesListShadowCasters">prTrianglesListShadowCasters</a>, <a href="CastleScene.html#prManifoldAndBorderEdges">prManifoldAndBorderEdges</a>];</code></td>
</tr>
</table>
<a name="PasDoc-Variables"></a><h3 class="summary">Variables</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="CastleScene.html#GLContextCache">GLContextCache</a></b>: <a href="CastleRenderer.TGLRendererContextCache.html">TGLRendererContextCache</a>;</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="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="TWireframeEffect"></a><code><b>TWireframeEffect</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
Values for <a class="normal" href="CastleScene.TSceneRenderingAttributes.html#WireframeEffect">TSceneRenderingAttributes.WireframeEffect</a>.
<p>Generally, two other attributes may affect the way wireframe is rendered: <a class="normal" href="CastleScene.TSceneRenderingAttributes.html#WireframeColor">TSceneRenderingAttributes.WireframeColor</a> and TSceneRenderingAttributes.LineWidth, quite self-explanatory.</p>
<h6 class="description_section">Values</h6>
<ul>
<li>
weNormal: Default setting, model polygons are simply passed to OpenGL. Whether this results in filled or wireframe look, depends on OpenGL glPolygonMode setting, filled by default.</li>
<li>
weWireframeOnly: The model is rendered in wireframe mode.
<p>LineWidth is used as wireframe line width (regardless of TSceneRenderingAttributes.Mode).
<p>Depending on TSceneRenderingAttributes.Mode value:
<p></p>
<ul class="paragraph_spacing">
<li><p>If <> rmFull then WireframeColor is used as wireframe line color.</p></li>
<li><p>If rmFull, then lines are colored and potentially lighted and textured just like their corresponding triangles would be colored. So you can control lighting using Lighting, UseSceneLights etc. attributes, and you can control texturing by EnableTextures attribute.</p></li>
</ul>
<p></li>
<li>
weSolidWireframe: The model is rendered as normal, with it's wireframe version visible on top. This is most often called "solid wireframe", since the intention is too see wireframe version of the model but still render shapes solid (e.g. filled polygons with depth test).
<p>WireframeColor and LineWidth are used as wireframe line color/width (regardless of current scene <a class="normal" href="CastleRenderer.TRenderingAttributes.html#Mode">Attributes.Mode</a> value).
<p>This usually gives best results when <a class="normal" href="CastleRenderer.TRenderingAttributes.html#Mode">Attributes.Mode</a> = rmPureGeometry. Then current glColor sets the color of the solid model (and, like said before, WireframeColor sets wireframe color).</li>
<li>
weSilhouette: The model is rendered as normal, with silhouette outlined around it. This works quite like weSolidWireframe, except that weSolidWireframe makes the wireframe mesh slightly in front the model, while weSilhouette makes the wireframe mesh slightly at the back of the model. This way only the silhouette is visible from the wireframe rendering.
<p>WireframeColor and LineWidth are used as silhouette line color/width (regardless of current scene <a class="normal" href="CastleRenderer.TRenderingAttributes.html#Mode">Attributes.Mode</a> value).
<p>This is sometimes sensible to use with <a class="normal" href="CastleRenderer.TRenderingAttributes.html#Mode">Attributes.Mode</a> = rmPureGeometry. Then current glColor sets the color of the solid model (and, like said before, WireframeColor sets wireframe color).</li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TBeforeShapeRenderProc"></a><code><b>TBeforeShapeRenderProc</b> = procedure (Shape: <a href="CastleShapes.TShape.html">TShape</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="TRenderingAttributesEvent"></a><code><b>TRenderingAttributesEvent</b> = procedure (Attributes: <a href="CastleScene.TSceneRenderingAttributes.html">TSceneRenderingAttributes</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="TBlendingSort"></a><code><b>TBlendingSort</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<h6 class="description_section">Values</h6>
<ul>
<li>
bsNone: </li>
<li>
bs2D: </li>
<li>
bs3D: </li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TPrepareResourcesOption"></a><code><b>TPrepareResourcesOption</b> = <a href="Castle3D.html#TPrepareResourcesOption">Castle3D.TPrepareResourcesOption</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TPrepareResourcesOptions"></a><code><b>TPrepareResourcesOptions</b> = <a href="Castle3D.html#TPrepareResourcesOptions">Castle3D.TPrepareResourcesOptions</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TFrustumCulling"></a><code><b>TFrustumCulling</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
Possible checks done while frustum culling.
<p>This is used for <a class="normal" href="CastleScene.TCastleScene.html#FrustumCulling">TCastleScene.FrustumCulling</a> (what checks should be done when shapes octree is not available) and <a class="normal" href="CastleScene.TCastleScene.html#OctreeFrustumCulling">TCastleScene.OctreeFrustumCulling</a> (what checks should be done when shapes octree is available).
<p>In the second case, checks done by <code>TFrustumCulling</code> are applied after octree traverse. That is, octree already eliminated some shapes, and fully included some other shapes while traversing. <code>TFrustumCulling</code> are used in this case only as a "last resort", to check only the shapes in octree leaves that are in "possibly-colliding" state with frustum.
<p>Generally, more checks mean that more shapes may be eliminated but also that we waste more time on checks themselves. What is optimal depends on given 3D model, and how you expect the player to view it (e.g. if player usually sees the whole model, then <code>TFrustumCulling</code> checks may be useless waste of time; OTOH, if player stands inside the model composed from many shapes then <code>TFrustumCulling</code> may help).</p>
<h6 class="description_section">Values</h6>
<ul>
<li>
fcNone: No checks.
<p>Setting this as <a class="normal" href="CastleScene.TCastleScene.html#FrustumCulling">TCastleScene.FrustumCulling</a> turns off frustum culling entirely, which is usually not a wise thing to do. Setting this as <a class="normal" href="CastleScene.TCastleScene.html#OctreeFrustumCulling">TCastleScene.OctreeFrustumCulling</a> means that frustum culling is only done during octree traversal (we only visit octree nodes possibly colliding with frustum), this is also not optimal.</li>
<li>
fcSphere: Check shape's bounding sphere for collision with frustum.</li>
<li>
fcBox: Check shape's bounding box for collision with frustum.</li>
<li>
fcBoth: Check shape's bounding sphere, and then box, for collision with frustum. This is the most rigoristic check, but usually this is a waste of time: in most cases, when bounding sphere collides, then bounding box collides too.</li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TTriangle4SingleList"></a><code><b>TTriangle4SingleList</b> = specialize <a href="CastleGenericLists.TGenericStructList.html">TGenericStructList</a><<a href="CastleTriangles.html#TTriangle4Single">TTriangle4Single</a>>;</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="prRender"></a><code><b>prRender</b> = Castle3D.prRender;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="prBackground"></a><code><b>prBackground</b> = Castle3D.prBackground;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="prBoundingBox"></a><code><b>prBoundingBox</b> = Castle3D.prBoundingBox;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="prTrianglesListShadowCasters"></a><code><b>prTrianglesListShadowCasters</b> = Castle3D.prTrianglesListShadowCasters;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="prManifoldAndBorderEdges"></a><code><b>prManifoldAndBorderEdges</b> = Castle3D.prManifoldAndBorderEdges;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="prShadowVolume"></a><code><b>prShadowVolume</b> = [<a href="CastleScene.html#prTrianglesListShadowCasters">prTrianglesListShadowCasters</a>, <a href="CastleScene.html#prManifoldAndBorderEdges">prManifoldAndBorderEdges</a>];</code></td>
</tr>
<tr><td colspan="1">
<p>
Options to pass to <a class="normal" href="CastleScene.TCastleScene.html#PrepareResources">TCastleScene.PrepareResources</a> to make sure that rendering with shadow volumes is as fast as possible.
<p>For now this actually could be equal to prManifoldEdges (<a class="normal" href="CastleScene.html#prTrianglesListShadowCasters">prTrianglesListShadowCasters</a> has to be prepared while preparing ManifoldEdges edges anyway). But for the future shadow volumes optimizations, it's best to use this constant.</p>
</td></tr>
</table>
<h3 class="detail">Variables</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="GLContextCache"></a><code><b>GLContextCache</b>: <a href="CastleRenderer.TGLRendererContextCache.html">TGLRendererContextCache</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Global OpenGL context cache. This caches common things, like textures, shapes, and much more. Our OpenGL resources are currently shared across all OpenGL contexts, and they all automatically share this cache.</p>
</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>
|
