more hackish cleanups of PVS stuff, now decompresses the PVS data at load and this...
[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
33 //
34 // in memory representation
35 //
36 typedef struct
37 {
38         vec3_t position;
39 }
40 mvertex_t;
41
42 #define SIDE_FRONT 0
43 #define SIDE_BACK 1
44 #define SIDE_ON 2
45
46
47 // plane_t structure
48 typedef struct mplane_s
49 {
50         vec3_t normal;
51         float dist;
52         // for texture axis selection and fast side tests
53         int type;
54         int signbits;
55 }
56 mplane_t;
57
58 #define SHADERSTAGE_SKY 0
59 #define SHADERSTAGE_NORMAL 1
60 #define SHADERSTAGE_COUNT 2
61
62 #define SHADERFLAGS_NEEDLIGHTMAP 1
63
64 #define SURF_PLANEBACK 2
65 #define SURF_DRAWSKY 4
66 #define SURF_DRAWTURB 0x10
67 #define SURF_LIGHTMAP 0x20
68 #define SURF_DRAWNOALPHA 0x100
69 #define SURF_DRAWFULLBRIGHT 0x200
70 #define SURF_LIGHTBOTHSIDES 0x400
71 #define SURF_SHADOWCAST 0x1000 // this polygon can cast stencil shadows
72 #define SURF_SHADOWLIGHT 0x2000 // this polygon can be lit by stencil shadowing
73 #define SURF_WATERALPHA 0x4000 // this polygon's alpha is modulated by r_wateralpha
74 #define SURF_SOLIDCLIP 0x8000 // this polygon blocks movement
75
76 #define SURFRENDER_OPAQUE 0
77 #define SURFRENDER_ALPHA 1
78 #define SURFRENDER_ADD 2
79
80 struct entity_render_s;
81 struct texture_s;
82 struct msurface_s;
83 // change this stuff when real shaders are added
84 typedef struct Cshader_s
85 {
86         void (*shaderfunc[SHADERSTAGE_COUNT])(const struct entity_render_s *ent, const struct texture_s *texture, struct msurface_s **surfchain);
87         int flags;
88 }
89 Cshader_t;
90
91 extern Cshader_t Cshader_wall_lightmap;
92 extern Cshader_t Cshader_water;
93 extern Cshader_t Cshader_sky;
94
95 typedef struct texture_s
96 {
97         // name
98         char name[16];
99         // size
100         unsigned int width, height;
101         // SURF_ flags
102         unsigned int flags;
103
104         // position in the model's textures array
105         int number;
106
107         // type of rendering (SURFRENDER_ value)
108         int rendertype;
109
110         // loaded the same as model skins
111         skinframe_t skin;
112
113         // shader to use for this texture
114         Cshader_t *shader;
115
116         // total frames in sequence and alternate sequence
117         int anim_total[2];
118         // direct pointers to each of the frames in the sequences
119         // (indexed as [alternate][frame])
120         struct texture_s *anim_frames[2][10];
121         // set if animated or there is an alternate frame set
122         // (this is an optimization in the renderer)
123         int animated;
124         // the current texture frame in animation
125         struct texture_s *currentframe;
126         // current alpha of the texture
127         float currentalpha;
128 }
129 texture_t;
130
131 typedef struct
132 {
133         unsigned short v[2];
134 }
135 medge_t;
136
137 typedef struct
138 {
139         float vecs[2][4];
140         texture_t *texture;
141         int flags;
142 }
143 mtexinfo_t;
144
145 // LordHavoc: replaces glpoly, triangle mesh
146 typedef struct surfmesh_s
147 {
148         // can be multiple meshs per surface
149         struct surfmesh_s *chain;
150         int numverts; // number of vertices in the mesh
151         int numtriangles; // number of triangles in the mesh
152         float *vertex3f; // float[verts*3] vertex locations
153         float *svector3f; // float[verts*3] direction of 'S' (right) texture axis for each vertex
154         float *tvector3f; // float[verts*3] direction of 'T' (down) texture axis for each vertex
155         float *normal3f; // float[verts*3] direction of 'R' (out) texture axis for each vertex
156         int *lightmapoffsets; // index into surface's lightmap samples for vertex lighting
157         float *texcoordtexture2f; // float[verts*2] texcoords for surface texture
158         float *texcoordlightmap2f; // float[verts*2] texcoords for lightmap texture
159         float *texcoorddetail2f; // float[verts*2] texcoords for detail texture
160         int *element3i; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
161         int *neighbor3i; // int[tris*3] neighboring triangle on each edge (-1 if none)
162 }
163 surfmesh_t;
164
165 typedef struct msurface_s
166 {
167         // bounding box for onscreen checks
168         vec3_t poly_mins;
169         vec3_t poly_maxs;
170
171         // the node plane this is on, backwards if SURF_PLANEBACK flag set
172         mplane_t *plane;
173         // SURF_ flags
174         int flags;
175         // texture mapping properties used by this surface
176         mtexinfo_t *texinfo;
177
178         // the lightmap texture fragment to use on the rendering mesh
179         rtexture_t *lightmaptexture;
180         // mesh for rendering
181         surfmesh_t *mesh;
182         // if lightmap settings changed, this forces update
183         int cached_dlight;
184
185         // should be drawn if visframe == r_framecount (set by PrepareSurfaces)
186         int visframe;
187         // should be drawn if onscreen and not a backface (used for setting visframe)
188         //int pvsframe;
189         // chain of surfaces marked visible by pvs
190         //struct msurface_s *pvschain;
191
192         // surface number, to avoid having to do a divide to find the number of a surface from it's address
193         int number;
194
195         // center for sorting transparent meshes
196         vec3_t poly_center;
197
198         // index into d_lightstylevalue array, 255 means not used (black)
199         qbyte styles[MAXLIGHTMAPS];
200         // RGB lighting data [numstyles][height][width][3]
201         qbyte *samples;
202         // stain to apply on lightmap (soot/dirt/blood/whatever)
203         qbyte *stainsamples;
204         // the stride when building lightmaps to comply with fragment update
205         int lightmaptexturestride;
206         int texturemins[2];
207         int extents[2];
208
209         // if this == r_framecount there are dynamic lights on the surface
210         int dlightframe;
211         // which dynamic lights are touching this surface
212         // (only access this if dlightframe is current)
213         int dlightbits[8];
214         // avoid redundent addition of dlights
215         int lightframe;
216
217         // avoid multiple collision traces with a surface polygon
218         int colframe;
219
220         // these are just 3D points defining the outline of the polygon,
221         // no texcoord info (that can be generated from these)
222         int poly_numverts;
223         float *poly_verts;
224
225         // neighboring surfaces (one per poly_numverts)
226         //struct msurface_s **neighborsurfaces;
227         // currently used only for generating static shadow volumes
228         int castshadow;
229 }
230 msurface_t;
231
232 typedef struct mnode_s
233 {
234 // common with leaf
235         // always 0 in nodes
236         int contents;
237
238         struct mnode_s *parent;
239         struct mportal_s *portals;
240
241         // for bounding box culling
242         vec3_t mins;
243         vec3_t maxs;
244
245 // node specific
246         mplane_t *plane;
247         struct mnode_s *children[2];
248
249         unsigned short firstsurface;
250         unsigned short numsurfaces;
251 }
252 mnode_t;
253
254 typedef struct mleaf_s
255 {
256 // common with node
257         // always negative in leafs
258         int contents;
259
260         struct mnode_s *parent;
261         struct mportal_s *portals;
262
263         // for bounding box culling
264         vec3_t mins;
265         vec3_t maxs;
266
267 // leaf specific
268         // next leaf in pvschain
269         struct mleaf_s *pvschain;
270         // potentially visible if current (model->pvsframecount)
271         int pvsframe;
272         // visible if marked current (r_framecount)
273         int visframe;
274         // used by certain worldnode variants to avoid processing the same leaf twice in a frame
275         int worldnodeframe;
276         // used by polygon-through-portals visibility checker
277         int portalmarkid;
278
279         // decompressed pvs bits (potentially visible set)
280         // note: never NULL, always present, may be full of 0xFF though
281         qbyte *pvsdata;
282
283         int *firstmarksurface;
284         int nummarksurfaces;
285         qbyte ambient_sound_level[NUM_AMBIENTS];
286 }
287 mleaf_t;
288
289 typedef struct
290 {
291         dclipnode_t *clipnodes;
292         mplane_t *planes;
293         int firstclipnode;
294         int lastclipnode;
295         vec3_t clip_mins;
296         vec3_t clip_maxs;
297         vec3_t clip_size;
298 }
299 hull_t;
300
301 typedef struct mportal_s
302 {
303         struct mportal_s *next; // the next portal on this leaf
304         mleaf_t *here; // the leaf this portal is on
305         mleaf_t *past; // the leaf through this portal (infront)
306         mvertex_t *points;
307         int numpoints;
308         mplane_t plane;
309         int visframe; // is this portal visible this frame?
310 }
311 mportal_t;
312
313 typedef struct svbspmesh_s
314 {
315         struct svbspmesh_s *next;
316         int numverts, maxverts;
317         int numtriangles, maxtriangles;
318         float *verts;
319         int *elements;
320 }
321 svbspmesh_t;
322
323 typedef struct mlight_s
324 {
325         // location of light
326         vec3_t origin;
327         // distance attenuation scale (smaller is a larger light)
328         float falloff;
329         // color and brightness combined
330         vec3_t light;
331         // brightness bias, used for limiting radius without a hard edge
332         float subtract;
333         // spotlight direction
334         vec3_t spotdir;
335         // cosine of spotlight cone angle (or 0 if not a spotlight)
336         float spotcone;
337         // distance bias (larger value is softer and darker)
338         float distbias;
339         // light style controlling this light
340         int style;
341         // maximum extent of the light for shading purposes
342         float lightradius;
343         // maximum extent of the light for culling purposes
344         float cullradius;
345         float cullradius2;
346         /*
347         // surfaces this shines on
348         int numsurfaces;
349         msurface_t **surfaces;
350         // lit area
351         vec3_t mins, maxs;
352         // precomputed shadow volume meshs
353         //svbspmesh_t *shadowvolume;
354         //vec3_t shadowvolumemins, shadowvolumemaxs;
355         shadowmesh_t *shadowvolume;
356         */
357 }
358 mlight_t;
359
360 extern rtexture_t *r_notexture;
361 extern texture_t r_notexture_mip;
362
363 struct model_s;
364 void Mod_Q1BSP_Load(struct model_s *mod, void *buffer);
365 void Mod_IBSP_Load(struct model_s *mod, void *buffer);
366 void Mod_MAP_Load(struct model_s *mod, void *buffer);
367 void Mod_BrushInit(void);
368
369 // Q2 bsp stuff
370
371 #define Q2BSPVERSION    38
372
373 // leaffaces, leafbrushes, planes, and verts are still bounded by
374 // 16 bit short limits
375
376 //=============================================================================
377
378 #define Q2LUMP_ENTITIES         0
379 #define Q2LUMP_PLANES                   1
380 #define Q2LUMP_VERTEXES         2
381 #define Q2LUMP_VISIBILITY               3
382 #define Q2LUMP_NODES                    4
383 #define Q2LUMP_TEXINFO          5
384 #define Q2LUMP_FACES                    6
385 #define Q2LUMP_LIGHTING         7
386 #define Q2LUMP_LEAFS                    8
387 #define Q2LUMP_LEAFFACES                9
388 #define Q2LUMP_LEAFBRUSHES      10
389 #define Q2LUMP_EDGES                    11
390 #define Q2LUMP_SURFEDGES                12
391 #define Q2LUMP_MODELS                   13
392 #define Q2LUMP_BRUSHES          14
393 #define Q2LUMP_BRUSHSIDES               15
394 #define Q2LUMP_POP                      16
395 #define Q2LUMP_AREAS                    17
396 #define Q2LUMP_AREAPORTALS      18
397 #define Q2HEADER_LUMPS          19
398
399 typedef struct
400 {
401         int                     ident;
402         int                     version;
403         lump_t          lumps[HEADER_LUMPS];
404 } q2dheader_t;
405
406 typedef struct
407 {
408         float           mins[3], maxs[3];
409         float           origin[3];              // for sounds or lights
410         int                     headnode;
411         int                     firstface, numfaces;    // submodels just draw faces
412                                                                                 // without walking the bsp tree
413 } q2dmodel_t;
414
415 // planes (x&~1) and (x&~1)+1 are always opposites
416
417 // contents flags are seperate bits
418 // a given brush can contribute multiple content bits
419 // multiple brushes can be in a single leaf
420
421 // these definitions also need to be in q_shared.h!
422
423 // lower bits are stronger, and will eat weaker brushes completely
424 #define Q2CONTENTS_SOLID                        1               // an eye is never valid in a solid
425 #define Q2CONTENTS_WINDOW                       2               // translucent, but not watery
426 #define Q2CONTENTS_AUX                  4
427 #define Q2CONTENTS_LAVA                 8
428 #define Q2CONTENTS_SLIME                        16
429 #define Q2CONTENTS_WATER                        32
430 #define Q2CONTENTS_MIST                 64
431 #define Q2LAST_VISIBLE_CONTENTS 64
432
433 // remaining contents are non-visible, and don't eat brushes
434
435 #define Q2CONTENTS_AREAPORTAL           0x8000
436
437 #define Q2CONTENTS_PLAYERCLIP           0x10000
438 #define Q2CONTENTS_MONSTERCLIP  0x20000
439
440 // currents can be added to any other contents, and may be mixed
441 #define Q2CONTENTS_CURRENT_0            0x40000
442 #define Q2CONTENTS_CURRENT_90           0x80000
443 #define Q2CONTENTS_CURRENT_180  0x100000
444 #define Q2CONTENTS_CURRENT_270  0x200000
445 #define Q2CONTENTS_CURRENT_UP           0x400000
446 #define Q2CONTENTS_CURRENT_DOWN 0x800000
447
448 #define Q2CONTENTS_ORIGIN                       0x1000000       // removed before bsping an entity
449
450 #define Q2CONTENTS_MONSTER              0x2000000       // should never be on a brush, only in game
451 #define Q2CONTENTS_DEADMONSTER  0x4000000
452 #define Q2CONTENTS_DETAIL                       0x8000000       // brushes to be added after vis leafs
453 #define Q2CONTENTS_TRANSLUCENT  0x10000000      // auto set if any surface has trans
454 #define Q2CONTENTS_LADDER                       0x20000000
455
456
457
458 #define Q2SURF_LIGHT            0x1             // value will hold the light strength
459
460 #define Q2SURF_SLICK            0x2             // effects game physics
461
462 #define Q2SURF_SKY              0x4             // don't draw, but add to skybox
463 #define Q2SURF_WARP             0x8             // turbulent water warp
464 #define Q2SURF_TRANS33  0x10
465 #define Q2SURF_TRANS66  0x20
466 #define Q2SURF_FLOWING  0x40    // scroll towards angle
467 #define Q2SURF_NODRAW           0x80    // don't bother referencing the texture
468
469
470
471
472 typedef struct
473 {
474         int                     planenum;
475         int                     children[2];    // negative numbers are -(leafs+1), not nodes
476         short           mins[3];                // for frustom culling
477         short           maxs[3];
478         unsigned short  firstface;
479         unsigned short  numfaces;       // counting both sides
480 } q2dnode_t;
481
482
483 typedef struct
484 {
485         float           vecs[2][4];             // [s/t][xyz offset]
486         int                     flags;                  // miptex flags + overrides
487         int                     value;                  // light emission, etc
488         char            texture[32];    // texture name (textures/*.wal)
489         int                     nexttexinfo;    // for animations, -1 = end of chain
490 } q2texinfo_t;
491
492 typedef struct
493 {
494         int                             contents;                       // OR of all brushes (not needed?)
495
496         short                   cluster;
497         short                   area;
498
499         short                   mins[3];                        // for frustum culling
500         short                   maxs[3];
501
502         unsigned short  firstleafface;
503         unsigned short  numleaffaces;
504
505         unsigned short  firstleafbrush;
506         unsigned short  numleafbrushes;
507 } q2dleaf_t;
508
509 typedef struct
510 {
511         unsigned short  planenum;               // facing out of the leaf
512         short   texinfo;
513 } q2dbrushside_t;
514
515 typedef struct
516 {
517         int                     firstside;
518         int                     numsides;
519         int                     contents;
520 } q2dbrush_t;
521
522
523 // the visibility lump consists of a header with a count, then
524 // byte offsets for the PVS and PHS of each cluster, then the raw
525 // compressed bit vectors
526 #define Q2DVIS_PVS      0
527 #define Q2DVIS_PHS      1
528 typedef struct
529 {
530         int                     numclusters;
531         int                     bitofs[8][2];   // bitofs[numclusters][2]
532 } q2dvis_t;
533
534 // each area has a list of portals that lead into other areas
535 // when portals are closed, other areas may not be visible or
536 // hearable even if the vis info says that it should be
537 typedef struct
538 {
539         int             portalnum;
540         int             otherarea;
541 } q2dareaportal_t;
542
543 typedef struct
544 {
545         int             numareaportals;
546         int             firstareaportal;
547 } q2darea_t;
548
549
550 //Q3 bsp stuff
551
552 #define Q3BSPVERSION    46
553
554 #define Q3LUMP_ENTITIES         0 // entities to spawn (used by server and client)
555 #define Q3LUMP_TEXTURES         1 // textures used (used by faces)
556 #define Q3LUMP_PLANES           2 // planes used (used by bsp nodes)
557 #define Q3LUMP_NODES            3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
558 #define Q3LUMP_LEAFS            4 // bsp leafs (used by bsp nodes)
559 #define Q3LUMP_LEAFFACES        5 // array of ints indexing faces (used by leafs)
560 #define Q3LUMP_LEAFBRUSHES      6 // array of ints indexing brushes (used by leafs)
561 #define Q3LUMP_MODELS           7 // models (used by rendering, collisions)
562 #define Q3LUMP_BRUSHES          8 // brushes (used by effects, collisions)
563 #define Q3LUMP_BRUSHSIDES       9 // brush faces (used by brushes)
564 #define Q3LUMP_VERTICES         10 // mesh vertices (used by faces)
565 #define Q3LUMP_TRIANGLES        11 // mesh triangles (used by faces)
566 #define Q3LUMP_EFFECTS          12 // fog (used by faces)
567 #define Q3LUMP_FACES            13 // surfaces (used by leafs)
568 #define Q3LUMP_LIGHTMAPS        14 // lightmap textures (used by faces)
569 #define Q3LUMP_LIGHTGRID        15 // lighting as a voxel grid (used by rendering)
570 #define Q3LUMP_PVS                      16 // potentially visible set; bit[clusters][clusters] (used by rendering)
571 #define Q3HEADER_LUMPS          17
572
573 #define Q3PATHLENGTH 64
574
575 typedef struct
576 {
577         int                     ident;
578         int                     version;
579         lump_t          lumps[HEADER_LUMPS];
580 } q3dheader_t;
581
582 typedef struct
583 {
584         char name[Q3PATHLENGTH];
585         int surfaceflags;
586         int contents;
587 }
588 q3dtexture_t;
589
590 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
591 typedef struct
592 {
593         float normal[3];
594         float dist;
595 }
596 q3dplane_t;
597
598 typedef struct
599 {
600         int planeindex;
601         int childrenindex[2];
602         int mins[3];
603         int maxs[3];
604 }
605 q3dnode_t;
606
607 typedef struct
608 {
609         int clusterindex; // pvs index
610         int areaindex; // area index
611         int mins[3];
612         int maxs[3];
613         int firstleafface;
614         int numleaffaces;
615         int firstleafbrush;
616         int numleafbrushes;
617 }
618 q3dleaf_t;
619
620 typedef struct
621 {
622         float mins[3];
623         float maxs[3];
624         int firstface;
625         int numfaces;
626         int firstbrush;
627         int numbrushes;
628 }
629 q3dmodel_t;
630
631 typedef struct
632 {
633         int firstbrushside;
634         int numbrushsides;
635         int textureindex;
636 }
637 q3dbrush_t;
638
639 typedef struct
640 {
641         int planeindex;
642         int textureindex;
643 }
644 q3dbrushside_t;
645
646 typedef struct
647 {
648         float origin3f[3];
649         float texcoord2f[2];
650         float lightmap2f[2];
651         float normal3f[3];
652         unsigned char color4ub[4];
653 }
654 q3dvertex_t;
655
656 typedef struct
657 {
658         int offset; // first vertex index of mesh
659 }
660 q3dmeshvertex_t;
661
662 typedef struct
663 {
664         char shadername[Q3PATHLENGTH];
665         int brushindex;
666         int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
667 }
668 q3deffect_t;
669
670 #define Q3FACETYPE_POLYGON 1 // common
671 #define Q3FACETYPE_PATCH 2 // common
672 #define Q3FACETYPE_MESH 3 // common
673 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
674
675 typedef struct
676 {
677         int textureindex;
678         int effectindex; // -1 if none
679         int type; // Q3FACETYPE
680         int firstvertex;
681         int numvertices;
682         int firstelement;
683         int numelements;
684         int lightmapindex; // -1 if none
685         int lightmap_base[2];
686         int lightmap_size[2];
687         union
688         {
689                 struct
690                 {
691                         // corrupt or don't care
692                         int blah[14];
693                 }
694                 unknown;
695                 struct
696                 {
697                         // Q3FACETYPE_POLYGON
698                         // polygon is simply a convex polygon, renderable as a mesh
699                         float lightmap_origin[3];
700                         float lightmap_vectors[2][3];
701                         float normal[3];
702                         int unused1[2];
703                 }
704                 polygon;
705                 struct
706                 {
707                         // Q3FACETYPE_PATCH
708                         // patch renders as a bezier mesh, with adjustable tesselation
709                         // level (optionally based on LOD using the bbox and polygon
710                         // count to choose a tesselation level)
711                         // note: multiple patches may have the same bbox to cause them to
712                         // be LOD adjusted together as a group
713                         int unused1[3];
714                         float mins[3]; // LOD bbox
715                         float maxs[3]; // LOD bbox
716                         int unused2[3];
717                         int patchsize[2]; // dimensions of vertex grid
718                 }
719                 patch;
720                 struct
721                 {
722                         // Q3FACETYPE_MESH
723                         // mesh renders as simply a triangle mesh
724                         int unused1[3];
725                         float mins[3];
726                         float maxs[3];
727                         int unused2[5];
728                 }
729                 mesh;
730                 struct
731                 {
732                         // Q3FACETYPE_FLARE
733                         // flare renders as a simple sprite at origin, no geometry
734                         // exists, nor does it have a radius, a cvar controls the radius
735                         // and another cvar controls distance fade
736                         // (they were not used in Q3 I'm told)
737                         float origin[3];
738                         int unused1[11];
739                 }
740                 flare;
741         }
742         specific;
743 }
744 q3dface_t;
745
746 typedef struct
747 {
748         unsigned char rgb[128*128*3];
749 }
750 q3dlightmap_t;
751
752 typedef struct
753 {
754         unsigned char ambientrgb[3];
755         unsigned char diffusergb[3];
756         unsigned char diffusepitch;
757         unsigned char diffuseyaw;
758 }
759 q3dlightgrid_t;
760
761 typedef struct
762 {
763         int numclusters;
764         int chainlength;
765         // unsigned char chains[];
766         // containing bits in 0-7 order (not 7-0 order),
767         // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
768 }
769 q3dpvs_t;
770
771 #endif
772