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