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