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
|
<!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: Castle3D: Class T3DWorld</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="T3DWorld"></a><h1 class="cio">Class T3DWorld</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>Properties</td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="Castle3D.html">Castle3D</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type T3DWorld = class(<a class="normal" href="Castle3D.T3DList.html">T3DList</a>)</code></p>
<h2 class="description">Description</h2>
<p>
3D world. List of 3D objects, with some central properties.</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="Castle3D.T3D.html">T3D</a></li>
<li class="ancestor"><a class="normal" href="Castle3D.T3DList.html">T3DList</a></li>
<li class="thisitem">T3DWorld</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>function <b><a href="Castle3D.T3DWorld.html#World">World</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="Castle3D.T3DWorld.html#CollisionIgnoreItem">CollisionIgnoreItem</a></b>(const Sender: TObject; const Triangle: <a href="CastleTriangles.html#P3DTriangle">P3DTriangle</a>): boolean; 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>function <b><a href="Castle3D.T3DWorld.html#GravityUp">GravityUp</a></b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</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>function <b><a href="Castle3D.T3DWorld.html#GravityCoordinate">GravityCoordinate</a></b>: Integer;</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="Castle3D.T3DWorld.html#Player">Player</a></b>: <a href="Castle3D.T3DAlive.html">T3DAlive</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>function <b><a href="Castle3D.T3DWorld.html#BaseLights">BaseLights</a></b>: <a href="Castle3D.html#TAbstractLightInstancesList">TAbstractLightInstancesList</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>function <b><a href="Castle3D.T3DWorld.html#Sectors">Sectors</a></b>: <a href="CastleSectors.TSectorList.html">TSectorList</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>function <b><a href="Castle3D.T3DWorld.html#Water">Water</a></b>: <a href="CastleBoxes.TBox3D.html">TBox3D</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>function <b><a href="Castle3D.T3DWorld.html#WorldMoveAllowed">WorldMoveAllowed</a></b>( const OldPos, ProposedNewPos: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out NewPos: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; const IsRadius: boolean; const Radius: Single; const OldBox, NewBox: <a href="CastleBoxes.TBox3D.html">TBox3D</a>; const BecauseOfGravity: boolean): boolean; 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>function <b><a href="Castle3D.T3DWorld.html#WorldMoveAllowed">WorldMoveAllowed</a></b>( const OldPos, NewPos: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; const IsRadius: boolean; const Radius: Single; const OldBox, NewBox: <a href="CastleBoxes.TBox3D.html">TBox3D</a>; const BecauseOfGravity: boolean): boolean; 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>function <b><a href="Castle3D.T3DWorld.html#WorldHeight">WorldHeight</a></b>(const Position: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out AboveHeight: Single; out AboveGround: <a href="CastleTriangles.html#P3DTriangle">P3DTriangle</a>): boolean; 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>function <b><a href="Castle3D.T3DWorld.html#WorldLineOfSight">WorldLineOfSight</a></b>(const Pos1, Pos2: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): boolean; 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>function <b><a href="Castle3D.T3DWorld.html#WorldRay">WorldRay</a></b>(const RayOrigin, RayDirection: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): <a href="Castle3D.TRayCollision.html">TRayCollision</a>; virtual; abstract;</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="World"></a><code>function <b>World</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="CollisionIgnoreItem"></a><code>function <b>CollisionIgnoreItem</b>(const Sender: TObject; const Triangle: <a href="CastleTriangles.html#P3DTriangle">P3DTriangle</a>): boolean; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
See <a class="normal" href="CastleSceneManager.TCastleSceneManager.html#CollisionIgnoreItem">TCastleSceneManager.CollisionIgnoreItem</a>.</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="GravityUp"></a><code>function <b>GravityUp</b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Up vector, according to gravity. Gravity force pulls in -<code>GravityUp</code> direction.</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="GravityCoordinate"></a><code>function <b>GravityCoordinate</b>: Integer;</code></td>
</tr>
<tr><td colspan="2">
<p>
The major axis of gravity vector: 0, 1 or 2. This is derived from <a class="normal" href="Castle3D.T3DWorld.html#GravityUp">GravityUp</a> value. It can only truly express <a class="normal" href="Castle3D.T3DWorld.html#GravityUp">GravityUp</a> vector values (1,0,0) or (0,1,0) or (0,0,1), although in practice this is enough for normal games (normal 3D scenes use up either +Y or +Z).
<p>We try to avoid using it in the engine, and use full <a class="normal" href="Castle3D.T3DWorld.html#GravityUp">GravityUp</a> vector wherever possible. Full <a class="normal" href="Castle3D.T3DWorld.html#GravityUp">GravityUp</a> vector may allow for more fun with weird gravity in future games.</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="Player"></a><code>function <b>Player</b>: <a href="Castle3D.T3DAlive.html">T3DAlive</a>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Player, see <a class="normal" href="CastleSceneManager.TCastleSceneManager.html#Player">TCastleSceneManager.Player</a>.</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="BaseLights"></a><code>function <b>BaseLights</b>: <a href="Castle3D.html#TAbstractLightInstancesList">TAbstractLightInstancesList</a>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Base lights, see TCastleSceneManager.BaseLights.</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="Sectors"></a><code>function <b>Sectors</b>: <a href="CastleSectors.TSectorList.html">TSectorList</a>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sectors in the world, for AI. See <a class="normal" href="CastleSceneManager.TCastleSceneManager.html#Sectors">TCastleSceneManager.Sectors</a>.</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="Water"></a><code>function <b>Water</b>: <a href="CastleBoxes.TBox3D.html">TBox3D</a>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Water volume. See <a class="normal" href="CastleSceneManager.TCastleSceneManager.html#Water">TCastleSceneManager.Water</a>.</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="WorldMoveAllowed"></a><code>function <b>WorldMoveAllowed</b>( const OldPos, ProposedNewPos: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out NewPos: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; const IsRadius: boolean; const Radius: Single; const OldBox, NewBox: <a href="CastleBoxes.TBox3D.html">TBox3D</a>; const BecauseOfGravity: boolean): boolean; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Collisions with world. They call corresponding methods without the World prefix, automatically taking into account some knowledge about this 3D world.
<p>Calling these methods to check collisions makes sense if your collision query is not initiated by any existing <a class="normal" href="Castle3D.T3D.html">T3D</a> instance.
<p>If your query originates from some existing <a class="normal" href="Castle3D.T3D.html">T3D</a> instance, you usually do not want to call these WorldXxx methods. Instead call <a class="normal" href="Castle3D.T3D.html#MoveAllowed">T3D.MoveAllowed</a>, <a class="normal" href="Castle3D.T3D.html#Height">T3D.Height</a> methods. Underneath, they still call <code>World.WorldMoveAllowed</code> and <code>World.WorldHeight</code>, additionally making sure that the 3D object does not collide with itself. </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="WorldMoveAllowed"></a><code>function <b>WorldMoveAllowed</b>( const OldPos, NewPos: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; const IsRadius: boolean; const Radius: Single; const OldBox, NewBox: <a href="CastleBoxes.TBox3D.html">TBox3D</a>; const BecauseOfGravity: boolean): boolean; virtual; abstract;</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="WorldHeight"></a><code>function <b>WorldHeight</b>(const Position: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out AboveHeight: Single; out AboveGround: <a href="CastleTriangles.html#P3DTriangle">P3DTriangle</a>): boolean; virtual; abstract;</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="WorldLineOfSight"></a><code>function <b>WorldLineOfSight</b>(const Pos1, Pos2: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): boolean; virtual; abstract;</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="WorldRay"></a><code>function <b>WorldRay</b>(const RayOrigin, RayDirection: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>): <a href="Castle3D.TRayCollision.html">TRayCollision</a>; virtual; abstract;</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:07</em>
</span>
</td></tr></table></body></html>
|
