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