implemented omnidirectional shadowmapping using depth textures (2D, Rect
[divverent/darkplaces.git] / model_shared.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_SHARED_H
22 #define MODEL_SHARED_H
23
24 typedef enum synctype_e {ST_SYNC=0, ST_RAND } synctype_t;
25
26 /*
27
28 d*_t structures are on-disk representations
29 m*_t structures are in-memory
30
31 */
32
33 typedef enum modtype_e {mod_invalid, mod_brushq1, mod_sprite, mod_alias, mod_brushq2, mod_brushq3, mod_null} modtype_t;
34
35 typedef struct animscene_s
36 {
37         char name[32]; // for viewthing support
38         int firstframe;
39         int framecount;
40         int loop; // true or false
41         float framerate;
42 }
43 animscene_t;
44
45 typedef struct skinframe_s
46 {
47         rtexture_t *stain; // inverse modulate with background (used for decals and such)
48         rtexture_t *merged; // original texture without glow
49         rtexture_t *base; // original texture without pants/shirt/glow
50         rtexture_t *pants; // pants only (in greyscale)
51         rtexture_t *shirt; // shirt only (in greyscale)
52         rtexture_t *nmap; // normalmap (bumpmap for dot3)
53         rtexture_t *gloss; // glossmap (for dot3)
54         rtexture_t *glow; // glow only (fullbrights)
55         rtexture_t *fog; // alpha of the base texture (if not opaque)
56         // accounting data for hash searches:
57         // the compare variables are used to identify internal skins from certain
58         // model formats
59         // (so that two q1bsp maps with the same texture name for different
60         //  textures do not have any conflicts)
61         struct skinframe_s *next; // next on hash chain
62         char basename[MAX_QPATH]; // name of this
63         int textureflags; // texture flags to use
64         int comparewidth;
65         int compareheight;
66         int comparecrc;
67         // mark and sweep garbage collection, this value is updated to a new value
68         // on each level change for the used skinframes, if some are not used they
69         // are freed
70         int loadsequence;
71         // on 32bit systems this makes the struct 128 bytes long
72         int padding;
73         // average texture color, if applicable
74         float avgcolor[4];
75 }
76 skinframe_t;
77
78 #define MAX_SKINS 256
79
80 struct md3vertex_s;
81 struct trivertx_s;
82 typedef struct texvecvertex_s
83 {
84         signed char svec[3];
85         signed char tvec[3];
86 }
87 texvecvertex_t;
88
89 // used for mesh lists in q1bsp/q3bsp map models
90 // (the surfaces reference portions of these meshes)
91 typedef struct surfmesh_s
92 {
93         // triangle data in system memory
94         int num_triangles; // number of triangles in the mesh
95         int *data_element3i; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
96         unsigned short *data_element3s; // unsigned short[tris*3] triangles of the mesh in unsigned short format (NULL if num_vertices > 65536)
97         int *data_neighbor3i; // int[tris*3] neighboring triangle on each edge (-1 if none)
98         // element buffer object (stores triangles in video memory)
99         int ebo3i; // unsigned int format (only allocated if num_vertices > 65536)
100         int ebo3s; // unsigned short format (only allocated if num_vertices <= 65536)
101         // vertex data in system memory
102         int num_vertices; // number of vertices in the mesh
103         float *data_vertex3f; // float[verts*3] vertex locations
104         float *data_svector3f; // float[verts*3] direction of 'S' (right) texture axis for each vertex
105         float *data_tvector3f; // float[verts*3] direction of 'T' (down) texture axis for each vertex
106         float *data_normal3f; // float[verts*3] direction of 'R' (out) texture axis for each vertex
107         float *data_texcoordtexture2f; // float[verts*2] texcoords for surface texture
108         float *data_texcoordlightmap2f; // float[verts*2] texcoords for lightmap texture
109         float *data_lightmapcolor4f;
110         int *data_lightmapoffsets; // index into surface's lightmap samples for vertex lighting
111         // vertex buffer object (stores geometry in video memory)
112         int vbo;
113         size_t vbooffset_vertex3f;
114         size_t vbooffset_svector3f;
115         size_t vbooffset_tvector3f;
116         size_t vbooffset_normal3f;
117         size_t vbooffset_texcoordtexture2f;
118         size_t vbooffset_texcoordlightmap2f;
119         size_t vbooffset_lightmapcolor4f;
120         // morph blending, these are zero if model is skeletal or static
121         int num_morphframes;
122         struct md3vertex_s *data_morphmd3vertex;
123         struct trivertx_s *data_morphmdlvertex;
124         struct texvecvertex_s *data_morphtexvecvertex;
125         float *data_morphmd2framesize6f;
126         float num_morphmdlframescale[3];
127         float num_morphmdlframetranslate[3];
128         // skeletal blending, these are NULL if model is morph or static
129         int *data_vertexweightindex4i;
130         float *data_vertexweightinfluence4f;
131         // set if there is some kind of animation on this model
132         qboolean isanimated;
133 }
134 surfmesh_t;
135
136 #define SHADOWMESHVERTEXHASH 1024
137 typedef struct shadowmeshvertexhash_s
138 {
139         struct shadowmeshvertexhash_s *next;
140 }
141 shadowmeshvertexhash_t;
142
143 typedef struct shadowmesh_s
144 {
145         // next mesh in chain
146         struct shadowmesh_s *next;
147         // used for light mesh (NULL on shadow mesh)
148         rtexture_t *map_diffuse;
149         rtexture_t *map_specular;
150         rtexture_t *map_normal;
151         // buffer sizes
152         int numverts, maxverts;
153         int numtriangles, maxtriangles;
154         // used always
155         float *vertex3f;
156         // used for light mesh (NULL on shadow mesh)
157         float *svector3f;
158         float *tvector3f;
159         float *normal3f;
160         float *texcoord2f;
161         // used always
162         int *element3i;
163         unsigned short *element3s;
164         // used for shadow mesh (NULL on light mesh)
165         int *neighbor3i;
166         // these are NULL after Mod_ShadowMesh_Finish is performed, only used
167         // while building meshes
168         shadowmeshvertexhash_t **vertexhashtable, *vertexhashentries;
169         // element buffer object (stores triangles in video memory)
170         // (created by Mod_ShadowMesh_Finish if possible)
171         int ebo3i;
172         int ebo3s;
173         // vertex buffer object (stores vertices in video memory)
174         // (created by Mod_ShadowMesh_Finish if possible)
175         int vbo;
176         size_t vbooffset_vertex3f;
177         size_t vbooffset_svector3f;
178         size_t vbooffset_tvector3f;
179         size_t vbooffset_normal3f;
180         size_t vbooffset_texcoord2f;
181 }
182 shadowmesh_t;
183
184 // various flags from shaders, used for special effects not otherwise classified
185 // TODO: support these features more directly
186 #define Q3TEXTUREFLAG_TWOSIDED 1
187 #define Q3TEXTUREFLAG_NOPICMIP 16
188 #define Q3TEXTUREFLAG_POLYGONOFFSET 32
189 #define Q3TEXTUREFLAG_REFRACTION 256
190 #define Q3TEXTUREFLAG_REFLECTION 512
191 #define Q3TEXTUREFLAG_WATERSHADER 1024
192
193 #define Q3PATHLENGTH 64
194 #define TEXTURE_MAXFRAMES 64
195 #define Q3WAVEPARMS 4
196 #define Q3DEFORM_MAXPARMS 3
197 #define Q3SHADER_MAXLAYERS 2 // FIXME support more than that (currently only two are used, so why keep more in RAM?)
198 #define Q3RGBGEN_MAXPARMS 3
199 #define Q3ALPHAGEN_MAXPARMS 1
200 #define Q3TCGEN_MAXPARMS 6
201 #define Q3TCMOD_MAXPARMS 6
202 #define Q3MAXTCMODS 8
203 #define Q3MAXDEFORMS 4
204
205 typedef enum q3wavefunc_e
206 {
207         Q3WAVEFUNC_NONE,
208         Q3WAVEFUNC_INVERSESAWTOOTH,
209         Q3WAVEFUNC_NOISE,
210         Q3WAVEFUNC_SAWTOOTH,
211         Q3WAVEFUNC_SIN,
212         Q3WAVEFUNC_SQUARE,
213         Q3WAVEFUNC_TRIANGLE,
214         Q3WAVEFUNC_COUNT
215 }
216 q3wavefunc_t;
217
218 typedef enum q3deform_e
219 {
220         Q3DEFORM_NONE,
221         Q3DEFORM_PROJECTIONSHADOW,
222         Q3DEFORM_AUTOSPRITE,
223         Q3DEFORM_AUTOSPRITE2,
224         Q3DEFORM_TEXT0,
225         Q3DEFORM_TEXT1,
226         Q3DEFORM_TEXT2,
227         Q3DEFORM_TEXT3,
228         Q3DEFORM_TEXT4,
229         Q3DEFORM_TEXT5,
230         Q3DEFORM_TEXT6,
231         Q3DEFORM_TEXT7,
232         Q3DEFORM_BULGE,
233         Q3DEFORM_WAVE,
234         Q3DEFORM_NORMAL,
235         Q3DEFORM_MOVE,
236         Q3DEFORM_COUNT
237 }
238 q3deform_t;
239
240 typedef enum q3rgbgen_e
241 {
242         Q3RGBGEN_IDENTITY,
243         Q3RGBGEN_CONST,
244         Q3RGBGEN_ENTITY,
245         Q3RGBGEN_EXACTVERTEX,
246         Q3RGBGEN_IDENTITYLIGHTING,
247         Q3RGBGEN_LIGHTINGDIFFUSE,
248         Q3RGBGEN_ONEMINUSENTITY,
249         Q3RGBGEN_ONEMINUSVERTEX,
250         Q3RGBGEN_VERTEX,
251         Q3RGBGEN_WAVE,
252         Q3RGBGEN_COUNT
253 }
254 q3rgbgen_t;
255
256 typedef enum q3alphagen_e
257 {
258         Q3ALPHAGEN_IDENTITY,
259         Q3ALPHAGEN_CONST,
260         Q3ALPHAGEN_ENTITY,
261         Q3ALPHAGEN_LIGHTINGSPECULAR,
262         Q3ALPHAGEN_ONEMINUSENTITY,
263         Q3ALPHAGEN_ONEMINUSVERTEX,
264         Q3ALPHAGEN_PORTAL,
265         Q3ALPHAGEN_VERTEX,
266         Q3ALPHAGEN_WAVE,
267         Q3ALPHAGEN_COUNT
268 }
269 q3alphagen_t;
270
271 typedef enum q3tcgen_e
272 {
273         Q3TCGEN_NONE,
274         Q3TCGEN_TEXTURE, // very common
275         Q3TCGEN_ENVIRONMENT, // common
276         Q3TCGEN_LIGHTMAP,
277         Q3TCGEN_VECTOR,
278         Q3TCGEN_COUNT
279 }
280 q3tcgen_t;
281
282 typedef enum q3tcmod_e
283 {
284         Q3TCMOD_NONE,
285         Q3TCMOD_ENTITYTRANSLATE,
286         Q3TCMOD_ROTATE,
287         Q3TCMOD_SCALE,
288         Q3TCMOD_SCROLL,
289         Q3TCMOD_STRETCH,
290         Q3TCMOD_TRANSFORM,
291         Q3TCMOD_TURBULENT,
292         Q3TCMOD_PAGE,
293         Q3TCMOD_COUNT
294 }
295 q3tcmod_t;
296
297 typedef struct q3shaderinfo_layer_rgbgen_s
298 {
299         q3rgbgen_t rgbgen;
300         float parms[Q3RGBGEN_MAXPARMS];
301         q3wavefunc_t wavefunc;
302         float waveparms[Q3WAVEPARMS];
303 }
304 q3shaderinfo_layer_rgbgen_t;
305
306 typedef struct q3shaderinfo_layer_alphagen_s
307 {
308         q3alphagen_t alphagen;
309         float parms[Q3ALPHAGEN_MAXPARMS];
310         q3wavefunc_t wavefunc;
311         float waveparms[Q3WAVEPARMS];
312 }
313 q3shaderinfo_layer_alphagen_t;
314
315 typedef struct q3shaderinfo_layer_tcgen_s
316 {
317         q3tcgen_t tcgen;
318         float parms[Q3TCGEN_MAXPARMS];
319 }
320 q3shaderinfo_layer_tcgen_t;
321
322 typedef struct q3shaderinfo_layer_tcmod_s
323 {
324         q3tcmod_t tcmod;
325         float parms[Q3TCMOD_MAXPARMS];
326         q3wavefunc_t wavefunc;
327         float waveparms[Q3WAVEPARMS];
328 }
329 q3shaderinfo_layer_tcmod_t;
330
331 typedef struct q3shaderinfo_layer_s
332 {
333         int alphatest;
334         int clampmap;
335         float framerate;
336         int numframes;
337         int texflags;
338         char** texturename;
339         int blendfunc[2];
340         q3shaderinfo_layer_rgbgen_t rgbgen;
341         q3shaderinfo_layer_alphagen_t alphagen;
342         q3shaderinfo_layer_tcgen_t tcgen;
343         q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
344 }
345 q3shaderinfo_layer_t;
346
347 typedef struct q3shaderinfo_deform_s
348 {
349         q3deform_t deform;
350         float parms[Q3DEFORM_MAXPARMS];
351         q3wavefunc_t wavefunc;
352         float waveparms[Q3WAVEPARMS];
353 }
354 q3shaderinfo_deform_t;
355
356 typedef struct q3shaderinfo_s
357 {
358         char name[Q3PATHLENGTH];
359 #define Q3SHADERINFO_COMPARE_START surfaceparms
360         int surfaceparms;
361         int textureflags;
362         int numlayers;
363         qboolean lighting;
364         qboolean vertexalpha;
365         qboolean textureblendalpha;
366         int primarylayer, backgroundlayer;
367         q3shaderinfo_layer_t layers[Q3SHADER_MAXLAYERS];
368         char skyboxname[Q3PATHLENGTH];
369         q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
370
371         // dp-specific additions:
372
373         // shadow control
374         qboolean dpshadow;
375         qboolean dpnoshadow;
376
377         // reflection
378         float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
379         float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
380         float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
381         vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
382         float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
383         vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
384         float r_water_wateralpha; // additional wateralpha to apply when r_water is active
385 #define Q3SHADERINFO_COMPARE_END r_water_wateralpha
386 }
387 q3shaderinfo_t;
388
389 typedef enum texturelayertype_e
390 {
391         TEXTURELAYERTYPE_INVALID,
392         TEXTURELAYERTYPE_LITTEXTURE,
393         TEXTURELAYERTYPE_TEXTURE,
394         TEXTURELAYERTYPE_FOG,
395 }
396 texturelayertype_t;
397
398 typedef enum texturelayerflag_e
399 {
400         // indicates that the pass should apply fog darkening; used on
401         // transparent surfaces where simply blending an alpha fog as a final
402         // pass would not behave properly, so all the surfaces must be darkened,
403         // and the fog color added as a separate pass
404         TEXTURELAYERFLAG_FOGDARKEN = 1,
405 }
406 texturelayerflag_t;
407
408 typedef struct texturelayer_s
409 {
410         texturelayertype_t type;
411         qboolean depthmask;
412         int blendfunc1;
413         int blendfunc2;
414         rtexture_t *texture;
415         matrix4x4_t texmatrix;
416         vec4_t color;
417         int flags;
418 }
419 texturelayer_t;
420
421 typedef struct texture_s
422 {
423         // q1bsp
424         // name
425         //char name[16];
426         // size
427         unsigned int width, height;
428         // SURF_ flags
429         //unsigned int flags;
430
431         // base material flags
432         int basematerialflags;
433         // current material flags (updated each bmodel render)
434         int currentmaterialflags;
435
436         // PolygonOffset values for rendering this material
437         // (these are added to the r_refdef values and submodel values)
438         float biaspolygonfactor;
439         float biaspolygonoffset;
440
441         // textures to use when rendering this material
442         skinframe_t *currentskinframe;
443         int numskinframes;
444         float skinframerate;
445         skinframe_t *skinframes[TEXTURE_MAXFRAMES];
446         // background layer (for terrain texture blending)
447         skinframe_t *backgroundcurrentskinframe;
448         int backgroundnumskinframes;
449         float backgroundskinframerate;
450         skinframe_t *backgroundskinframes[TEXTURE_MAXFRAMES];
451
452         // total frames in sequence and alternate sequence
453         int anim_total[2];
454         // direct pointers to each of the frames in the sequences
455         // (indexed as [alternate][frame])
456         struct texture_s *anim_frames[2][10];
457         // set if animated or there is an alternate frame set
458         // (this is an optimization in the renderer)
459         int animated;
460
461         // renderer checks if this texture needs updating...
462         int update_lastrenderframe;
463         void *update_lastrenderentity;
464         // the current alpha of this texture (may be affected by r_wateralpha)
465         float currentalpha;
466         // the current texture frame in animation
467         struct texture_s *currentframe;
468         // current texture transform matrix (used for water scrolling)
469         matrix4x4_t currenttexmatrix;
470         matrix4x4_t currentbackgroundtexmatrix;
471
472         // various q3 shader features
473         q3shaderinfo_layer_rgbgen_t rgbgen;
474         q3shaderinfo_layer_alphagen_t alphagen;
475         q3shaderinfo_layer_tcgen_t tcgen;
476         q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
477         q3shaderinfo_layer_tcmod_t backgroundtcmods[Q3MAXTCMODS];
478         q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
479
480         qboolean colormapping;
481         rtexture_t *basetexture;
482         rtexture_t *glosstexture;
483         rtexture_t *backgroundbasetexture;
484         rtexture_t *backgroundglosstexture;
485         float specularscale;
486         float specularpower;
487         // color tint (colormod * currentalpha) used for rtlighting this material
488         float dlightcolor[3];
489         // color tint (colormod * 2) used for lightmapped lighting on this material
490         // includes alpha as 4th component
491         // replaces role of gl_Color in GLSL shader
492         float lightmapcolor[4];
493
494         // from q3 shaders
495         int customblendfunc[2];
496
497         int currentnumlayers;
498         texturelayer_t currentlayers[16];
499
500         // q3bsp
501         char name[64];
502         int surfaceflags;
503         int supercontents;
504         int surfaceparms;
505         int textureflags;
506
507         // reflection
508         float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
509         float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
510         float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
511         vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
512         float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
513         vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
514         float r_water_wateralpha; // additional wateralpha to apply when r_water is active
515 }
516 texture_t;
517
518 typedef struct mtexinfo_s
519 {
520         float vecs[2][4];
521         texture_t *texture;
522         int flags;
523 }
524 mtexinfo_t;
525
526 typedef struct msurface_lightmapinfo_s
527 {
528         // texture mapping properties used by this surface
529         mtexinfo_t *texinfo; // q1bsp
530         // index into r_refdef.scene.lightstylevalue array, 255 means not used (black)
531         unsigned char styles[MAXLIGHTMAPS]; // q1bsp
532         // RGB lighting data [numstyles][height][width][3]
533         unsigned char *samples; // q1bsp
534         // RGB normalmap data [numstyles][height][width][3]
535         unsigned char *nmapsamples; // q1bsp
536         // stain to apply on lightmap (soot/dirt/blood/whatever)
537         unsigned char *stainsamples; // q1bsp
538         int texturemins[2]; // q1bsp
539         int extents[2]; // q1bsp
540         int lightmaporigin[2]; // q1bsp
541 }
542 msurface_lightmapinfo_t;
543
544 struct q3deffect_s;
545 typedef struct msurface_s
546 {
547         // bounding box for onscreen checks
548         vec3_t mins;
549         vec3_t maxs;
550         // the texture to use on the surface
551         texture_t *texture;
552         // the lightmap texture fragment to use on the rendering mesh
553         rtexture_t *lightmaptexture;
554         // the lighting direction texture fragment to use on the rendering mesh
555         rtexture_t *deluxemaptexture;
556
557         // surfaces own ranges of vertices and triangles in the model->surfmesh
558         int num_triangles; // number of triangles
559         int num_firsttriangle; // first triangle
560         int num_vertices; // number of vertices
561         int num_firstvertex; // first vertex
562
563         // shadow volume building information
564         int num_firstshadowmeshtriangle; // index into model->brush.shadowmesh
565
566         // lightmaptexture rebuild information not used in q3bsp
567         msurface_lightmapinfo_t *lightmapinfo; // q1bsp
568
569         // mesh information for collisions (only used by q3bsp curves)
570         int num_collisiontriangles; // q3bsp
571         int *data_collisionelement3i; // q3bsp
572         int num_collisionvertices; // q3bsp
573         float *data_collisionvertex3f; // q3bsp
574         struct q3deffect_s *effect; // q3bsp
575         // FIXME: collisionmarkframe should be kept in a separate array
576         int collisionmarkframe; // q3bsp // don't collide twice in one trace
577
578         // optimization...
579         float *data_collisionbbox6f; // collision optimization - contains combined bboxes of every data_collisionstride triangles
580         int num_collisionbboxstride;
581         float *data_bbox6f; // collision optimization - contains combined bboxes of every data_collisionstride triangles
582         int num_bboxstride;
583 }
584 msurface_t;
585
586 #include "matrixlib.h"
587
588 #include "model_brush.h"
589 #include "model_sprite.h"
590 #include "model_alias.h"
591
592 typedef struct model_sprite_s
593 {
594         int                             sprnum_type;
595         mspriteframe_t  *sprdata_frames;
596 }
597 model_sprite_t;
598
599 struct trace_s;
600
601 typedef struct model_brush_lightstyleinfo_s
602 {
603         int style;
604         int value;
605         int numsurfaces;
606         int *surfacelist;
607 }
608 model_brush_lightstyleinfo_t;
609
610 typedef struct model_brush_s
611 {
612         // true if this model is a HalfLife .bsp file
613         qboolean ishlbsp;
614         // string of entity definitions (.map format)
615         char *entities;
616
617         // if not NULL this is a submodel
618         struct model_s *parentmodel;
619         // (this is the number of the submodel, an index into submodels)
620         int submodel;
621
622         // number of submodels in this map (just used by server to know how many
623         // submodels to load)
624         int numsubmodels;
625         // pointers to each of the submodels
626         struct model_s **submodels;
627
628         int num_planes;
629         mplane_t *data_planes;
630
631         int num_nodes;
632         mnode_t *data_nodes;
633
634         // visible leafs, not counting 0 (solid)
635         int num_visleafs;
636         // number of actual leafs (including 0 which is solid)
637         int num_leafs;
638         mleaf_t *data_leafs;
639
640         int num_leafbrushes;
641         int *data_leafbrushes;
642
643         int num_leafsurfaces;
644         int *data_leafsurfaces;
645
646         int num_portals;
647         mportal_t *data_portals;
648
649         int num_portalpoints;
650         mvertex_t *data_portalpoints;
651
652         int num_brushes;
653         q3mbrush_t *data_brushes;
654
655         int num_brushsides;
656         q3mbrushside_t *data_brushsides;
657
658         // pvs
659         int num_pvsclusters;
660         int num_pvsclusterbytes;
661         unsigned char *data_pvsclusters;
662         // example
663         //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
664         //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
665
666         // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
667         shadowmesh_t *shadowmesh;
668
669         // common functions
670         int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
671         int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
672         unsigned char *(*GetPVS)(struct model_s *model, const vec3_t p);
673         int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, unsigned char *pvsbuffer, int pvsbufferlength, qboolean merge);
674         int (*BoxTouchingPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
675         int (*BoxTouchingLeafPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
676         int (*BoxTouchingVisibleLeafs)(struct model_s *model, const unsigned char *visibleleafs, const vec3_t mins, const vec3_t maxs);
677         int (*FindBoxClusters)(struct model_s *model, const vec3_t mins, const vec3_t maxs, int maxclusters, int *clusterlist);
678         void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
679         void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
680         mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
681         // these are actually only found on brushq1, but NULL is handled gracefully
682         void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, unsigned char *out, int outsize);
683         void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
684         // trace a line of sight through this model (returns false if the line if sight is definitely blocked)
685         qboolean (*TraceLineOfSight)(struct model_s *model, const vec3_t start, const vec3_t end);
686
687         char skybox[MAX_QPATH];
688
689         rtexture_t *solidskytexture;
690         rtexture_t *alphaskytexture;
691
692         qboolean supportwateralpha;
693
694         // QuakeWorld
695         int qw_md4sum;
696         int qw_md4sum2;
697 }
698 model_brush_t;
699
700 typedef struct model_brushq1_s
701 {
702         dmodel_t                *submodels;
703
704         int                             numvertexes;
705         mvertex_t               *vertexes;
706
707         int                             numedges;
708         medge_t                 *edges;
709
710         int                             numtexinfo;
711         mtexinfo_t              *texinfo;
712
713         int                             numsurfedges;
714         int                             *surfedges;
715
716         int                             numclipnodes;
717         mclipnode_t             *clipnodes;
718
719         hull_t                  hulls[MAX_MAP_HULLS];
720
721         int                             num_compressedpvs;
722         unsigned char                   *data_compressedpvs;
723
724         int                             num_lightdata;
725         unsigned char                   *lightdata;
726         unsigned char                   *nmaplightdata; // deluxemap file
727
728         // lightmap update chains for light styles
729         int                             num_lightstyles;
730         model_brush_lightstyleinfo_t *data_lightstyleinfo;
731
732         // this contains bytes that are 1 if a surface needs its lightmap rebuilt
733         unsigned char *lightmapupdateflags;
734 }
735 model_brushq1_t;
736
737 /* MSVC can't compile empty structs, so this is commented out for now
738 typedef struct model_brushq2_s
739 {
740 }
741 model_brushq2_t;
742 */
743
744 typedef struct model_brushq3_s
745 {
746         int num_models;
747         q3dmodel_t *data_models;
748
749         // used only during loading - freed after loading!
750         int num_vertices;
751         float *data_vertex3f;
752         float *data_normal3f;
753         float *data_texcoordtexture2f;
754         float *data_texcoordlightmap2f;
755         float *data_color4f;
756
757         // freed after loading!
758         int num_triangles;
759         int *data_element3i;
760
761         int num_effects;
762         q3deffect_t *data_effects;
763
764         // lightmap textures
765         int num_originallightmaps;
766         int num_mergedlightmaps;
767         int num_lightmapmergepower;
768         int num_lightmapmerge;
769         rtexture_t **data_lightmaps;
770         rtexture_t **data_deluxemaps;
771
772         // voxel light data with directional shading
773         int num_lightgrid;
774         q3dlightgrid_t *data_lightgrid;
775         // size of each cell (may vary by map, typically 64 64 128)
776         float num_lightgrid_cellsize[3];
777         // 1.0 / num_lightgrid_cellsize
778         float num_lightgrid_scale[3];
779         // dimensions of the world model in lightgrid cells
780         int num_lightgrid_imins[3];
781         int num_lightgrid_imaxs[3];
782         int num_lightgrid_isize[3];
783         // transform modelspace coordinates to lightgrid index
784         matrix4x4_t num_lightgrid_indexfromworld;
785
786         // true if this q3bsp file has been detected as using deluxemapping
787         // (lightmap texture pairs, every odd one is never directly refernced,
788         //  and contains lighting normals, not colors)
789         qboolean deluxemapping;
790         // true if the detected deluxemaps are the modelspace kind, rather than
791         // the faster tangentspace kind
792         qboolean deluxemapping_modelspace;
793         // size of lightmaps (128 by default, but may be another poweroftwo if
794         // external lightmaps are used (q3map2 -lightmapsize)
795         int lightmapsize;
796 }
797 model_brushq3_t;
798
799 struct frameblend_s;
800
801 typedef struct model_s
802 {
803         // name and path of model, for example "progs/player.mdl"
804         char                    name[MAX_QPATH];
805         // model needs to be loaded if this is false
806         qboolean                loaded;
807         // set if the model is used in current map, models which are not, are purged
808         qboolean                used;
809         // CRC of the file this model was loaded from, to reload if changed
810         unsigned int    crc;
811         // mod_brush, mod_alias, mod_sprite
812         modtype_t               type;
813         // memory pool for allocations
814         mempool_t               *mempool;
815         // all models use textures...
816         rtexturepool_t  *texturepool;
817         // EF_* flags (translated from the model file's different flags layout)
818         int                             effects;
819         // number of QC accessible frame(group)s in the model
820         int                             numframes;
821         // number of QC accessible skin(group)s in the model
822         int                             numskins;
823         // whether to randomize animated framegroups
824         synctype_t              synctype;
825         // bounding box at angles '0 0 0'
826         vec3_t                  normalmins, normalmaxs;
827         // bounding box if yaw angle is not 0, but pitch and roll are
828         vec3_t                  yawmins, yawmaxs;
829         // bounding box if pitch or roll are used
830         vec3_t                  rotatedmins, rotatedmaxs;
831         // sphere radius, usable at any angles
832         float                   radius;
833         // squared sphere radius for easier comparisons
834         float                   radius2;
835         // skin animation info
836         animscene_t             *skinscenes; // [numskins]
837         // skin animation info
838         animscene_t             *animscenes; // [numframes]
839         // range of surface numbers in this (sub)model
840         int                             firstmodelsurface;
841         int                             nummodelsurfaces;
842         int                             *sortedmodelsurfaces;
843         // range of collision brush numbers in this (sub)model
844         int                             firstmodelbrush;
845         int                             nummodelbrushes;
846         // list of surface numbers in this (sub)model
847         int                             *surfacelist;
848         // for md3 models
849         int                             num_tags;
850         int                             num_tagframes;
851         aliastag_t              *data_tags;
852         // for skeletal models
853         int                             num_bones;
854         aliasbone_t             *data_bones;
855         int                             num_poses;
856         float                   *data_poses;
857         float                   *data_baseboneposeinverse;
858         // textures of this model
859         int                             num_textures;
860         int                             num_texturesperskin;
861         texture_t               *data_textures;
862         // surfaces of this model
863         int                             num_surfaces;
864         msurface_t              *data_surfaces;
865         // optional lightmapinfo data for surface lightmap updates
866         msurface_lightmapinfo_t *data_surfaces_lightmapinfo;
867         // all surfaces belong to this mesh
868         surfmesh_t              surfmesh;
869         // data type of model
870         const char              *modeldatatypestring;
871         // generates vertex data for a given frameblend
872         void(*AnimateVertices)(const struct model_s *model, const struct frameblend_s *frameblend, float *vertex3f, float *normal3f, float *svector3f, float *tvector3f);
873         // draw the model's sky polygons (only used by brush models)
874         void(*DrawSky)(struct entity_render_s *ent);
875         // draw refraction/reflection textures for the model's water polygons (only used by brush models)
876         void(*DrawAddWaterPlanes)(struct entity_render_s *ent);
877         // draw the model using lightmap/dlight shading
878         void(*Draw)(struct entity_render_s *ent);
879         // draw the model to the depth buffer (no color rendering at all)
880         void(*DrawDepth)(struct entity_render_s *ent);
881         // draw any enabled debugging effects on this model (such as showing triangles, normals, collision brushes...)
882         void(*DrawDebug)(struct entity_render_s *ent);
883         // draw depth into a shadowmap
884         void(*DrawShadowMap)(struct entity_render_s *ent, const vec3_t relativelightorigin, const vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist, const vec3_t lightmins, const vec3_t lightmaxs);
885         // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
886         void(*GetLightInfo)(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius, vec3_t outmins, vec3_t outmaxs, int *outleaflist, unsigned char *outleafpvs, int *outnumleafspointer, int *outsurfacelist, unsigned char *outsurfacepvs, int *outnumsurfacespointer, unsigned char *outshadowtrispvs, unsigned char *outlighttrispvs, unsigned char *visitingleafpvs);
887         // compile a shadow volume for the model based on light source
888         void(*CompileShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
889         // draw a shadow volume for the model based on light source
890         void(*DrawShadowVolume)(struct entity_render_s *ent, const vec3_t relativelightorigin, const vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist, const vec3_t lightmins, const vec3_t lightmaxs);
891         // draw the lighting on a model (through stencil)
892         void(*DrawLight)(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
893         // trace a box against this model
894         void (*TraceBox)(struct model_s *model, int frame, struct trace_s *trace, const vec3_t start, const vec3_t boxmins, const vec3_t boxmaxs, const vec3_t end, int hitsupercontentsmask);
895         // find the supercontents value at a point in this model
896         int (*PointSuperContents)(struct model_s *model, int frame, const vec3_t point);
897         // fields belonging to some types of model
898         model_sprite_t  sprite;
899         model_brush_t   brush;
900         model_brushq1_t brushq1;
901         /* MSVC can't handle an empty struct, so this is commented out for now
902         model_brushq2_t brushq2;
903         */
904         model_brushq3_t brushq3;
905         // flags this model for offseting sounds to the model center (used by brush models)
906         int soundfromcenter;
907 }
908 dp_model_t;
909
910 //============================================================================
911
912 // model loading
913 extern dp_model_t *loadmodel;
914 extern unsigned char *mod_base;
915 // sky/water subdivision
916 //extern cvar_t gl_subdivide_size;
917 // texture fullbrights
918 extern cvar_t r_fullbrights;
919
920 void Mod_Init (void);
921 void Mod_Reload (void);
922 dp_model_t *Mod_LoadModel(dp_model_t *mod, qboolean crash, qboolean checkdisk);
923 dp_model_t *Mod_FindName (const char *name, const char *parentname);
924 dp_model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, const char *parentname);
925 void Mod_UnloadModel (dp_model_t *mod);
926
927 void Mod_ClearUsed(void);
928 void Mod_PurgeUnused(void);
929 void Mod_RemoveStaleWorldModels(dp_model_t *skip); // only used during loading!
930
931 extern dp_model_t *loadmodel;
932 extern char loadname[32];       // for hunk tags
933
934 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
935 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
936 void Mod_ValidateElements(int *elements, int numtriangles, int firstvertex, int numverts, const char *filename, int fileline);
937 void Mod_BuildNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const int *elements, float *normal3f, qboolean areaweighting);
938 void Mod_BuildTextureVectorsFromNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const float *texcoord2f, const float *normal3f, const int *elements, float *svector3f, float *tvector3f, qboolean areaweighting);
939
940 void Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, qboolean lightmapoffsets, qboolean vertexcolors, qboolean neighbors);
941 void Mod_MakeSortedSurfaces(dp_model_t *mod);
942
943 shadowmesh_t *Mod_ShadowMesh_Alloc(mempool_t *mempool, int maxverts, int maxtriangles, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, int light, int neighbors, int expandable);
944 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
945 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
946 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
947 void Mod_ShadowMesh_AddMesh(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, const float *vertex3f, const float *svector3f, const float *tvector3f, const float *normal3f, const float *texcoord2f, int numtris, const int *element3i);
948 shadowmesh_t *Mod_ShadowMesh_Begin(mempool_t *mempool, int maxverts, int maxtriangles, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, int light, int neighbors, int expandable);
949 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, qboolean light, qboolean neighbors, qboolean createvbo);
950 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
951 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
952
953 void Mod_FreeQ3Shaders(void);
954 void Mod_LoadQ3Shaders(void);
955 q3shaderinfo_t *Mod_LookupQ3Shader(const char *name);
956 qboolean Mod_LoadTextureFromQ3Shader(texture_t *texture, const char *name, qboolean warnmissing, qboolean fallback, int defaulttexflags);
957
958 extern cvar_t r_mipskins;
959
960 typedef struct skinfileitem_s
961 {
962         struct skinfileitem_s *next;
963         char name[MAX_QPATH];
964         char replacement[MAX_QPATH];
965 }
966 skinfileitem_t;
967
968 typedef struct skinfile_s
969 {
970         struct skinfile_s *next;
971         skinfileitem_t *items;
972 }
973 skinfile_t;
974
975 skinfile_t *Mod_LoadSkinFiles(void);
976 void Mod_FreeSkinFiles(skinfile_t *skinfile);
977 int Mod_CountSkinFiles(skinfile_t *skinfile);
978
979 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
980 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
981 void Mod_VertexRangeFromElements(int numelements, const int *elements, int *firstvertexpointer, int *lastvertexpointer);
982
983 // bsp models
984 void Mod_BrushInit(void);
985 // used for talking to the QuakeC mainly
986 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
987 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
988
989 // a lot of model formats use the Q1BSP code, so here are the prototypes...
990 struct entity_render_s;
991 void R_Q1BSP_DrawAddWaterPlanes(struct entity_render_s *ent);
992 void R_Q1BSP_DrawSky(struct entity_render_s *ent);
993 void R_Q1BSP_Draw(struct entity_render_s *ent);
994 void R_Q1BSP_DrawDepth(struct entity_render_s *ent);
995 void R_Q1BSP_DrawDebug(struct entity_render_s *ent);
996 void R_Q1BSP_GetLightInfo(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius, vec3_t outmins, vec3_t outmaxs, int *outleaflist, unsigned char *outleafpvs, int *outnumleafspointer, int *outsurfacelist, unsigned char *outsurfacepvs, int *outnumsurfacespointer, unsigned char *outshadowtrispvs, unsigned char *outlighttrispvs, unsigned char *visitingleafpvs);
997 void R_Q1BSP_DrawShadowMap(struct entity_render_s *ent, const vec3_t relativelightorigin, const vec3_t relativelightdirection, float lightradius, int modelnumsurfaces, const int *modelsurfacelist, const vec3_t lightmins, const vec3_t lightmaxs);
998 void R_Q1BSP_CompileShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
999 void R_Q1BSP_DrawShadowVolume(struct entity_render_s *ent, const vec3_t relativelightorigin, const vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist, const vec3_t lightmins, const vec3_t lightmaxs);
1000 void R_Q1BSP_DrawLight(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
1001
1002 // alias models
1003 struct frameblend_s;
1004 void Mod_AliasInit(void);
1005 int Mod_Alias_GetTagMatrix(const dp_model_t *model, int poseframe, int tagindex, matrix4x4_t *outmatrix);
1006 int Mod_Alias_GetTagIndexForName(const dp_model_t *model, unsigned int skin, const char *tagname);
1007 int Mod_Alias_GetExtendedTagInfoForIndex(const dp_model_t *model, unsigned int skin, int poseframe, int tagindex, int *parentindex, const char **tagname, matrix4x4_t *tag_localmatrix);
1008
1009 // sprite models
1010 void Mod_SpriteInit(void);
1011
1012 // loaders
1013 void Mod_Q1BSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1014 void Mod_IBSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1015 void Mod_MAP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1016 void Mod_OBJ_Load(dp_model_t *mod, void *buffer, void *bufferend);
1017 void Mod_IDP0_Load(dp_model_t *mod, void *buffer, void *bufferend);
1018 void Mod_IDP2_Load(dp_model_t *mod, void *buffer, void *bufferend);
1019 void Mod_IDP3_Load(dp_model_t *mod, void *buffer, void *bufferend);
1020 void Mod_ZYMOTICMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1021 void Mod_DARKPLACESMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1022 void Mod_PSKMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1023 void Mod_IDSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1024 void Mod_IDS2_Load(dp_model_t *mod, void *buffer, void *bufferend);
1025
1026 // utility
1027 qboolean Mod_CanSeeBox_Trace(int numsamples, float t, dp_model_t *model, vec3_t eye, vec3_t minsX, vec3_t maxsX);
1028
1029 #endif  // MODEL_SHARED_H
1030