moved all type-specific model fields to respective structures (alias, sprite, brush)
[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         qbyte *compressed_vis;
280
281         int *firstmarksurface;
282         int nummarksurfaces;
283         qbyte ambient_sound_level[NUM_AMBIENTS];
284 }
285 mleaf_t;
286
287 typedef struct
288 {
289         dclipnode_t *clipnodes;
290         mplane_t *planes;
291         int firstclipnode;
292         int lastclipnode;
293         vec3_t clip_mins;
294         vec3_t clip_maxs;
295         vec3_t clip_size;
296 }
297 hull_t;
298
299 typedef struct mportal_s
300 {
301         struct mportal_s *next; // the next portal on this leaf
302         mleaf_t *here; // the leaf this portal is on
303         mleaf_t *past; // the leaf through this portal (infront)
304         mvertex_t *points;
305         int numpoints;
306         mplane_t plane;
307         int visframe; // is this portal visible this frame?
308 }
309 mportal_t;
310
311 typedef struct svbspmesh_s
312 {
313         struct svbspmesh_s *next;
314         int numverts, maxverts;
315         int numtriangles, maxtriangles;
316         float *verts;
317         int *elements;
318 }
319 svbspmesh_t;
320
321 typedef struct mlight_s
322 {
323         // location of light
324         vec3_t origin;
325         // distance attenuation scale (smaller is a larger light)
326         float falloff;
327         // color and brightness combined
328         vec3_t light;
329         // brightness bias, used for limiting radius without a hard edge
330         float subtract;
331         // spotlight direction
332         vec3_t spotdir;
333         // cosine of spotlight cone angle (or 0 if not a spotlight)
334         float spotcone;
335         // distance bias (larger value is softer and darker)
336         float distbias;
337         // light style controlling this light
338         int style;
339         // maximum extent of the light for shading purposes
340         float lightradius;
341         // maximum extent of the light for culling purposes
342         float cullradius;
343         float cullradius2;
344         /*
345         // surfaces this shines on
346         int numsurfaces;
347         msurface_t **surfaces;
348         // lit area
349         vec3_t mins, maxs;
350         // precomputed shadow volume meshs
351         //svbspmesh_t *shadowvolume;
352         //vec3_t shadowvolumemins, shadowvolumemaxs;
353         shadowmesh_t *shadowvolume;
354         */
355 }
356 mlight_t;
357
358 extern rtexture_t *r_notexture;
359 extern texture_t r_notexture_mip;
360
361 struct model_s;
362 void Mod_Q1BSP_Load(struct model_s *mod, void *buffer);
363 void Mod_IBSP_Load(struct model_s *mod, void *buffer);
364 void Mod_MAP_Load(struct model_s *mod, void *buffer);
365 void Mod_BrushInit(void);
366
367 // Q2 bsp stuff
368
369 #define Q2BSPVERSION    38
370
371 // leaffaces, leafbrushes, planes, and verts are still bounded by
372 // 16 bit short limits
373
374 //=============================================================================
375
376 #define Q2LUMP_ENTITIES         0
377 #define Q2LUMP_PLANES                   1
378 #define Q2LUMP_VERTEXES         2
379 #define Q2LUMP_VISIBILITY               3
380 #define Q2LUMP_NODES                    4
381 #define Q2LUMP_TEXINFO          5
382 #define Q2LUMP_FACES                    6
383 #define Q2LUMP_LIGHTING         7
384 #define Q2LUMP_LEAFS                    8
385 #define Q2LUMP_LEAFFACES                9
386 #define Q2LUMP_LEAFBRUSHES      10
387 #define Q2LUMP_EDGES                    11
388 #define Q2LUMP_SURFEDGES                12
389 #define Q2LUMP_MODELS                   13
390 #define Q2LUMP_BRUSHES          14
391 #define Q2LUMP_BRUSHSIDES               15
392 #define Q2LUMP_POP                      16
393 #define Q2LUMP_AREAS                    17
394 #define Q2LUMP_AREAPORTALS      18
395 #define Q2HEADER_LUMPS          19
396
397 typedef struct
398 {
399         int                     ident;
400         int                     version;
401         lump_t          lumps[HEADER_LUMPS];
402 } q2dheader_t;
403
404 typedef struct
405 {
406         float           mins[3], maxs[3];
407         float           origin[3];              // for sounds or lights
408         int                     headnode;
409         int                     firstface, numfaces;    // submodels just draw faces
410                                                                                 // without walking the bsp tree
411 } q2dmodel_t;
412
413 // planes (x&~1) and (x&~1)+1 are always opposites
414
415 // contents flags are seperate bits
416 // a given brush can contribute multiple content bits
417 // multiple brushes can be in a single leaf
418
419 // these definitions also need to be in q_shared.h!
420
421 // lower bits are stronger, and will eat weaker brushes completely
422 #define Q2CONTENTS_SOLID                        1               // an eye is never valid in a solid
423 #define Q2CONTENTS_WINDOW                       2               // translucent, but not watery
424 #define Q2CONTENTS_AUX                  4
425 #define Q2CONTENTS_LAVA                 8
426 #define Q2CONTENTS_SLIME                        16
427 #define Q2CONTENTS_WATER                        32
428 #define Q2CONTENTS_MIST                 64
429 #define Q2LAST_VISIBLE_CONTENTS 64
430
431 // remaining contents are non-visible, and don't eat brushes
432
433 #define Q2CONTENTS_AREAPORTAL           0x8000
434
435 #define Q2CONTENTS_PLAYERCLIP           0x10000
436 #define Q2CONTENTS_MONSTERCLIP  0x20000
437
438 // currents can be added to any other contents, and may be mixed
439 #define Q2CONTENTS_CURRENT_0            0x40000
440 #define Q2CONTENTS_CURRENT_90           0x80000
441 #define Q2CONTENTS_CURRENT_180  0x100000
442 #define Q2CONTENTS_CURRENT_270  0x200000
443 #define Q2CONTENTS_CURRENT_UP           0x400000
444 #define Q2CONTENTS_CURRENT_DOWN 0x800000
445
446 #define Q2CONTENTS_ORIGIN                       0x1000000       // removed before bsping an entity
447
448 #define Q2CONTENTS_MONSTER              0x2000000       // should never be on a brush, only in game
449 #define Q2CONTENTS_DEADMONSTER  0x4000000
450 #define Q2CONTENTS_DETAIL                       0x8000000       // brushes to be added after vis leafs
451 #define Q2CONTENTS_TRANSLUCENT  0x10000000      // auto set if any surface has trans
452 #define Q2CONTENTS_LADDER                       0x20000000
453
454
455
456 #define Q2SURF_LIGHT            0x1             // value will hold the light strength
457
458 #define Q2SURF_SLICK            0x2             // effects game physics
459
460 #define Q2SURF_SKY              0x4             // don't draw, but add to skybox
461 #define Q2SURF_WARP             0x8             // turbulent water warp
462 #define Q2SURF_TRANS33  0x10
463 #define Q2SURF_TRANS66  0x20
464 #define Q2SURF_FLOWING  0x40    // scroll towards angle
465 #define Q2SURF_NODRAW           0x80    // don't bother referencing the texture
466
467
468
469
470 typedef struct
471 {
472         int                     planenum;
473         int                     children[2];    // negative numbers are -(leafs+1), not nodes
474         short           mins[3];                // for frustom culling
475         short           maxs[3];
476         unsigned short  firstface;
477         unsigned short  numfaces;       // counting both sides
478 } q2dnode_t;
479
480
481 typedef struct
482 {
483         float           vecs[2][4];             // [s/t][xyz offset]
484         int                     flags;                  // miptex flags + overrides
485         int                     value;                  // light emission, etc
486         char            texture[32];    // texture name (textures/*.wal)
487         int                     nexttexinfo;    // for animations, -1 = end of chain
488 } q2texinfo_t;
489
490 typedef struct
491 {
492         int                             contents;                       // OR of all brushes (not needed?)
493
494         short                   cluster;
495         short                   area;
496
497         short                   mins[3];                        // for frustum culling
498         short                   maxs[3];
499
500         unsigned short  firstleafface;
501         unsigned short  numleaffaces;
502
503         unsigned short  firstleafbrush;
504         unsigned short  numleafbrushes;
505 } q2dleaf_t;
506
507 typedef struct
508 {
509         unsigned short  planenum;               // facing out of the leaf
510         short   texinfo;
511 } q2dbrushside_t;
512
513 typedef struct
514 {
515         int                     firstside;
516         int                     numsides;
517         int                     contents;
518 } q2dbrush_t;
519
520
521 // the visibility lump consists of a header with a count, then
522 // byte offsets for the PVS and PHS of each cluster, then the raw
523 // compressed bit vectors
524 #define Q2DVIS_PVS      0
525 #define Q2DVIS_PHS      1
526 typedef struct
527 {
528         int                     numclusters;
529         int                     bitofs[8][2];   // bitofs[numclusters][2]
530 } q2dvis_t;
531
532 // each area has a list of portals that lead into other areas
533 // when portals are closed, other areas may not be visible or
534 // hearable even if the vis info says that it should be
535 typedef struct
536 {
537         int             portalnum;
538         int             otherarea;
539 } q2dareaportal_t;
540
541 typedef struct
542 {
543         int             numareaportals;
544         int             firstareaportal;
545 } q2darea_t;
546
547
548 //Q3 bsp stuff
549
550 #define Q3BSPVERSION    46
551
552 #define Q3LUMP_ENTITIES         0 // entities to spawn (used by server and client)
553 #define Q3LUMP_TEXTURES         1 // textures used (used by faces)
554 #define Q3LUMP_PLANES           2 // planes used (used by bsp nodes)
555 #define Q3LUMP_NODES            3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
556 #define Q3LUMP_LEAFS            4 // bsp leafs (used by bsp nodes)
557 #define Q3LUMP_LEAFFACES        5 // array of ints indexing faces (used by leafs)
558 #define Q3LUMP_LEAFBRUSHES      6 // array of ints indexing brushes (used by leafs)
559 #define Q3LUMP_MODELS           7 // models (used by rendering, collisions)
560 #define Q3LUMP_BRUSHES          8 // brushes (used by effects, collisions)
561 #define Q3LUMP_BRUSHSIDES       9 // brush faces (used by brushes)
562 #define Q3LUMP_VERTICES         10 // mesh vertices (used by faces)
563 #define Q3LUMP_TRIANGLES        11 // mesh triangles (used by faces)
564 #define Q3LUMP_EFFECTS          12 // fog (used by faces)
565 #define Q3LUMP_FACES            13 // surfaces (used by leafs)
566 #define Q3LUMP_LIGHTMAPS        14 // lightmap textures (used by faces)
567 #define Q3LUMP_LIGHTGRID        15 // lighting as a voxel grid (used by rendering)
568 #define Q3LUMP_PVS                      16 // potentially visible set; bit[clusters][clusters] (used by rendering)
569 #define Q3HEADER_LUMPS          17
570
571 #define Q3PATHLENGTH 64
572
573 typedef struct
574 {
575         int                     ident;
576         int                     version;
577         lump_t          lumps[HEADER_LUMPS];
578 } q3dheader_t;
579
580 typedef struct
581 {
582         char name[Q3PATHLENGTH];
583         int surfaceflags;
584         int contents;
585 }
586 q3dtexture_t;
587
588 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
589 typedef struct
590 {
591         float normal[3];
592         float dist;
593 }
594 q3dplane_t;
595
596 typedef struct
597 {
598         int planeindex;
599         int childrenindex[2];
600         int mins[3];
601         int maxs[3];
602 }
603 q3dnode_t;
604
605 typedef struct
606 {
607         int clusterindex; // pvs index
608         int areaindex; // area index
609         int mins[3];
610         int maxs[3];
611         int firstleafface;
612         int numleaffaces;
613         int firstleafbrush;
614         int numleafbrushes;
615 }
616 q3dleaf_t;
617
618 typedef struct
619 {
620         float mins[3];
621         float maxs[3];
622         int firstface;
623         int numfaces;
624         int firstbrush;
625         int numbrushes;
626 }
627 q3dmodel_t;
628
629 typedef struct
630 {
631         int firstbrushside;
632         int numbrushsides;
633         int textureindex;
634 }
635 q3dbrush_t;
636
637 typedef struct
638 {
639         int planeindex;
640         int textureindex;
641 }
642 q3dbrushside_t;
643
644 typedef struct
645 {
646         float origin3f[3];
647         float texcoord2f[2];
648         float lightmap2f[2];
649         float normal3f[3];
650         unsigned char color4ub[4];
651 }
652 q3dvertex_t;
653
654 typedef struct
655 {
656         int offset; // first vertex index of mesh
657 }
658 q3dmeshvertex_t;
659
660 typedef struct
661 {
662         char shadername[Q3PATHLENGTH];
663         int brushindex;
664         int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
665 }
666 q3deffect_t;
667
668 #define Q3FACETYPE_POLYGON 1 // common
669 #define Q3FACETYPE_PATCH 2 // common
670 #define Q3FACETYPE_MESH 3 // common
671 #define Q3FACETYPE_BILLBOARD 4 // rare (is this ever used?)
672
673 typedef struct
674 {
675         int textureindex;
676         int effectindex; // -1 if none
677         int type; // Q3FACETYPE
678         int firstvertex;
679         int numvertices;
680         int firstelement;
681         int numelements;
682         int lightmapindex;
683         int lightmap_base[2]; // only needed by lighting util
684         int lightmap_size[2]; // only needed by lighting util
685         float lightmap_origin[3]; // only needed by lighting util
686         float lightmap_vectors[2][3]; // only needed by lighting util
687         float normal[3]; // only needed by lighting util
688         int patchsize[2]; // size for Q3FACETYPE_PATCH
689 }
690 q3dface_t;
691
692 typedef struct
693 {
694         unsigned char rgb[128][128][3];
695 }
696 q3dlightmap_t;
697
698 typedef struct
699 {
700         unsigned char ambientrgb[3];
701         unsigned char diffusergb[3];
702         unsigned char diffusepitch;
703         unsigned char diffuseyaw;
704 }
705 q3dlightgrid_t;
706
707 typedef struct
708 {
709         int numclusters;
710         int chainlength;
711         // unsigned char chains[];
712         // containing bits in 0-7 order (not 7-0 order),
713         // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
714 }
715 q3dpvs_t;
716
717 #endif
718