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