/
OctreeImplementation.h
307 lines (227 loc) · 10.8 KB
/
OctreeImplementation.h
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
/*------------------------------------------------------------------------------
Octree Component, version 2.1
Copyright (c) 2004-2007, Harrison Ainsworth / HXA7241.
http://www.hxa7241.org/
------------------------------------------------------------------------------*/
/*------------------------------------------------------------------------------
Copyright (c) 2004-2007, Harrison Ainsworth / HXA7241.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
* The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
------------------------------------------------------------------------------*/
#ifndef OctreeImplementation_h
#define OctreeImplementation_h
#include "OctreeAuxiliary.h"
namespace hxa7241_graphics
{
/**
* Implementation class for the Octree template.
*
* @invariants
* pRootCell_m can be null, or point to an OctreeCell instance.<br/><br/>
*
* At construction, pRootCell_m is set to a legal value.<br/>
* At destruction, pRootCell_m is deleted.<br/>
* Whenever pRootCell_m is modified, it must be deleted then set to a legal
* value.<br/>
* A legal value is: either 0, or the value from invocation of 'new'.
*/
class OctreeRoot
{
/// standard object services ---------------------------------------------------
public:
OctreeRoot( const Vector3r& position,
real sizeOfCube,
dword maxItemsPerCell,
dword maxLevelCount,
real minCellSize );
~OctreeRoot();
OctreeRoot( const OctreeRoot& );
OctreeRoot& operator=( const OctreeRoot& );
/// commands -------------------------------------------------------------------
bool insert( const void* pItem,
const OctreeAgentV& agent );
bool remove( const void* pItem,
const OctreeAgentV& agent );
/// queries --------------------------------------------------------------------
void visit( OctreeVisitorV& visitor ) const;
bool isEmpty() const;
void getInfo( dword rootWrapperByteSize,
dword& byteSize,
dword& leafCount,
dword& itemCount,
dword& maxDepth ) const;
const Vector3r& getPosition() const;
real getSize() const;
dword getMaxItemCountPerCell() const;
dword getMaxLevelCount() const;
real getMinCellSize() const;
/// statics --------------------------------------------------------------------
static void continueVisit( const OctreeCell* pRootCell,
const OctreeData& octreeData,
OctreeVisitorV& visitor );
/// fields ---------------------------------------------------------------------
private:
OctreeDimensions dimensions_m;
OctreeCell* pRootCell_m;
};
/**
* Abstract base for Composite types, for implementing Octree nodes.
*
* @implementation
* Subcell numbering:
* <pre>
* y z 6 7
* |/ 2 3 4 5
* -x 0 1
* </pre>
* in binary:
* <pre>
* y z 110 111
* |/ 010 011 100 101
* -x 000 001
* </pre>
*/
class OctreeCell
{
/// standard object services ---------------------------------------------------
protected:
OctreeCell() {}
public:
virtual ~OctreeCell() {}
private:
OctreeCell( const OctreeCell& );
OctreeCell& operator=( const OctreeCell& );
public:
/// commands -------------------------------------------------------------------
virtual void insert( const OctreeData& thisData,
OctreeCell*& pThis,
const void* pItem,
const OctreeAgentV& agent ) =0;
virtual bool remove( OctreeCell*& pThis,
const void* pItem,
const dword maxItemsPerCell,
dword& itemCount ) =0;
/// queries --------------------------------------------------------------------
virtual void visit( const OctreeData& thisData,
OctreeVisitorV& visitor ) const =0;
virtual OctreeCell* clone() const =0;
virtual void getInfo( dword& byteSize,
dword& leafCount,
dword& itemCount,
dword& maxDepth ) const =0;
/// statics --------------------------------------------------------------------
static OctreeCell* cloneNonZero( const OctreeCell* );
};
/**
* Inner node implementation of an octree cell.<br/><br/>
*
* Stores pointers to eight (at most) child cells.
*
* @invariants
* subCells_m elements can be null, or point to an OctreeCell instance.
*/
class OctreeBranch
: public OctreeCell
{
/// standard object services ---------------------------------------------------
public:
OctreeBranch();
OctreeBranch( const OctreeData& thisData,
const Array<const void*>& items,
const void* const pItem,
const OctreeAgentV& agent );
virtual ~OctreeBranch();
OctreeBranch( const OctreeBranch& );
OctreeBranch& operator=( const OctreeBranch& );
/// commands -------------------------------------------------------------------
virtual void insert( const OctreeData& thisData,
OctreeCell*& pThis,
const void* pItem,
const OctreeAgentV& agent );
virtual bool remove( OctreeCell*& pThis,
const void* pItem,
const dword maxItemsPerCell,
dword& itemCount );
/// queries --------------------------------------------------------------------
virtual void visit( const OctreeData& thisData,
OctreeVisitorV& visitor ) const;
virtual OctreeCell* clone() const;
virtual void getInfo( dword& byteSize,
dword& leafCount,
dword& itemCount,
dword& maxDepth ) const;
/// statics --------------------------------------------------------------------
static void continueVisit( const OctreeCell* subCells[8],
const OctreeData& octreeData,
dword subCellIndex,
OctreeVisitorV& visitor );
/// implementation -------------------------------------------------------------
protected:
virtual void zeroSubCells();
/// fields ---------------------------------------------------------------------
private:
OctreeCell* subCells_m[ 8 ];
};
/**
* Outer node implementation of an octree cell.<br/><br/>
*
* Stores pointers to items.
*/
class OctreeLeaf
: public OctreeCell
{
/// standard object services ---------------------------------------------------
public:
OctreeLeaf();
OctreeLeaf( const OctreeLeaf*const leafs[8] );
private:
explicit OctreeLeaf( const void* pItem );
public:
virtual ~OctreeLeaf();
OctreeLeaf( const OctreeLeaf& );
OctreeLeaf& operator=( const OctreeLeaf& );
/// commands -------------------------------------------------------------------
virtual void insert( const OctreeData& thisData,
OctreeCell*& pThis,
const void* pItem,
const OctreeAgentV& agent );
virtual bool remove( OctreeCell*& pThis,
const void* pItem,
const dword maxItemsPerCell,
dword& itemCount );
/// queries --------------------------------------------------------------------
virtual void visit( const OctreeData& thisData,
OctreeVisitorV& visitor ) const;
virtual OctreeCell* clone() const;
virtual void getInfo( dword& byteSize,
dword& leafCount,
dword& itemCount,
dword& maxDepth ) const;
/// statics --------------------------------------------------------------------
static void insertMaybeCreate( const OctreeData& cellData,
OctreeCell*& pCell,
const void* pItem,
const OctreeAgentV& agent );
/// fields ---------------------------------------------------------------------
private:
Array<const void*> items_m;
};
}//namespace
#endif//OctreeImplementation_h