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