huge audit of dprints throughout engine, all notices of successfully
[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         int texflags;
345         char** texturename;
346         int blendfunc[2];
347         q3shaderinfo_layer_rgbgen_t rgbgen;
348         q3shaderinfo_layer_alphagen_t alphagen;
349         q3shaderinfo_layer_tcgen_t tcgen;
350         q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
351 }
352 q3shaderinfo_layer_t;
353
354 typedef struct q3shaderinfo_deform_s
355 {
356         q3deform_t deform;
357         float parms[Q3DEFORM_MAXPARMS];
358         q3wavefunc_t wavefunc;
359         float waveparms[Q3WAVEPARMS];
360 }
361 q3shaderinfo_deform_t;
362
363 typedef struct q3shaderinfo_s
364 {
365         char name[Q3PATHLENGTH];
366         int surfaceparms;
367         int textureflags;
368         int numlayers;
369         qboolean lighting;
370         qboolean vertexalpha;
371         qboolean textureblendalpha;
372         int primarylayer, backgroundlayer;
373         q3shaderinfo_layer_t layers[Q3SHADER_MAXLAYERS];
374         char skyboxname[Q3PATHLENGTH];
375         q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
376
377         // reflection
378         float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
379         float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
380         float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
381         vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
382         float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
383         vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
384         float r_water_wateralpha; // additional wateralpha to apply when r_water is active
385 }
386 q3shaderinfo_t;
387
388 typedef enum texturelayertype_e
389 {
390         TEXTURELAYERTYPE_INVALID,
391         TEXTURELAYERTYPE_LITTEXTURE,
392         TEXTURELAYERTYPE_TEXTURE,
393         TEXTURELAYERTYPE_FOG,
394 }
395 texturelayertype_t;
396
397 typedef enum texturelayerflag_e
398 {
399         // indicates that the pass should apply fog darkening; used on
400         // transparent surfaces where simply blending an alpha fog as a final
401         // pass would not behave properly, so all the surfaces must be darkened,
402         // and the fog color added as a separate pass
403         TEXTURELAYERFLAG_FOGDARKEN = 1,
404 }
405 texturelayerflag_t;
406
407 typedef struct texturelayer_s
408 {
409         texturelayertype_t type;
410         qboolean depthmask;
411         int blendfunc1;
412         int blendfunc2;
413         rtexture_t *texture;
414         matrix4x4_t texmatrix;
415         vec4_t color;
416         int flags;
417 }
418 texturelayer_t;
419
420 typedef struct texture_s
421 {
422         // q1bsp
423         // name
424         //char name[16];
425         // size
426         unsigned int width, height;
427         // SURF_ flags
428         //unsigned int flags;
429
430         // base material flags
431         int basematerialflags;
432         // current material flags (updated each bmodel render)
433         int currentmaterialflags;
434
435         // PolygonOffset values for rendering this material
436         // (these are added to the r_refdef values and submodel values)
437         float biaspolygonfactor;
438         float biaspolygonoffset;
439
440         // textures to use when rendering this material
441         skinframe_t *currentskinframe;
442         int numskinframes;
443         float skinframerate;
444         skinframe_t *skinframes[TEXTURE_MAXFRAMES];
445         // background layer (for terrain texture blending)
446         skinframe_t *backgroundcurrentskinframe;
447         int backgroundnumskinframes;
448         float backgroundskinframerate;
449         skinframe_t *backgroundskinframes[TEXTURE_MAXFRAMES];
450
451         // total frames in sequence and alternate sequence
452         int anim_total[2];
453         // direct pointers to each of the frames in the sequences
454         // (indexed as [alternate][frame])
455         struct texture_s *anim_frames[2][10];
456         // set if animated or there is an alternate frame set
457         // (this is an optimization in the renderer)
458         int animated;
459
460         // the current alpha of this texture (may be affected by r_wateralpha)
461         float currentalpha;
462         // the current texture frame in animation
463         struct texture_s *currentframe;
464         // current texture transform matrix (used for water scrolling)
465         matrix4x4_t currenttexmatrix;
466
467         // various q3 shader features
468         q3shaderinfo_layer_rgbgen_t rgbgen;
469         q3shaderinfo_layer_alphagen_t alphagen;
470         q3shaderinfo_layer_tcgen_t tcgen;
471         q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
472         q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
473
474         qboolean colormapping;
475         rtexture_t *basetexture;
476         rtexture_t *glosstexture;
477         rtexture_t *backgroundbasetexture;
478         rtexture_t *backgroundglosstexture;
479         float specularscale;
480         float specularpower;
481         // color tint (colormod * currentalpha) used for rtlighting this material
482         float dlightcolor[3];
483         // color tint (colormod * 2) used for lightmapped lighting on this material
484         // includes alpha as 4th component
485         // replaces role of gl_Color in GLSL shader
486         float lightmapcolor[4];
487
488         // from q3 shaders
489         int customblendfunc[2];
490
491         int currentnumlayers;
492         texturelayer_t currentlayers[16];
493
494         // q3bsp
495         char name[64];
496         int surfaceflags;
497         int supercontents;
498         int surfaceparms;
499         int textureflags;
500
501         // reflection
502         float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
503         float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
504         float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
505         vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
506         float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
507         vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
508         float r_water_wateralpha; // additional wateralpha to apply when r_water is active
509 }
510 texture_t;
511
512 typedef struct mtexinfo_s
513 {
514         float vecs[2][4];
515         texture_t *texture;
516         int flags;
517 }
518 mtexinfo_t;
519
520 typedef struct msurface_lightmapinfo_s
521 {
522         // texture mapping properties used by this surface
523         mtexinfo_t *texinfo; // q1bsp
524         // index into r_refdef.scene.lightstylevalue array, 255 means not used (black)
525         unsigned char styles[MAXLIGHTMAPS]; // q1bsp
526         // RGB lighting data [numstyles][height][width][3]
527         unsigned char *samples; // q1bsp
528         // RGB normalmap data [numstyles][height][width][3]
529         unsigned char *nmapsamples; // q1bsp
530         // stain to apply on lightmap (soot/dirt/blood/whatever)
531         unsigned char *stainsamples; // q1bsp
532         int texturemins[2]; // q1bsp
533         int extents[2]; // q1bsp
534         int lightmaporigin[2]; // q1bsp
535 }
536 msurface_lightmapinfo_t;
537
538 struct q3deffect_s;
539 typedef struct msurface_s
540 {
541         // bounding box for onscreen checks
542         vec3_t mins;
543         vec3_t maxs;
544         // the texture to use on the surface
545         texture_t *texture;
546         // the lightmap texture fragment to use on the rendering mesh
547         rtexture_t *lightmaptexture;
548         // the lighting direction texture fragment to use on the rendering mesh
549         rtexture_t *deluxemaptexture;
550
551         // surfaces own ranges of vertices and triangles in the model->surfmesh
552         int num_triangles; // number of triangles
553         int num_firsttriangle; // first triangle
554         int num_vertices; // number of vertices
555         int num_firstvertex; // first vertex
556
557         // shadow volume building information
558         int num_firstshadowmeshtriangle; // index into model->brush.shadowmesh
559
560         // lightmaptexture rebuild information not used in q3bsp
561         int cached_dlight; // q1bsp // forces rebuild of lightmaptexture
562         msurface_lightmapinfo_t *lightmapinfo; // q1bsp
563
564         // mesh information for collisions (only used by q3bsp curves)
565         int num_collisiontriangles; // q3bsp
566         int *data_collisionelement3i; // q3bsp
567         int num_collisionvertices; // q3bsp
568         float *data_collisionvertex3f; // q3bsp
569         struct q3deffect_s *effect; // q3bsp
570         // FIXME: collisionmarkframe should be kept in a separate array
571         int collisionmarkframe; // q3bsp // don't collide twice in one trace
572 }
573 msurface_t;
574
575 #include "matrixlib.h"
576
577 #include "model_brush.h"
578 #include "model_sprite.h"
579 #include "model_alias.h"
580
581 typedef struct model_sprite_s
582 {
583         int                             sprnum_type;
584         mspriteframe_t  *sprdata_frames;
585 }
586 model_sprite_t;
587
588 struct trace_s;
589
590 typedef struct model_brush_lightstyleinfo_s
591 {
592         int style;
593         int value;
594         int numsurfaces;
595         int *surfacelist;
596 }
597 model_brush_lightstyleinfo_t;
598
599 typedef struct model_brush_s
600 {
601         // true if this model is a HalfLife .bsp file
602         qboolean ishlbsp;
603         // string of entity definitions (.map format)
604         char *entities;
605
606         // if non-zero this is a submodel
607         // (this is the number of the submodel, an index into submodels)
608         int submodel;
609
610         // number of submodels in this map (just used by server to know how many
611         // submodels to load)
612         int numsubmodels;
613         // pointers to each of the submodels if .isworldmodel is true
614         struct model_s **submodels;
615
616         int num_planes;
617         mplane_t *data_planes;
618
619         int num_nodes;
620         mnode_t *data_nodes;
621
622         // visible leafs, not counting 0 (solid)
623         int num_visleafs;
624         // number of actual leafs (including 0 which is solid)
625         int num_leafs;
626         mleaf_t *data_leafs;
627
628         int num_leafbrushes;
629         int *data_leafbrushes;
630
631         int num_leafsurfaces;
632         int *data_leafsurfaces;
633
634         int num_portals;
635         mportal_t *data_portals;
636
637         int num_portalpoints;
638         mvertex_t *data_portalpoints;
639
640         int num_brushes;
641         q3mbrush_t *data_brushes;
642
643         int num_brushsides;
644         q3mbrushside_t *data_brushsides;
645
646         // pvs
647         int num_pvsclusters;
648         int num_pvsclusterbytes;
649         unsigned char *data_pvsclusters;
650         // example
651         //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
652         //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
653
654         // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
655         shadowmesh_t *shadowmesh;
656
657         // common functions
658         int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
659         int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
660         unsigned char *(*GetPVS)(struct model_s *model, const vec3_t p);
661         int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, unsigned char *pvsbuffer, int pvsbufferlength, qboolean merge);
662         int (*BoxTouchingPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
663         int (*BoxTouchingLeafPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
664         int (*BoxTouchingVisibleLeafs)(struct model_s *model, const unsigned char *visibleleafs, const vec3_t mins, const vec3_t maxs);
665         int (*FindBoxClusters)(struct model_s *model, const vec3_t mins, const vec3_t maxs, int maxclusters, int *clusterlist);
666         void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
667         void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
668         mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
669         // these are actually only found on brushq1, but NULL is handled gracefully
670         void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, unsigned char *out, int outsize);
671         void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
672         // trace a line of sight through this model (returns false if the line if sight is definitely blocked)
673         qboolean (*TraceLineOfSight)(struct model_s *model, const vec3_t start, const vec3_t end);
674
675         char skybox[MAX_QPATH];
676
677         rtexture_t *solidskytexture;
678         rtexture_t *alphaskytexture;
679
680         qboolean supportwateralpha;
681
682         // QuakeWorld
683         int qw_md4sum;
684         int qw_md4sum2;
685 }
686 model_brush_t;
687
688 typedef struct model_brushq1_s
689 {
690         dmodel_t                *submodels;
691
692         int                             numvertexes;
693         mvertex_t               *vertexes;
694
695         int                             numedges;
696         medge_t                 *edges;
697
698         int                             numtexinfo;
699         mtexinfo_t              *texinfo;
700
701         int                             numsurfedges;
702         int                             *surfedges;
703
704         int                             numclipnodes;
705         mclipnode_t             *clipnodes;
706
707         hull_t                  hulls[MAX_MAP_HULLS];
708
709         int                             num_compressedpvs;
710         unsigned char                   *data_compressedpvs;
711
712         int                             num_lightdata;
713         unsigned char                   *lightdata;
714         unsigned char                   *nmaplightdata; // deluxemap file
715
716         // lightmap update chains for light styles
717         int                             num_lightstyles;
718         model_brush_lightstyleinfo_t *data_lightstyleinfo;
719 }
720 model_brushq1_t;
721
722 /* MSVC can't compile empty structs, so this is commented out for now
723 typedef struct model_brushq2_s
724 {
725 }
726 model_brushq2_t;
727 */
728
729 typedef struct model_brushq3_s
730 {
731         int num_models;
732         q3dmodel_t *data_models;
733
734         // used only during loading - freed after loading!
735         int num_vertices;
736         float *data_vertex3f;
737         float *data_normal3f;
738         float *data_texcoordtexture2f;
739         float *data_texcoordlightmap2f;
740         float *data_color4f;
741
742         // freed after loading!
743         int num_triangles;
744         int *data_element3i;
745
746         int num_effects;
747         q3deffect_t *data_effects;
748
749         // lightmap textures
750         int num_originallightmaps;
751         int num_mergedlightmaps;
752         int num_lightmapmergepower;
753         int num_lightmapmerge;
754         rtexture_t **data_lightmaps;
755         rtexture_t **data_deluxemaps;
756
757         // voxel light data with directional shading
758         int num_lightgrid;
759         q3dlightgrid_t *data_lightgrid;
760         // size of each cell (may vary by map, typically 64 64 128)
761         float num_lightgrid_cellsize[3];
762         // 1.0 / num_lightgrid_cellsize
763         float num_lightgrid_scale[3];
764         // dimensions of the world model in lightgrid cells
765         int num_lightgrid_imins[3];
766         int num_lightgrid_imaxs[3];
767         int num_lightgrid_isize[3];
768         // indexing/clamping
769         int num_lightgrid_dimensions[3];
770         // transform modelspace coordinates to lightgrid index
771         matrix4x4_t num_lightgrid_indexfromworld;
772
773         // true if this q3bsp file has been detected as using deluxemapping
774         // (lightmap texture pairs, every odd one is never directly refernced,
775         //  and contains lighting normals, not colors)
776         qboolean deluxemapping;
777         // true if the detected deluxemaps are the modelspace kind, rather than
778         // the faster tangentspace kind
779         qboolean deluxemapping_modelspace;
780 }
781 model_brushq3_t;
782
783 typedef struct model_s
784 {
785         // name and path of model, for example "progs/player.mdl"
786         char                    name[MAX_QPATH];
787         // model needs to be loaded if this is false
788         qboolean                loaded;
789         // set if the model is used in current map, models which are not, are purged
790         qboolean                used;
791         // true if this is the world model (I.E. defines what sky to use, and may contain submodels)
792         qboolean                isworldmodel;
793         // CRC of the file this model was loaded from, to reload if changed
794         unsigned int    crc;
795         // mod_brush, mod_alias, mod_sprite
796         modtype_t               type;
797         // memory pool for allocations
798         mempool_t               *mempool;
799         // all models use textures...
800         rtexturepool_t  *texturepool;
801         // EF_* flags (translated from the model file's different flags layout)
802         int                             effects;
803         // number of QC accessible frame(group)s in the model
804         int                             numframes;
805         // number of QC accessible skin(group)s in the model
806         int                             numskins;
807         // whether to randomize animated framegroups
808         synctype_t              synctype;
809         // bounding box at angles '0 0 0'
810         vec3_t                  normalmins, normalmaxs;
811         // bounding box if yaw angle is not 0, but pitch and roll are
812         vec3_t                  yawmins, yawmaxs;
813         // bounding box if pitch or roll are used
814         vec3_t                  rotatedmins, rotatedmaxs;
815         // sphere radius, usable at any angles
816         float                   radius;
817         // squared sphere radius for easier comparisons
818         float                   radius2;
819         // skin animation info
820         animscene_t             *skinscenes; // [numskins]
821         // skin animation info
822         animscene_t             *animscenes; // [numframes]
823         // range of surface numbers in this (sub)model
824         int                             firstmodelsurface;
825         int                             nummodelsurfaces;
826         // range of collision brush numbers in this (sub)model
827         int                             firstmodelbrush;
828         int                             nummodelbrushes;
829         // list of surface numbers in this (sub)model
830         int                             *surfacelist;
831         // for md3 models
832         int                             num_tags;
833         int                             num_tagframes;
834         aliastag_t              *data_tags;
835         // for skeletal models
836         int                             num_bones;
837         aliasbone_t             *data_bones;
838         int                             num_poses;
839         float                   *data_poses;
840         float                   *data_baseboneposeinverse;
841         // textures of this model
842         int                             num_textures;
843         int                             num_texturesperskin;
844         texture_t               *data_textures;
845         // surfaces of this model
846         int                             num_surfaces;
847         msurface_t              *data_surfaces;
848         // optional lightmapinfo data for surface lightmap updates
849         msurface_lightmapinfo_t *data_surfaces_lightmapinfo;
850         // all surfaces belong to this mesh
851         surfmesh_t              surfmesh;
852         // data type of model
853         const char              *modeldatatypestring;
854         // draw the model's sky polygons (only used by brush models)
855         void(*DrawSky)(struct entity_render_s *ent);
856         // draw refraction/reflection textures for the model's water polygons (only used by brush models)
857         void(*DrawAddWaterPlanes)(struct entity_render_s *ent);
858         // draw the model using lightmap/dlight shading
859         void(*Draw)(struct entity_render_s *ent);
860         // draw the model to the depth buffer (no color rendering at all)
861         void(*DrawDepth)(struct entity_render_s *ent);
862         // draw any enabled debugging effects on this model (such as showing triangles, normals, collision brushes...)
863         void(*DrawDebug)(struct entity_render_s *ent);
864         // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
865         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);
866         // compile a shadow volume for the model based on light source
867         void(*CompileShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
868         // draw a shadow volume for the model based on light source
869         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);
870         // draw the lighting on a model (through stencil)
871         void(*DrawLight)(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
872         // trace a box against this model
873         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);
874         // find the supercontents value at a point in this model
875         int (*PointSuperContents)(struct model_s *model, int frame, const vec3_t point);
876         // fields belonging to some types of model
877         model_sprite_t  sprite;
878         model_brush_t   brush;
879         model_brushq1_t brushq1;
880         /* MSVC can't handle an empty struct, so this is commented out for now
881         model_brushq2_t brushq2;
882         */
883         model_brushq3_t brushq3;
884         // skin files can have different tags for each skin
885         overridetagnameset_t    *data_overridetagnamesforskin;
886         // flags this model for offseting sounds to the model center (used by brush models)
887         int soundfromcenter;
888 }
889 model_t;
890
891 //============================================================================
892
893 // model loading
894 extern model_t *loadmodel;
895 extern unsigned char *mod_base;
896 // sky/water subdivision
897 //extern cvar_t gl_subdivide_size;
898 // texture fullbrights
899 extern cvar_t r_fullbrights;
900
901 void Mod_Init (void);
902 void Mod_Reload (void);
903 model_t *Mod_LoadModel(model_t *mod, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
904 model_t *Mod_FindName (const char *name);
905 model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
906 void Mod_UnloadModel (model_t *mod);
907
908 void Mod_ClearUsed(void);
909 void Mod_PurgeUnused(void);
910 void Mod_RemoveStaleWorldModels(model_t *skip); // only used during loading!
911
912 extern model_t *loadmodel;
913 extern char loadname[32];       // for hunk tags
914
915 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
916 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
917 void Mod_ValidateElements(int *elements, int numtriangles, int firstvertex, int numverts, const char *filename, int fileline);
918 void Mod_BuildNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const int *elements, float *normal3f, qboolean areaweighting);
919 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);
920
921 void Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, qboolean lightmapoffsets, qboolean vertexcolors, qboolean neighbors);
922
923 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);
924 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
925 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
926 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
927 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);
928 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);
929 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, qboolean light, qboolean neighbors, qboolean createvbo);
930 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
931 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
932
933 void Mod_LoadQ3Shaders(void);
934 q3shaderinfo_t *Mod_LookupQ3Shader(const char *name);
935 qboolean Mod_LoadTextureFromQ3Shader(texture_t *texture, const char *name, qboolean warnmissing, qboolean fallback, int defaulttexflags);
936
937 extern cvar_t r_mipskins;
938
939 typedef struct skinfileitem_s
940 {
941         struct skinfileitem_s *next;
942         char name[MAX_QPATH];
943         char replacement[MAX_QPATH];
944 }
945 skinfileitem_t;
946
947 typedef struct skinfile_s
948 {
949         struct skinfile_s *next;
950         skinfileitem_t *items;
951 }
952 skinfile_t;
953
954 skinfile_t *Mod_LoadSkinFiles(void);
955 void Mod_FreeSkinFiles(skinfile_t *skinfile);
956 int Mod_CountSkinFiles(skinfile_t *skinfile);
957
958 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
959 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
960 void Mod_VertexRangeFromElements(int numelements, const int *elements, int *firstvertexpointer, int *lastvertexpointer);
961
962 // bsp models
963 void Mod_BrushInit(void);
964 // used for talking to the QuakeC mainly
965 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
966 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
967
968 // a lot of model formats use the Q1BSP code, so here are the prototypes...
969 struct entity_render_s;
970 void R_Q1BSP_DrawAddWaterPlanes(struct entity_render_s *ent);
971 void R_Q1BSP_DrawSky(struct entity_render_s *ent);
972 void R_Q1BSP_Draw(struct entity_render_s *ent);
973 void R_Q1BSP_DrawDepth(struct entity_render_s *ent);
974 void R_Q1BSP_DrawDebug(struct entity_render_s *ent);
975 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);
976 void R_Q1BSP_CompileShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
977 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);
978 void R_Q1BSP_DrawLight(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
979
980 // alias models
981 struct frameblend_s;
982 void Mod_AliasInit(void);
983 void Mod_Alias_GetMesh_Vertices(const model_t *model, const struct frameblend_s *frameblend, float *vertex3f, float *normal3f, float *svector3f, float *tvector3f);
984 int Mod_Alias_GetTagMatrix(const model_t *model, int poseframe, int tagindex, matrix4x4_t *outmatrix);
985 int Mod_Alias_GetTagIndexForName(const model_t *model, unsigned int skin, const char *tagname);
986
987 // sprite models
988 void Mod_SpriteInit(void);
989
990 // loaders
991 void Mod_Q1BSP_Load(model_t *mod, void *buffer, void *bufferend);
992 void Mod_IBSP_Load(model_t *mod, void *buffer, void *bufferend);
993 void Mod_MAP_Load(model_t *mod, void *buffer, void *bufferend);
994 void Mod_IDP0_Load(model_t *mod, void *buffer, void *bufferend);
995 void Mod_IDP2_Load(model_t *mod, void *buffer, void *bufferend);
996 void Mod_IDP3_Load(model_t *mod, void *buffer, void *bufferend);
997 void Mod_ZYMOTICMODEL_Load(model_t *mod, void *buffer, void *bufferend);
998 void Mod_DARKPLACESMODEL_Load(model_t *mod, void *buffer, void *bufferend);
999 void Mod_PSKMODEL_Load(model_t *mod, void *buffer, void *bufferend);
1000 void Mod_IDSP_Load(model_t *mod, void *buffer, void *bufferend);
1001 void Mod_IDS2_Load(model_t *mod, void *buffer, void *bufferend);
1002
1003 // utility
1004 qboolean Mod_CanSeeBox_Trace(int numsamples, float t, model_t *model, vec3_t eye, vec3_t minsX, vec3_t maxsX);
1005
1006 #endif  // MODEL_SHARED_H
1007