added mleaf_t->containscollisionsurfaces variable which indicates if the leafsurfaces...
[divverent/darkplaces.git] / model_brush.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 #ifndef MODEL_BRUSH_H
22 #define MODEL_BRUSH_H
23
24 /*
25 ==============================================================================
26
27 BRUSH MODELS
28
29 ==============================================================================
30 */
31
32 #define Q3PATHLENGTH 64
33
34
35 //
36 // in memory representation
37 //
38 typedef struct mvertex_s
39 {
40         vec3_t position;
41 }
42 mvertex_t;
43
44 #define SIDE_FRONT 0
45 #define SIDE_BACK 1
46 #define SIDE_ON 2
47
48
49 // plane_t structure
50 typedef struct mplane_s
51 {
52         vec3_t normal;
53         float dist;
54         // for texture axis selection and fast side tests
55         int type;
56         int signbits;
57 }
58 mplane_t;
59
60 #define SHADERSTAGE_SKY 0
61 #define SHADERSTAGE_NORMAL 1
62 #define SHADERSTAGE_COUNT 2
63
64 //#define SURF_PLANEBACK 2
65
66 // set for anything to be transparent sorted
67 #define MATERIALFLAG_TRANSPARENT 1
68 // use alpha blend on this material
69 #define MATERIALFLAG_ALPHA 2
70 // use additive blend on this material
71 #define MATERIALFLAG_ADD 4
72 // turn off depth test on this material
73 #define MATERIALFLAG_NODEPTHTEST 8
74 // multiply alpha by r_wateralpha cvar
75 #define MATERIALFLAG_WATERALPHA 16
76 // draw with no lighting
77 #define MATERIALFLAG_FULLBRIGHT 32
78 // drawn as a normal lightmapped wall
79 #define MATERIALFLAG_WALL 64
80 // swirling water effect
81 #define MATERIALFLAG_WATER 128
82 // this surface shows the sky
83 // skipped if transparent
84 #define MATERIALFLAG_SKY 256
85 // skips drawing the surface
86 #define MATERIALFLAG_NODRAW 512
87 // probably used only on q1bsp water
88 #define MATERIALFLAG_LIGHTBOTHSIDES 1024
89 // use alpha test on this material
90 #define MATERIALFLAG_ALPHATEST 2048
91 // treat this material as a blended transparency (as opposed to an alpha test
92 // transparency), this causes special fog behavior, and disables glDepthMask
93 #define MATERIALFLAG_BLENDED 4096
94 // render using a custom blendfunc
95 #define MATERIALFLAG_CUSTOMBLEND 8192
96 // do not cast shadows from this material
97 #define MATERIALFLAG_NOSHADOW 16384
98 // render using vertex alpha (q3bsp) as texture blend parameter between foreground (normal) skinframe and background skinframe
99 #define MATERIALFLAG_VERTEXTEXTUREBLEND 32768
100
101 typedef struct medge_s
102 {
103         unsigned short v[2];
104 }
105 medge_t;
106
107 struct entity_render_s;
108 struct texture_s;
109 struct msurface_s;
110
111 typedef struct mnode_s
112 {
113         //this part shared between node and leaf
114         mplane_t *plane; // != NULL
115         struct mnode_s *parent;
116         struct mportal_s *portals;
117         // for bounding box culling
118         vec3_t mins;
119         vec3_t maxs;
120         // supercontents from all brushes inside this node or leaf
121         int combinedsupercontents;
122
123         // this part unique to node
124         struct mnode_s *children[2];
125
126         // q1bsp specific
127         unsigned short firstsurface;
128         unsigned short numsurfaces;
129 }
130 mnode_t;
131
132 typedef struct mleaf_s
133 {
134         //this part shared between node and leaf
135         mplane_t *plane; // == NULL
136         struct mnode_s *parent;
137         struct mportal_s *portals;
138         // for bounding box culling
139         vec3_t mins;
140         vec3_t maxs;
141         // supercontents from all brushes inside this node or leaf
142         int combinedsupercontents;
143
144         // this part unique to leaf
145         // common
146         int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
147         int areaindex; // q3bsp
148         int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
149         int numleafsurfaces;
150         int *firstleafsurface;
151         int numleafbrushes; // q3bsp
152         int *firstleafbrush; // q3bsp
153         unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
154         int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
155         int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
156 }
157 mleaf_t;
158
159 typedef struct hull_s
160 {
161         dclipnode_t *clipnodes;
162         mplane_t *planes;
163         int firstclipnode;
164         int lastclipnode;
165         vec3_t clip_mins;
166         vec3_t clip_maxs;
167         vec3_t clip_size;
168 }
169 hull_t;
170
171 typedef struct mportal_s
172 {
173         struct mportal_s *next; // the next portal on this leaf
174         mleaf_t *here; // the leaf this portal is on
175         mleaf_t *past; // the leaf through this portal (infront)
176         int numpoints;
177         mvertex_t *points;
178         vec3_t mins, maxs; // culling
179         mplane_t plane;
180 }
181 mportal_t;
182
183 typedef struct svbspmesh_s
184 {
185         struct svbspmesh_s *next;
186         int numverts, maxverts;
187         int numtriangles, maxtriangles;
188         float *verts;
189         int *elements;
190 }
191 svbspmesh_t;
192
193 // Q2 bsp stuff
194
195 #define Q2BSPVERSION    38
196
197 // leaffaces, leafbrushes, planes, and verts are still bounded by
198 // 16 bit short limits
199
200 //=============================================================================
201
202 #define Q2LUMP_ENTITIES         0
203 #define Q2LUMP_PLANES                   1
204 #define Q2LUMP_VERTEXES         2
205 #define Q2LUMP_VISIBILITY               3
206 #define Q2LUMP_NODES                    4
207 #define Q2LUMP_TEXINFO          5
208 #define Q2LUMP_FACES                    6
209 #define Q2LUMP_LIGHTING         7
210 #define Q2LUMP_LEAFS                    8
211 #define Q2LUMP_LEAFFACES                9
212 #define Q2LUMP_LEAFBRUSHES      10
213 #define Q2LUMP_EDGES                    11
214 #define Q2LUMP_SURFEDGES                12
215 #define Q2LUMP_MODELS                   13
216 #define Q2LUMP_BRUSHES          14
217 #define Q2LUMP_BRUSHSIDES               15
218 #define Q2LUMP_POP                      16
219 #define Q2LUMP_AREAS                    17
220 #define Q2LUMP_AREAPORTALS      18
221 #define Q2HEADER_LUMPS          19
222
223 typedef struct q2dheader_s
224 {
225         int                     ident;
226         int                     version;
227         lump_t          lumps[Q2HEADER_LUMPS];
228 } q2dheader_t;
229
230 typedef struct q2dmodel_s
231 {
232         float           mins[3], maxs[3];
233         float           origin[3];              // for sounds or lights
234         int                     headnode;
235         int                     firstface, numfaces;    // submodels just draw faces
236                                                                                 // without walking the bsp tree
237 } q2dmodel_t;
238
239 // planes (x&~1) and (x&~1)+1 are always opposites
240
241 // contents flags are seperate bits
242 // a given brush can contribute multiple content bits
243 // multiple brushes can be in a single leaf
244
245 // these definitions also need to be in q_shared.h!
246
247 // lower bits are stronger, and will eat weaker brushes completely
248 #define Q2CONTENTS_SOLID                        1               // an eye is never valid in a solid
249 #define Q2CONTENTS_WINDOW                       2               // translucent, but not watery
250 #define Q2CONTENTS_AUX                  4
251 #define Q2CONTENTS_LAVA                 8
252 #define Q2CONTENTS_SLIME                        16
253 #define Q2CONTENTS_WATER                        32
254 #define Q2CONTENTS_MIST                 64
255 #define Q2LAST_VISIBLE_CONTENTS 64
256
257 // remaining contents are non-visible, and don't eat brushes
258
259 #define Q2CONTENTS_AREAPORTAL           0x8000
260
261 #define Q2CONTENTS_PLAYERCLIP           0x10000
262 #define Q2CONTENTS_MONSTERCLIP  0x20000
263
264 // currents can be added to any other contents, and may be mixed
265 #define Q2CONTENTS_CURRENT_0            0x40000
266 #define Q2CONTENTS_CURRENT_90           0x80000
267 #define Q2CONTENTS_CURRENT_180  0x100000
268 #define Q2CONTENTS_CURRENT_270  0x200000
269 #define Q2CONTENTS_CURRENT_UP           0x400000
270 #define Q2CONTENTS_CURRENT_DOWN 0x800000
271
272 #define Q2CONTENTS_ORIGIN                       0x1000000       // removed before bsping an entity
273
274 #define Q2CONTENTS_MONSTER              0x2000000       // should never be on a brush, only in game
275 #define Q2CONTENTS_DEADMONSTER  0x4000000
276 #define Q2CONTENTS_DETAIL                       0x8000000       // brushes to be added after vis leafs
277 #define Q2CONTENTS_TRANSLUCENT  0x10000000      // auto set if any surface has trans
278 #define Q2CONTENTS_LADDER                       0x20000000
279
280
281
282 #define Q2SURF_LIGHT            0x1             // value will hold the light strength
283
284 #define Q2SURF_SLICK            0x2             // effects game physics
285
286 #define Q2SURF_SKY              0x4             // don't draw, but add to skybox
287 #define Q2SURF_WARP             0x8             // turbulent water warp
288 #define Q2SURF_TRANS33  0x10
289 #define Q2SURF_TRANS66  0x20
290 #define Q2SURF_FLOWING  0x40    // scroll towards angle
291 #define Q2SURF_NODRAW           0x80    // don't bother referencing the texture
292
293
294
295
296 typedef struct q2dnode_s
297 {
298         int                     planenum;
299         int                     children[2];    // negative numbers are -(leafs+1), not nodes
300         short           mins[3];                // for frustom culling
301         short           maxs[3];
302         unsigned short  firstface;
303         unsigned short  numfaces;       // counting both sides
304 } q2dnode_t;
305
306
307 typedef struct q2texinfo_s
308 {
309         float           vecs[2][4];             // [s/t][xyz offset]
310         int                     flags;                  // miptex flags + overrides
311         int                     value;                  // light emission, etc
312         char            texture[32];    // texture name (textures/*.wal)
313         int                     nexttexinfo;    // for animations, -1 = end of chain
314 } q2texinfo_t;
315
316 typedef struct q2dleaf_s
317 {
318         int                             contents;                       // OR of all brushes (not needed?)
319
320         short                   cluster;
321         short                   area;
322
323         short                   mins[3];                        // for frustum culling
324         short                   maxs[3];
325
326         unsigned short  firstleafface;
327         unsigned short  numleaffaces;
328
329         unsigned short  firstleafbrush;
330         unsigned short  numleafbrushes;
331 } q2dleaf_t;
332
333 typedef struct q2dbrushside_s
334 {
335         unsigned short  planenum;               // facing out of the leaf
336         short   texinfo;
337 } q2dbrushside_t;
338
339 typedef struct q2dbrush_s
340 {
341         int                     firstside;
342         int                     numsides;
343         int                     contents;
344 } q2dbrush_t;
345
346
347 // the visibility lump consists of a header with a count, then
348 // byte offsets for the PVS and PHS of each cluster, then the raw
349 // compressed bit vectors
350 #define Q2DVIS_PVS      0
351 #define Q2DVIS_PHS      1
352 typedef struct q2dvis_s
353 {
354         int                     numclusters;
355         int                     bitofs[8][2];   // bitofs[numclusters][2]
356 } q2dvis_t;
357
358 // each area has a list of portals that lead into other areas
359 // when portals are closed, other areas may not be visible or
360 // hearable even if the vis info says that it should be
361 typedef struct q2dareaportal_s
362 {
363         int             portalnum;
364         int             otherarea;
365 } q2dareaportal_t;
366
367 typedef struct q2darea_s
368 {
369         int             numareaportals;
370         int             firstareaportal;
371 } q2darea_t;
372
373
374 //Q3 bsp stuff
375
376 #define Q3BSPVERSION    46
377
378 #define Q3LUMP_ENTITIES         0 // entities to spawn (used by server and client)
379 #define Q3LUMP_TEXTURES         1 // textures used (used by faces)
380 #define Q3LUMP_PLANES           2 // planes used (used by bsp nodes)
381 #define Q3LUMP_NODES            3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
382 #define Q3LUMP_LEAFS            4 // bsp leafs (used by bsp nodes)
383 #define Q3LUMP_LEAFFACES        5 // array of ints indexing faces (used by leafs)
384 #define Q3LUMP_LEAFBRUSHES      6 // array of ints indexing brushes (used by leafs)
385 #define Q3LUMP_MODELS           7 // models (used by rendering, collisions)
386 #define Q3LUMP_BRUSHES          8 // brushes (used by effects, collisions)
387 #define Q3LUMP_BRUSHSIDES       9 // brush faces (used by brushes)
388 #define Q3LUMP_VERTICES         10 // mesh vertices (used by faces)
389 #define Q3LUMP_TRIANGLES        11 // mesh triangles (used by faces)
390 #define Q3LUMP_EFFECTS          12 // fog (used by faces)
391 #define Q3LUMP_FACES            13 // surfaces (used by leafs)
392 #define Q3LUMP_LIGHTMAPS        14 // lightmap textures (used by faces)
393 #define Q3LUMP_LIGHTGRID        15 // lighting as a voxel grid (used by rendering)
394 #define Q3LUMP_PVS                      16 // potentially visible set; bit[clusters][clusters] (used by rendering)
395 #define Q3HEADER_LUMPS          17
396
397 typedef struct q3dheader_s
398 {
399         int                     ident;
400         int                     version;
401         lump_t          lumps[Q3HEADER_LUMPS];
402 } q3dheader_t;
403
404 typedef struct q3dtexture_s
405 {
406         char name[Q3PATHLENGTH];
407         int surfaceflags;
408         int contents;
409 }
410 q3dtexture_t;
411
412 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
413 typedef struct q3dplane_s
414 {
415         float normal[3];
416         float dist;
417 }
418 q3dplane_t;
419
420 typedef struct q3dnode_s
421 {
422         int planeindex;
423         int childrenindex[2];
424         int mins[3];
425         int maxs[3];
426 }
427 q3dnode_t;
428
429 typedef struct q3dleaf_s
430 {
431         int clusterindex; // pvs index
432         int areaindex; // area index
433         int mins[3];
434         int maxs[3];
435         int firstleafface;
436         int numleaffaces;
437         int firstleafbrush;
438         int numleafbrushes;
439 }
440 q3dleaf_t;
441
442 typedef struct q3dmodel_s
443 {
444         float mins[3];
445         float maxs[3];
446         int firstface;
447         int numfaces;
448         int firstbrush;
449         int numbrushes;
450 }
451 q3dmodel_t;
452
453 typedef struct q3dbrush_s
454 {
455         int firstbrushside;
456         int numbrushsides;
457         int textureindex;
458 }
459 q3dbrush_t;
460
461 typedef struct q3dbrushside_s
462 {
463         int planeindex;
464         int textureindex;
465 }
466 q3dbrushside_t;
467
468 typedef struct q3dvertex_s
469 {
470         float origin3f[3];
471         float texcoord2f[2];
472         float lightmap2f[2];
473         float normal3f[3];
474         unsigned char color4ub[4];
475 }
476 q3dvertex_t;
477
478 typedef struct q3dmeshvertex_s
479 {
480         int offset; // first vertex index of mesh
481 }
482 q3dmeshvertex_t;
483
484 typedef struct q3deffect_s
485 {
486         char shadername[Q3PATHLENGTH];
487         int brushindex;
488         int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
489 }
490 q3deffect_t;
491
492 #define Q3FACETYPE_POLYGON 1 // common
493 #define Q3FACETYPE_PATCH 2 // common
494 #define Q3FACETYPE_MESH 3 // common
495 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
496
497 typedef struct q3dface_s
498 {
499         int textureindex;
500         int effectindex; // -1 if none
501         int type; // Q3FACETYPE
502         int firstvertex;
503         int numvertices;
504         int firstelement;
505         int numelements;
506         int lightmapindex; // -1 if none
507         int lightmap_base[2];
508         int lightmap_size[2];
509         union
510         {
511                 struct
512                 {
513                         // corrupt or don't care
514                         int blah[14];
515                 }
516                 unknown;
517                 struct
518                 {
519                         // Q3FACETYPE_POLYGON
520                         // polygon is simply a convex polygon, renderable as a mesh
521                         float lightmap_origin[3];
522                         float lightmap_vectors[2][3];
523                         float normal[3];
524                         int unused1[2];
525                 }
526                 polygon;
527                 struct
528                 {
529                         // Q3FACETYPE_PATCH
530                         // patch renders as a bezier mesh, with adjustable tesselation
531                         // level (optionally based on LOD using the bbox and polygon
532                         // count to choose a tesselation level)
533                         // note: multiple patches may have the same bbox to cause them to
534                         // be LOD adjusted together as a group
535                         int unused1[3];
536                         float mins[3]; // LOD bbox
537                         float maxs[3]; // LOD bbox
538                         int unused2[3];
539                         int patchsize[2]; // dimensions of vertex grid
540                 }
541                 patch;
542                 struct
543                 {
544                         // Q3FACETYPE_MESH
545                         // mesh renders as simply a triangle mesh
546                         int unused1[3];
547                         float mins[3];
548                         float maxs[3];
549                         int unused2[5];
550                 }
551                 mesh;
552                 struct
553                 {
554                         // Q3FACETYPE_FLARE
555                         // flare renders as a simple sprite at origin, no geometry
556                         // exists, nor does it have a radius, a cvar controls the radius
557                         // and another cvar controls distance fade
558                         // (they were not used in Q3 I'm told)
559                         float origin[3];
560                         int unused1[11];
561                 }
562                 flare;
563         }
564         specific;
565 }
566 q3dface_t;
567
568 typedef struct q3dlightmap_s
569 {
570         unsigned char rgb[128*128*3];
571 }
572 q3dlightmap_t;
573
574 typedef struct q3dlightgrid_s
575 {
576         unsigned char ambientrgb[3];
577         unsigned char diffusergb[3];
578         unsigned char diffusepitch;
579         unsigned char diffuseyaw;
580 }
581 q3dlightgrid_t;
582
583 typedef struct q3dpvs_s
584 {
585         int numclusters;
586         int chainlength;
587         // unsigned char chains[];
588         // containing bits in 0-7 order (not 7-0 order),
589         // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
590 }
591 q3dpvs_t;
592
593 // surfaceflags from bsp
594 #define Q3SURFACEFLAG_NODAMAGE 1
595 #define Q3SURFACEFLAG_SLICK 2
596 #define Q3SURFACEFLAG_SKY 4
597 #define Q3SURFACEFLAG_LADDER 8
598 #define Q3SURFACEFLAG_NOIMPACT 16
599 #define Q3SURFACEFLAG_NOMARKS 32
600 #define Q3SURFACEFLAG_FLESH 64
601 #define Q3SURFACEFLAG_NODRAW 128
602 #define Q3SURFACEFLAG_HINT 256
603 #define Q3SURFACEFLAG_SKIP 512
604 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
605 #define Q3SURFACEFLAG_POINTLIGHT 2048
606 #define Q3SURFACEFLAG_METALSTEPS 4096
607 #define Q3SURFACEFLAG_NOSTEPS 8192
608 #define Q3SURFACEFLAG_NONSOLID 16384
609 #define Q3SURFACEFLAG_LIGHTFILTER 32768
610 #define Q3SURFACEFLAG_ALPHASHADOW 65536
611 #define Q3SURFACEFLAG_NODLIGHT 131072
612 #define Q3SURFACEFLAG_DUST 262144
613
614 // surfaceparms from shaders
615 #define Q3SURFACEPARM_ALPHASHADOW 1
616 #define Q3SURFACEPARM_AREAPORTAL 2
617 #define Q3SURFACEPARM_CLUSTERPORTAL 4
618 #define Q3SURFACEPARM_DETAIL 8
619 #define Q3SURFACEPARM_DONOTENTER 16
620 #define Q3SURFACEPARM_FOG 32
621 #define Q3SURFACEPARM_LAVA 64
622 #define Q3SURFACEPARM_LIGHTFILTER 128
623 #define Q3SURFACEPARM_METALSTEPS 256
624 #define Q3SURFACEPARM_NODAMAGE 512
625 #define Q3SURFACEPARM_NODLIGHT 1024
626 #define Q3SURFACEPARM_NODRAW 2048
627 #define Q3SURFACEPARM_NODROP 4096
628 #define Q3SURFACEPARM_NOIMPACT 8192
629 #define Q3SURFACEPARM_NOLIGHTMAP 16384
630 #define Q3SURFACEPARM_NOMARKS 32768
631 #define Q3SURFACEPARM_NOMIPMAPS 65536
632 #define Q3SURFACEPARM_NONSOLID 131072
633 #define Q3SURFACEPARM_ORIGIN 262144
634 #define Q3SURFACEPARM_PLAYERCLIP 524288
635 #define Q3SURFACEPARM_SKY 1048576
636 #define Q3SURFACEPARM_SLICK 2197152
637 #define Q3SURFACEPARM_SLIME 4194304
638 #define Q3SURFACEPARM_STRUCTURAL 8388608
639 #define Q3SURFACEPARM_TRANS 16777216
640 #define Q3SURFACEPARM_WATER 33554432
641 #define Q3SURFACEPARM_POINTLIGHT 67108864
642 #define Q3SURFACEPARM_HINT 134217728
643 #define Q3SURFACEPARM_DUST 268435456
644 #define Q3SURFACEPARM_BOTCLIP 536870912
645 #define Q3SURFACEPARM_LIGHTGRID 1073741824
646 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
647
648 // various flags from shaders, used for special effects not otherwise classified
649 #define Q3TEXTUREFLAG_TWOSIDED 1
650 #define Q3TEXTUREFLAG_AUTOSPRITE 2
651 #define Q3TEXTUREFLAG_AUTOSPRITE2 4
652 #define Q3TEXTUREFLAG_NOPICMIP 16
653
654 typedef struct q3mbrush_s
655 {
656         struct colbrushf_s *colbrushf;
657         int numbrushsides;
658         struct q3mbrushside_s *firstbrushside;
659         struct texture_s *texture;
660 }
661 q3mbrush_t;
662
663 typedef struct q3mbrushside_s
664 {
665         struct mplane_s *plane;
666         struct texture_s *texture;
667 }
668 q3mbrushside_t;
669
670 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
671 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
672 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)
673
674 #endif
675