File: CastleOctree.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 (179 lines) | stat: -rw-r--r-- 9,769 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
 
<!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: CastleOctree</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 CastleOctree</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>Constants</td><td>Variables</td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
Base octree classes (<a class="normal" href="CastleOctree.TOctreeNode.html">TOctreeNode</a> and <a class="normal" href="CastleOctree.TOctree.html">TOctree</a>) and utilities. Used by actual octrees in units like <a class="normal" href="CastleTriangleOctree.html">CastleTriangleOctree</a> and <a class="normal" href="CastleShapeOctree.html">CastleShapeOctree</a>.

<p>Typical way to derive actual (non-abstract) octrees goes like this; </p>

<pre class="longcode">
<span class="pascal_keyword">type</span>
  TMyOctree = <span class="pascal_keyword">class</span>;

  TMyOctreeNode = <span class="pascal_keyword">class</span>(TOctreeNode)
  <span class="pascal_keyword">protected</span>
    <span class="pascal_keyword">procedure</span> PutItemIntoSubNodes(ItemIndex: integer); <span class="pascal_keyword">override</span>;
  <span class="pascal_keyword">public</span>
    <span class="pascal_keyword">function</span> ParentTree: TMyOctree;
 <span class="pascal_keyword">end</span>;

  TMyOctree = <span class="pascal_keyword">class</span>(TOctree)
  <span class="pascal_keyword">public</span>
    <span class="pascal_keyword">constructor</span> Create(AMaxDepth, ALeafCapacity: Integer;
      <span class="pascal_keyword">const</span> ARootBox: TBox3D);
    <span class="pascal_keyword">function</span> TreeRoot: TMyOctreeNode;
  <span class="pascal_keyword">end</span>;

<span class="pascal_comment">{ implementation }</span>

<span class="pascal_keyword">procedure</span> TMyOctreeNode.PutItemIntoSubNodes(ItemIndex: integer);
<span class="pascal_keyword">begin</span>
  <span class="pascal_comment">{ See comments at @link(TOctreeNode.PutItemIntoSubNodes)
    to know how you should implement this. }</span>
<span class="pascal_keyword">end</span>;

<span class="pascal_keyword">function</span> TMyOctreeNode.ParentTree: TMyOctree;
<span class="pascal_keyword">begin</span>
  Result := TMyOctree(InternalParentTree);
<span class="pascal_keyword">end</span>;

<span class="pascal_keyword">constructor</span> TMyOctree.Create(AMaxDepth, ALeafCapacity: Integer;
  <span class="pascal_keyword">const</span> ARootBox: TBox3D);
<span class="pascal_keyword">begin</span>
  <span class="pascal_keyword">inherited</span> Create(AMaxDepth, ALeafCapacity, ARootBox, TMyOctreeNode);
<span class="pascal_keyword">end</span>;

<span class="pascal_keyword">function</span> TMyOctree.TreeRoot: TMyOctreeNode;
<span class="pascal_keyword">begin</span>
  Result := TMyOctreeNode(InternalTreeRoot);
<span class="pascal_keyword">end</span>;
</pre>

<p></p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li>SysUtils</li><li><a  href="CastleVectors.html">CastleVectors</a></li><li><a  href="CastleBoxes.html">CastleBoxes</a></li><li><a  href="CastleUtils.html">CastleUtils</a></li><li><a  href="CastleFrustum.html">CastleFrustum</a></li><li>Contnrs</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&nbsp;<a class="bold" href="CastleOctree.TOctreeNode.html"><code>TOctreeNode</code></a></td>
<td class="itemdesc">Octree node.</td>
</tr>
<tr class="list2">
<td class="itemname">record&nbsp;<a class="bold" href="CastleOctree.TOctreeLimits.html"><code>TOctreeLimits</code></a></td>
<td class="itemdesc">Helper structure to keep octree limits.</td>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="CastleOctree.TOctree.html"><code>TOctree</code></a></td>
<td class="itemdesc">Base abstract octree class.</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>function <b><a  href="CastleOctree.html#OctreeSubnodeIndexToNiceStr">OctreeSubnodeIndexToNiceStr</a></b>(const SI: <a  href="CastleOctree.html#TOctreeSubnodeIndex">TOctreeSubnodeIndex</a>): string;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a  href="CastleOctree.html#OctreeSubnodeIndexesEqual">OctreeSubnodeIndexesEqual</a></b>(const SI1, SI2: <a  href="CastleOctree.html#TOctreeSubnodeIndex">TOctreeSubnodeIndex</a>): boolean;</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="CastleOctree.html#TOctreeNodeClass">TOctreeNodeClass</a></b> = class of <a  href="CastleOctree.TOctreeNode.html">TOctreeNode</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a  href="CastleOctree.html#TOctreeSubnodeIndex">TOctreeSubnodeIndex</a></b> = array[0..2]of boolean;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a  href="CastleOctree.html#TEnumerateOctreeItemsFunc">TEnumerateOctreeItemsFunc</a></b> = procedure(ItemIndex: Integer; CollidesForSure: boolean) of object;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a  href="CastleOctree.html#POctreeLimits">POctreeLimits</a></b> = &circ;<a  href="CastleOctree.TOctreeLimits.html">TOctreeLimits</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="OctreeSubnodeIndexToNiceStr"></a><code>function <b>OctreeSubnodeIndexToNiceStr</b>(const SI: <a  href="CastleOctree.html#TOctreeSubnodeIndex">TOctreeSubnodeIndex</a>): string;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="OctreeSubnodeIndexesEqual"></a><code>function <b>OctreeSubnodeIndexesEqual</b>(const SI1, SI2: <a  href="CastleOctree.html#TOctreeSubnodeIndex">TOctreeSubnodeIndex</a>): boolean;</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="TOctreeNodeClass"></a><code><b>TOctreeNodeClass</b> = class of <a  href="CastleOctree.TOctreeNode.html">TOctreeNode</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="TOctreeSubnodeIndex"></a><code><b>TOctreeSubnodeIndex</b> = array[0..2]of boolean;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TEnumerateOctreeItemsFunc"></a><code><b>TEnumerateOctreeItemsFunc</b> = procedure(ItemIndex: Integer; CollidesForSure: boolean) of object;</code></td>
</tr>
<tr><td colspan="1">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="POctreeLimits"></a><code><b>POctreeLimits</b> = &circ;<a  href="CastleOctree.TOctreeLimits.html">TOctreeLimits</a>;</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:10</em>
</span>
</td></tr></table></body></html>