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