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