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