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