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