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