/
bspleaf.h
299 lines (253 loc) · 9.01 KB
/
bspleaf.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
/** @file world/bspleaf.h World BSP Leaf.
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. This program is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
* Public License for more details. You should have received a copy of the GNU
* General Public License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/
#ifndef DENG_WORLD_BSPLEAF_H
#define DENG_WORLD_BSPLEAF_H
#include <QList>
#include <de/Error>
#include <de/Vector>
#include "MapElement"
#include "Line"
#include "Mesh"
class Sector;
class Segment;
struct polyobj_s;
#ifdef __CLIENT__
struct BiasSurface;
struct ShadowLink;
#endif
/**
* Represents a leaf in the map's binary space partition (BSP) tree. Each leaf
* defines a two dimensioned convex subspace region (which, may be represented
* by a face (polygon) in the map's half-edge @ref Mesh geometry).
*
* On client side a leaf also provides / links to various geometry data assets
* and properties used to visualize the subspace.
*
* Each leaf is attributed to a @ref Sector in the map (with the exception of
* wholly degenerate subspaces which may occur during the partitioning process).
*
* @see http://en.wikipedia.org/wiki/Binary_space_partitioning
*
* @ingroup world
*/
class BspLeaf : public de::MapElement
{
public:
/// An invalid polygon was specified @ingroup errors
DENG2_ERROR(InvalidPolygonError);
/// Required face geometry is missing. @ingroup errors
DENG2_ERROR(MissingFaceError);
/// Required sector attribution is missing. @ingroup errors
DENG2_ERROR(MissingSectorError);
#ifdef __CLIENT__
/// The referenced geometry group does not exist. @ingroup errors
DENG2_ERROR(UnknownGeometryGroupError);
#endif
typedef QList<Segment *> Segments;
public: /// @todo Make private:
#ifdef __CLIENT__
ShadowLink *_shadows;
uint _reverb[NUM_REVERB_DATA];
#endif // __CLIENT__
public:
/**
* Construct a new BSP leaf and optionally attribute it to @a sector.
* Ownership is unaffected.
*/
explicit BspLeaf(Sector *sector = 0);
/**
* Returns @c true iff the BSP leaf is "degenerate", which is to say there
* is no convex Polygon assigned to it.
*
* Equivalent to @code !hasFace() @endcode
*/
inline bool isDegenerate() const { return !hasFace(); }
/**
* Determines whether a convex face geometry (a polygon) is assigned.
*
* @see face(), setFace()
*/
bool hasFace() const;
/**
* Provides access to the assigned convex face geometry (a polygon).
*
* @see hasFace(), assignPoly()
*/
de::Face const &face() const;
/**
* Change the convex face geometry assigned to the BSP leaf. Before the
* geometry is accepted it is first conformance tested to ensure that it
* represents a valid, simple convex polygon.
*
* @param polygon New polygon to be assigned to the BSP leaf. Ownership
* of the polygon is given to the BspLeaf if it passes all
* conformance checks.
*
* @see hasFace(), face()
*/
void assignPoly(de::Mesh *polygon);
/**
* Assign an additional mesh geometry to the BSP leaf. Such @em extra
* meshes are used to represent geometry which would otherwise result in a
* non-manifold mesh if incorporated in the primary mesh for the map.
*
* @param mesh New mesh to be assigned to the BSP leaf. Ownership of the
* mesh is given to the BspLeaf.
*/
void assignExtraMesh(de::Mesh &mesh);
/**
* Provides a clockwise ordered list of all the line segments which comprise
* the convex face geometry (a polygon) assigned to the BSP leaf.
*
* @see allSegments(), assignPoly()
*/
Segments const &clockwiseSegments() const;
/**
* Provides a list of all the line segments from the convex face geometry
* and any @em extra meshes assigned to the BSP leaf.
*
* @see clockwiseSegments(), assignExtraMesh()
*/
Segments const &allSegments() const;
/**
* Returns @c true iff a sector is attributed to the BSP leaf. The only
* time a leaf might not be attributed to a sector is if the map geometry
* was @em orphaned by the partitioning algorithm (a bug).
*/
bool hasSector() const;
/**
* Returns the sector attributed to the BSP leaf.
*
* @see hasSector()
*/
Sector §or() const;
/**
* Returns a pointer to the sector attributed to the BSP leaf; otherwise @c 0.
*
* @see hasSector()
*/
inline Sector *sectorPtr() const { return hasSector()? §or() : 0; }
/**
* Change the sector attributed to the BSP leaf.
*
* @param newSector New sector to be attributed. Ownership is unaffected.
* Can be @c 0 (to clear the attribution).
*
* @todo Refactor away.
*/
void setSector(Sector *newSector);
/**
* Determines whether the BSP leaf has a positive world volume. For this
* to be true the following criteria must be met:
*
* - The polygon geometry is @em not degenerate (see @ref isDegenerate()).
* - A sector is attributed (see @ref hasSector())
* - The height of floor is lower than that of the ceiling plane for the
* attributed sector.
*
* @param useVisualHeights @c true= use the visual (i.e., smoothed) plane
* heights instead of the @em sharp heights.
*/
bool hasWorldVolume(bool useVisualHeights = true) const;
/**
* Returns @c true iff at least one polyobj is linked to the BSP leaf.
*/
inline bool hasPolyobj() { return firstPolyobj() != 0; }
/**
* Returns a pointer to the first polyobj linked to the BSP leaf; otherwise @c 0.
*/
struct polyobj_s *firstPolyobj() const;
/**
* Change the first polyobj linked to the BSP leaf.
*
* @param newPolyobj New polyobj to be attributed. Ownership is unaffected.
* Can be @c 0 (to clear the attribution).
*/
void setFirstPolyobj(struct polyobj_s *newPolyobj);
/**
* Returns the vector described by the offset from the map coordinate space
* origin to the top most, left most point of the geometry of the BSP leaf.
*
* @see aaBox()
*/
de::Vector2d const &worldGridOffset() const;
/**
* Returns the @em validCount of the BSP leaf. Used by some legacy iteration
* algorithms for marking leafs as processed/visited.
*
* @todo Refactor away.
*/
int validCount() const;
/// @todo Refactor away.
void setValidCount(int newValidCount);
#ifdef __CLIENT__
/**
* Returns a pointer to the face geometry half-edge which has been chosen
* for use as the base for a triangle fan GL primitive. May return @c 0 if
* no suitable base was determined.
*/
de::HEdge *fanBase() const;
/**
* Returns the number of vertices needed for a triangle fan GL primitive.
*
* @note When first called after a face geometry is assigned a new 'base'
* half-edge for the triangle fan primitive will be determined.
*
* @see fanBase()
*/
int numFanVertices() const;
/**
* Retrieve the bias surface for specified geometry @a group.
*
* @param group Geometry group identifier for the bias surface.
*/
BiasSurface &biasSurface(int group);
/**
* Assign a new bias surface to the specified geometry @a group.
*
* @param group Geometry group identifier for the surface.
* @param biasSurface New BiasSurface for the identified @a group. Any
* existing bias surface will be replaced (destroyed).
* Ownership is given to the BSP leaf.
*/
void setBiasSurface(int group, BiasSurface *biasSurface);
/**
* Returns a pointer to the first ShadowLink; otherwise @c 0.
*/
ShadowLink *firstShadowLink() const;
/**
* Returns the frame number of the last time mobj sprite projection was
* performed for the BSP leaf.
*/
int addSpriteCount() const;
/**
* Change the frame number of the last time mobj sprite projection was
* performed for the BSP leaf.
*
* @param newFrameCount New frame number.
*/
void setAddSpriteCount(int newFrameCount);
#endif // __CLIENT__
protected:
int property(setargs_t &args) const;
private:
DENG2_PRIVATE(d)
};
#endif // DENG_WORLD_BSPLEAF_H