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