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