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