do not generate vertexposition/vertexmesh arrays in
[divverent/darkplaces.git] / bspfile.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20
21
22 #define MAX_MAP_HULLS 16 // Q1BSP has 4, Hexen2 Q1BSP has 8, MCBSP has 16
23
24 //=============================================================================
25
26
27 #define BSPVERSION      29
28
29 typedef struct lump_s
30 {
31         int             fileofs, filelen;
32 } lump_t;
33
34 #define LUMP_ENTITIES   0
35 #define LUMP_PLANES             1
36 #define LUMP_TEXTURES   2
37 #define LUMP_VERTEXES   3
38 #define LUMP_VISIBILITY 4
39 #define LUMP_NODES              5
40 #define LUMP_TEXINFO    6
41 #define LUMP_FACES              7
42 #define LUMP_LIGHTING   8
43 #define LUMP_CLIPNODES  9
44 #define LUMP_LEAFS              10
45 #define LUMP_MARKSURFACES 11
46 #define LUMP_EDGES              12
47 #define LUMP_SURFEDGES  13
48 #define LUMP_MODELS             14
49 #define HEADER_LUMPS    15
50
51 typedef struct hullinfo_s
52 {
53         int                     filehulls;
54         float           hullsizes[MAX_MAP_HULLS][2][3];
55 } hullinfo_t;
56
57 // WARNING: this struct does NOT match q1bsp's disk format because MAX_MAP_HULLS has been changed by Sajt's MCBSP code, this struct is only being used in memory as a result
58 typedef struct dmodel_s
59 {
60         float           mins[3], maxs[3];
61         float           origin[3];
62         int                     headnode[MAX_MAP_HULLS];
63         int                     visleafs;               // not including the solid leaf 0
64         int                     firstface, numfaces;
65 } dmodel_t;
66
67 typedef struct dheader_s
68 {
69         int                     version;
70         lump_t          lumps[HEADER_LUMPS];
71 } dheader_t;
72
73 typedef struct dmiptexlump_s
74 {
75         int                     nummiptex;
76         int                     dataofs[4];             // [nummiptex]
77 } dmiptexlump_t;
78
79 #define MIPLEVELS       4
80 typedef struct miptex_s
81 {
82         char            name[16];
83         unsigned        width, height;
84         unsigned        offsets[MIPLEVELS];             // four mip maps stored
85 } miptex_t;
86
87
88 typedef struct dvertex_s
89 {
90         float   point[3];
91 } dvertex_t;
92
93
94 // 0-2 are axial planes
95 #define PLANE_X                 0
96 #define PLANE_Y                 1
97 #define PLANE_Z                 2
98
99 // 3-5 are non-axial planes snapped to the nearest
100 #define PLANE_ANYX              3
101 #define PLANE_ANYY              4
102 #define PLANE_ANYZ              5
103
104 typedef struct dplane_s
105 {
106         float   normal[3];
107         float   dist;
108         int             type;           // PLANE_X - PLANE_ANYZ ?remove? trivial to regenerate
109 } dplane_t;
110
111
112 // contents values in Q1 maps
113 #define CONTENTS_EMPTY                  -1
114 #define CONTENTS_SOLID                  -2
115 #define CONTENTS_WATER                  -3
116 #define CONTENTS_SLIME                  -4
117 #define CONTENTS_LAVA                           -5
118 #define CONTENTS_SKY                            -6
119 // these were #ifdef QUAKE2 in the quake source
120 #define CONTENTS_ORIGIN                 -7 // removed at csg time
121 #define CONTENTS_CLIP                           -8 // changed to contents_solid
122 #define CONTENTS_CURRENT_0              -9
123 #define CONTENTS_CURRENT_90             -10
124 #define CONTENTS_CURRENT_180            -11
125 #define CONTENTS_CURRENT_270            -12
126 #define CONTENTS_CURRENT_UP             -13
127 #define CONTENTS_CURRENT_DOWN           -14
128
129 //contents flags in Q2 maps
130 #define CONTENTSQ2_SOLID                        0x00000001 // an eye is never valid in a solid
131 #define CONTENTSQ2_WINDOW                       0x00000002 // translucent, but not watery
132 #define CONTENTSQ2_AUX                          0x00000004
133 #define CONTENTSQ2_LAVA                         0x00000008
134 #define CONTENTSQ2_SLIME                        0x00000010
135 #define CONTENTSQ2_WATER                        0x00000020
136 #define CONTENTSQ2_MIST                         0x00000040
137 #define CONTENTSQ2_AREAPORTAL           0x00008000
138 #define CONTENTSQ2_PLAYERCLIP           0x00010000
139 #define CONTENTSQ2_MONSTERCLIP          0x00020000
140 #define CONTENTSQ2_CURRENT_0            0x00040000
141 #define CONTENTSQ2_CURRENT_90           0x00080000
142 #define CONTENTSQ2_CURRENT_180          0x00100000
143 #define CONTENTSQ2_CURRENT_270          0x00200000
144 #define CONTENTSQ2_CURRENT_UP           0x00400000
145 #define CONTENTSQ2_CURRENT_DOWN         0x00800000
146 #define CONTENTSQ2_ORIGIN                       0x01000000 // removed before bsping an entity
147 #define CONTENTSQ2_MONSTER                      0x02000000 // should never be on a brush, only in game
148 #define CONTENTSQ2_DEADMONSTER          0x04000000
149 #define CONTENTSQ2_DETAIL                       0x08000000 // brushes to be added after vis leafs
150 #define CONTENTSQ2_TRANSLUCENT          0x10000000 // auto set if any surface has trans
151 #define CONTENTSQ2_LADDER                       0x20000000
152
153 //contents flags in Q3 maps
154 #define CONTENTSQ3_SOLID                        0x00000001 // solid (opaque and transparent)
155 #define CONTENTSQ3_LAVA                         0x00000008 // lava
156 #define CONTENTSQ3_SLIME                        0x00000010 // slime
157 #define CONTENTSQ3_WATER                        0x00000020 // water
158 #define CONTENTSQ3_FOG                          0x00000040 // unused?
159 #define CONTENTSQ3_AREAPORTAL           0x00008000 // areaportal (separates areas)
160 #define CONTENTSQ3_PLAYERCLIP           0x00010000 // block players
161 #define CONTENTSQ3_MONSTERCLIP          0x00020000 // block monsters
162 #define CONTENTSQ3_TELEPORTER           0x00040000 // hint for Q3's bots
163 #define CONTENTSQ3_JUMPPAD                      0x00080000 // hint for Q3's bots
164 #define CONTENTSQ3_CLUSTERPORTAL        0x00100000 // hint for Q3's bots
165 #define CONTENTSQ3_DONOTENTER           0x00200000 // hint for Q3's bots
166 #define CONTENTSQ3_BOTCLIP                      0x00400000 // hint for Q3's bots
167 #define CONTENTSQ3_ORIGIN                       0x01000000 // used by origin brushes to indicate origin of bmodel (removed by map compiler)
168 #define CONTENTSQ3_BODY                         0x02000000 // used by bbox entities (should never be on a brush)
169 #define CONTENTSQ3_CORPSE                       0x04000000 // used by dead bodies (SOLID_CORPSE in darkplaces)
170 #define CONTENTSQ3_DETAIL                       0x08000000 // brushes that do not split the bsp tree (decorations)
171 #define CONTENTSQ3_STRUCTURAL           0x10000000 // brushes that split the bsp tree
172 #define CONTENTSQ3_TRANSLUCENT          0x20000000 // leaves surfaces that are inside for rendering
173 #define CONTENTSQ3_TRIGGER                      0x40000000 // used by trigger entities
174 #define CONTENTSQ3_NODROP                       0x80000000 // remove items that fall into this brush
175
176 #define SUPERCONTENTS_SOLID                     0x00000001
177 #define SUPERCONTENTS_WATER                     0x00000002
178 #define SUPERCONTENTS_SLIME                     0x00000004
179 #define SUPERCONTENTS_LAVA                      0x00000008
180 #define SUPERCONTENTS_SKY                       0x00000010
181 #define SUPERCONTENTS_BODY                      0x00000020
182 #define SUPERCONTENTS_CORPSE            0x00000040
183 #define SUPERCONTENTS_NODROP            0x00000080
184 #define SUPERCONTENTS_PLAYERCLIP        0x00000100
185 #define SUPERCONTENTS_MONSTERCLIP       0x00000200
186 #define SUPERCONTENTS_DONOTENTER        0x00000400
187 #define SUPERCONTENTS_BOTCLIP           0x00000800
188 #define SUPERCONTENTS_OPAQUE            0x00001000
189 // TODO: is there any reason to define:
190 //   fog?
191 //   areaportal?
192 //   teleporter?
193 //   jumppad?
194 //   clusterportal?
195 //   detail?         (div0) no, game code should not be allowed to differentiate between structural and detail
196 //   structural?     (div0) no, game code should not be allowed to differentiate between structural and detail
197 //   trigger?        (div0) no, as these are always solid anyway, and that's all that matters for trigger brushes
198 #define SUPERCONTENTS_LIQUIDSMASK       (SUPERCONTENTS_LAVA | SUPERCONTENTS_SLIME | SUPERCONTENTS_WATER)
199 #define SUPERCONTENTS_VISBLOCKERMASK    SUPERCONTENTS_OPAQUE
200
201 /*
202 #define SUPERCONTENTS_DEADMONSTER       0x00000000
203 #define SUPERCONTENTS_CURRENT_0         0x00000000
204 #define SUPERCONTENTS_CURRENT_90        0x00000000
205 #define SUPERCONTENTS_CURRENT_180       0x00000000
206 #define SUPERCONTENTS_CURRENT_270       0x00000000
207 #define SUPERCONTENTS_CURRENT_DOWN      0x00000000
208 #define SUPERCONTENTS_CURRENT_UP        0x00000000
209 #define SUPERCONTENTS_AREAPORTAL        0x00000000
210 #define SUPERCONTENTS_AUX                       0x00000000
211 #define SUPERCONTENTS_CLUSTERPORTAL     0x00000000
212 #define SUPERCONTENTS_DETAIL            0x00000000
213 #define SUPERCONTENTS_STRUCTURAL        0x00000000
214 #define SUPERCONTENTS_DONOTENTER        0x00000000
215 #define SUPERCONTENTS_JUMPPAD           0x00000000
216 #define SUPERCONTENTS_LADDER            0x00000000
217 #define SUPERCONTENTS_MONSTER           0x00000000
218 #define SUPERCONTENTS_MONSTERCLIP       0x00000000
219 #define SUPERCONTENTS_PLAYERCLIP        0x00000000
220 #define SUPERCONTENTS_TELEPORTER        0x00000000
221 #define SUPERCONTENTS_TRANSLUCENT       0x00000000
222 #define SUPERCONTENTS_TRIGGER           0x00000000
223 #define SUPERCONTENTS_WINDOW            0x00000000
224 */
225
226
227 typedef struct dnode_s
228 {
229         int                     planenum;
230         short           children[2];    // negative numbers are -(leafs+1), not nodes
231         short           mins[3];                // for sphere culling
232         short           maxs[3];
233         unsigned short  firstface;
234         unsigned short  numfaces;       // counting both sides
235 } dnode_t;
236
237 typedef struct dclipnode_s
238 {
239         int                     planenum;
240         short           children[2];    // negative numbers are contents
241 } dclipnode_t;
242
243
244 typedef struct texinfo_s
245 {
246         float           vecs[2][4];             // [s/t][xyz offset]
247         int                     miptex;
248         int                     flags;
249 } texinfo_t;
250 #define TEX_SPECIAL             1               // sky or slime, no lightmap or 256 subdivision
251
252 // note that edge 0 is never used, because negative edge nums are used for
253 // counterclockwise use of the edge in a face
254 typedef struct dedge_s
255 {
256         unsigned short  v[2];           // vertex numbers
257 } dedge_t;
258
259 #define MAXLIGHTMAPS    4
260 typedef struct dface_s
261 {
262         // LordHavoc: changed from short to unsigned short for q2 support
263         unsigned short  planenum;
264         short           side;
265
266         int                     firstedge;              // we must support > 64k edges
267         short           numedges;
268         short           texinfo;
269
270 // lighting info
271         unsigned char           styles[MAXLIGHTMAPS];
272         int                     lightofs;               // start of [numstyles*surfsize] samples
273 } dface_t;
274
275
276
277 #define AMBIENT_WATER   0
278 #define AMBIENT_SKY             1
279 #define AMBIENT_SLIME   2
280 #define AMBIENT_LAVA    3
281
282 #define NUM_AMBIENTS                    4               // automatic ambient sounds
283
284 // leaf 0 is the generic CONTENTS_SOLID leaf, used for all solid areas
285 // all other leafs need visibility info
286 typedef struct dleaf_s
287 {
288         int                     contents;
289         int                     visofs;                         // -1 = no visibility info
290
291         short           mins[3];                        // for frustum culling
292         short           maxs[3];
293
294         unsigned short          firstmarksurface;
295         unsigned short          nummarksurfaces;
296
297         unsigned char           ambient_level[NUM_AMBIENTS];
298 } dleaf_t;
299