implemented tcmod (all forms)
[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 #define Q3PATHLENGTH 64
186 #define TEXTURE_MAXFRAMES 64
187 #define Q3SHADER_MAXLAYERS 8
188 #define Q3RGBGEN_MAXPARMS 3
189 #define Q3ALPHAGEN_MAXPARMS 1
190 #define Q3TCGEN_MAXPARMS 6
191 #define Q3TCMOD_MAXPARMS 6
192
193 typedef enum q3wavefunc_e
194 {
195         Q3WAVEFUNC_NONE,
196         Q3WAVEFUNC_INVERSESAWTOOTH,
197         Q3WAVEFUNC_NOISE,
198         Q3WAVEFUNC_SAWTOOTH,
199         Q3WAVEFUNC_SIN,
200         Q3WAVEFUNC_SQUARE,
201         Q3WAVEFUNC_TRIANGLE,
202         Q3WAVEFUNC_COUNT
203 }
204 q3wavefunc_t;
205
206 typedef enum q3rgbgen_e
207 {
208         Q3RGBGEN_IDENTITY,
209         Q3RGBGEN_CONST,
210         Q3RGBGEN_ENTITY,
211         Q3RGBGEN_EXACTVERTEX,
212         Q3RGBGEN_IDENTITYLIGHTING,
213         Q3RGBGEN_LIGHTINGDIFFUSE,
214         Q3RGBGEN_ONEMINUSENTITY,
215         Q3RGBGEN_ONEMINUSVERTEX,
216         Q3RGBGEN_VERTEX,
217         Q3RGBGEN_WAVE,
218         Q3RGBGEN_COUNT
219 }
220 q3rgbgen_t;
221
222 typedef enum q3alphagen_e
223 {
224         Q3ALPHAGEN_IDENTITY,
225         Q3ALPHAGEN_CONST,
226         Q3ALPHAGEN_ENTITY,
227         Q3ALPHAGEN_LIGHTINGSPECULAR,
228         Q3ALPHAGEN_ONEMINUSENTITY,
229         Q3ALPHAGEN_ONEMINUSVERTEX,
230         Q3ALPHAGEN_PORTAL,
231         Q3ALPHAGEN_VERTEX,
232         Q3ALPHAGEN_WAVE,
233         Q3ALPHAGEN_COUNT
234 }
235 q3alphagen_t;
236
237 typedef enum q3tcgen_e
238 {
239         Q3TCGEN_NONE,
240         Q3TCGEN_TEXTURE, // very common
241         Q3TCGEN_ENVIRONMENT, // common
242         Q3TCGEN_LIGHTMAP,
243         Q3TCGEN_VECTOR,
244         Q3TCGEN_COUNT
245 }
246 q3tcgen_t;
247
248 typedef enum q3tcmod_e
249 {
250         Q3TCMOD_NONE,
251         Q3TCMOD_ENTITYTRANSLATE,
252         Q3TCMOD_ROTATE,
253         Q3TCMOD_SCALE,
254         Q3TCMOD_SCROLL,
255         Q3TCMOD_STRETCH,
256         Q3TCMOD_TRANSFORM,
257         Q3TCMOD_TURBULENT,
258         Q3TCMOD_COUNT
259 }
260 q3tcmod_t;
261
262 typedef struct q3shaderinfo_layer_s
263 {
264         int alphatest;
265         int clampmap;
266         float framerate;
267         int numframes;
268         char texturename[TEXTURE_MAXFRAMES][Q3PATHLENGTH];
269         int blendfunc[2];
270         q3rgbgen_t rgbgen;
271         q3alphagen_t alphagen;
272         q3tcgen_t tcgen;
273         q3tcmod_t tcmod;
274         float rgbgen_parms[Q3RGBGEN_MAXPARMS];
275         float alphagen_parms[Q3ALPHAGEN_MAXPARMS];
276         float tcgen_parms[Q3TCGEN_MAXPARMS];
277         float tcmod_parms[Q3TCMOD_MAXPARMS];
278         q3wavefunc_t tcmod_wavefunc;
279 }
280 q3shaderinfo_layer_t;
281
282 typedef struct q3shaderinfo_s
283 {
284         char name[Q3PATHLENGTH];
285         int surfaceparms;
286         int textureflags;
287         int numlayers;
288         qboolean lighting;
289         qboolean vertexalpha;
290         qboolean textureblendalpha;
291         q3shaderinfo_layer_t *primarylayer, *backgroundlayer;
292         q3shaderinfo_layer_t layers[Q3SHADER_MAXLAYERS];
293         char skyboxname[Q3PATHLENGTH];
294 }
295 q3shaderinfo_t;
296
297 typedef enum texturelayertype_e
298 {
299         TEXTURELAYERTYPE_INVALID,
300         TEXTURELAYERTYPE_LITTEXTURE,
301         TEXTURELAYERTYPE_TEXTURE,
302         TEXTURELAYERTYPE_FOG,
303 }
304 texturelayertype_t;
305
306 typedef enum texturelayerflag_e
307 {
308         // indicates that the pass should apply fog darkening; used on
309         // transparent surfaces where simply blending an alpha fog as a final
310         // pass would not behave properly, so all the surfaces must be darkened,
311         // and the fog color added as a separate pass
312         TEXTURELAYERFLAG_FOGDARKEN = 1,
313 }
314 texturelayerflag_t;
315
316 typedef struct texturelayer_s
317 {
318         texturelayertype_t type;
319         qboolean depthmask;
320         int blendfunc1;
321         int blendfunc2;
322         rtexture_t *texture;
323         matrix4x4_t texmatrix;
324         vec4_t color;
325         int flags;
326 }
327 texturelayer_t;
328
329 typedef struct texture_s
330 {
331         // q1bsp
332         // name
333         //char name[16];
334         // size
335         unsigned int width, height;
336         // SURF_ flags
337         //unsigned int flags;
338
339         // base material flags
340         int basematerialflags;
341         // current material flags (updated each bmodel render)
342         int currentmaterialflags;
343
344         // textures to use when rendering this material
345         skinframe_t *currentskinframe;
346         int numskinframes;
347         float skinframerate;
348         skinframe_t *skinframes[TEXTURE_MAXFRAMES];
349         // background layer (for terrain texture blending)
350         skinframe_t *backgroundcurrentskinframe;
351         int backgroundnumskinframes;
352         float backgroundskinframerate;
353         skinframe_t *backgroundskinframes[TEXTURE_MAXFRAMES];
354
355         // total frames in sequence and alternate sequence
356         int anim_total[2];
357         // direct pointers to each of the frames in the sequences
358         // (indexed as [alternate][frame])
359         struct texture_s *anim_frames[2][10];
360         // set if animated or there is an alternate frame set
361         // (this is an optimization in the renderer)
362         int animated;
363
364         // the current alpha of this texture (may be affected by r_wateralpha)
365         float currentalpha;
366         // the current texture frame in animation
367         struct texture_s *currentframe;
368         // current texture transform matrix (used for water scrolling)
369         matrix4x4_t currenttexmatrix;
370
371         // various q3 shader features
372         q3rgbgen_t rgbgen;
373         q3alphagen_t alphagen;
374         q3tcgen_t tcgen;
375         q3tcmod_t tcmod;
376         float rgbgen_parms[Q3RGBGEN_MAXPARMS];
377         float alphagen_parms[Q3ALPHAGEN_MAXPARMS];
378         float tcgen_parms[Q3TCGEN_MAXPARMS];
379         float tcmod_parms[Q3TCMOD_MAXPARMS];
380         q3wavefunc_t tcmod_wavefunc;
381
382         qboolean colormapping;
383         rtexture_t *basetexture;
384         rtexture_t *glosstexture;
385         rtexture_t *backgroundbasetexture;
386         rtexture_t *backgroundglosstexture;
387         float specularscale;
388         float specularpower;
389
390         // from q3 shaders
391         int customblendfunc[2];
392
393         int currentnumlayers;
394         texturelayer_t currentlayers[16];
395
396         // q3bsp
397         char name[64];
398         int surfaceflags;
399         int supercontents;
400         int surfaceparms;
401         int textureflags;
402 }
403 texture_t;
404
405 typedef struct mtexinfo_s
406 {
407         float vecs[2][4];
408         texture_t *texture;
409         int flags;
410 }
411 mtexinfo_t;
412
413 typedef struct msurface_lightmapinfo_s
414 {
415         // texture mapping properties used by this surface
416         mtexinfo_t *texinfo; // q1bsp
417         // index into r_refdef.lightstylevalue array, 255 means not used (black)
418         unsigned char styles[MAXLIGHTMAPS]; // q1bsp
419         // RGB lighting data [numstyles][height][width][3]
420         unsigned char *samples; // q1bsp
421         // RGB normalmap data [numstyles][height][width][3]
422         unsigned char *nmapsamples; // q1bsp
423         // stain to apply on lightmap (soot/dirt/blood/whatever)
424         unsigned char *stainsamples; // q1bsp
425         int texturemins[2]; // q1bsp
426         int extents[2]; // q1bsp
427         int lightmaporigin[2]; // q1bsp
428 }
429 msurface_lightmapinfo_t;
430
431 struct q3deffect_s;
432 typedef struct msurface_s
433 {
434         // bounding box for onscreen checks
435         vec3_t mins;
436         vec3_t maxs;
437         // the texture to use on the surface
438         texture_t *texture;
439         // the lightmap texture fragment to use on the rendering mesh
440         rtexture_t *lightmaptexture;
441         // the lighting direction texture fragment to use on the rendering mesh
442         rtexture_t *deluxemaptexture;
443
444         // surfaces own ranges of vertices and triangles in the model->surfmesh
445         int num_triangles; // number of triangles
446         int num_firsttriangle; // first triangle
447         int num_vertices; // number of vertices
448         int num_firstvertex; // first vertex
449
450         // shadow volume building information
451         int num_firstshadowmeshtriangle; // index into model->brush.shadowmesh
452
453         // lightmaptexture rebuild information not used in q3bsp
454         int cached_dlight; // q1bsp // forces rebuild of lightmaptexture
455         msurface_lightmapinfo_t *lightmapinfo; // q1bsp
456
457         // mesh information for collisions (only used by q3bsp curves)
458         int num_collisiontriangles; // q3bsp
459         int *data_collisionelement3i; // q3bsp
460         int num_collisionvertices; // q3bsp
461         float *data_collisionvertex3f; // q3bsp
462         struct q3deffect_s *effect; // q3bsp
463         // FIXME: collisionmarkframe should be kept in a separate array
464         int collisionmarkframe; // q3bsp // don't collide twice in one trace
465 }
466 msurface_t;
467
468 #include "matrixlib.h"
469
470 #include "model_brush.h"
471 #include "model_sprite.h"
472 #include "model_alias.h"
473
474 typedef struct model_sprite_s
475 {
476         int                             sprnum_type;
477         mspriteframe_t  *sprdata_frames;
478 }
479 model_sprite_t;
480
481 struct trace_s;
482
483 typedef struct model_brush_s
484 {
485         // true if this model is a HalfLife .bsp file
486         qboolean ishlbsp;
487         // true if this model is a Martial Concert .bsp file
488         qboolean ismcbsp;
489         // string of entity definitions (.map format)
490         char *entities;
491
492         // if non-zero this is a submodel
493         // (this is the number of the submodel, an index into submodels)
494         int submodel;
495
496         // number of submodels in this map (just used by server to know how many
497         // submodels to load)
498         int numsubmodels;
499         // pointers to each of the submodels if .isworldmodel is true
500         struct model_s **submodels;
501
502         int num_planes;
503         mplane_t *data_planes;
504
505         int num_nodes;
506         mnode_t *data_nodes;
507
508         // visible leafs, not counting 0 (solid)
509         int num_visleafs;
510         // number of actual leafs (including 0 which is solid)
511         int num_leafs;
512         mleaf_t *data_leafs;
513
514         int num_leafbrushes;
515         int *data_leafbrushes;
516
517         int num_leafsurfaces;
518         int *data_leafsurfaces;
519
520         int num_portals;
521         mportal_t *data_portals;
522
523         int num_portalpoints;
524         mvertex_t *data_portalpoints;
525
526         int num_brushes;
527         q3mbrush_t *data_brushes;
528
529         int num_brushsides;
530         q3mbrushside_t *data_brushsides;
531
532         // pvs
533         int num_pvsclusters;
534         int num_pvsclusterbytes;
535         unsigned char *data_pvsclusters;
536         // example
537         //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
538         //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
539
540         // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
541         shadowmesh_t *shadowmesh;
542
543         // common functions
544         int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
545         int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
546         unsigned char *(*GetPVS)(struct model_s *model, const vec3_t p);
547         int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, unsigned char *pvsbuffer, int pvsbufferlength);
548         int (*BoxTouchingPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
549         int (*BoxTouchingLeafPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
550         int (*BoxTouchingVisibleLeafs)(struct model_s *model, const unsigned char *visibleleafs, const vec3_t mins, const vec3_t maxs);
551         int (*FindBoxClusters)(struct model_s *model, const vec3_t mins, const vec3_t maxs, int maxclusters, int *clusterlist);
552         void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
553         void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
554         mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
555         // these are actually only found on brushq1, but NULL is handled gracefully
556         void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, unsigned char *out, int outsize);
557         void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
558         // trace a line of sight through this model (returns false if the line if sight is definitely blocked)
559         qboolean (*TraceLineOfSight)(struct model_s *model, const vec3_t start, const vec3_t end);
560
561         char skybox[MAX_QPATH];
562
563         rtexture_t *solidskytexture;
564         rtexture_t *alphaskytexture;
565
566         qboolean supportwateralpha;
567
568         // QuakeWorld
569         int qw_md4sum;
570         int qw_md4sum2;
571 }
572 model_brush_t;
573
574 typedef struct model_brushq1_s
575 {
576         // lightmap format, set to r_lightmaprgba when model is loaded
577         int                             lightmaprgba;
578
579         dmodel_t                *submodels;
580
581         int                             numvertexes;
582         mvertex_t               *vertexes;
583
584         int                             numedges;
585         medge_t                 *edges;
586
587         int                             numtexinfo;
588         mtexinfo_t              *texinfo;
589
590         int                             numsurfedges;
591         int                             *surfedges;
592
593         int                             numclipnodes;
594         dclipnode_t             *clipnodes;
595
596         hull_t                  hulls[MAX_MAP_HULLS];
597
598         int                             num_compressedpvs;
599         unsigned char                   *data_compressedpvs;
600
601         int                             num_lightdata;
602         unsigned char                   *lightdata;
603         unsigned char                   *nmaplightdata; // deluxemap file
604
605         // lightmap update chains for light styles
606         int                             light_styles;
607         unsigned char                   *light_style;
608         int                             *light_stylevalue;
609         msurface_t              ***light_styleupdatechains;
610         msurface_t              **light_styleupdatechainsbuffer;
611 }
612 model_brushq1_t;
613
614 /* MSVC can't compile empty structs, so this is commented out for now
615 typedef struct model_brushq2_s
616 {
617 }
618 model_brushq2_t;
619 */
620
621 typedef struct model_brushq3_s
622 {
623         int num_models;
624         q3dmodel_t *data_models;
625
626         // used only during loading - freed after loading!
627         int num_vertices;
628         float *data_vertex3f;
629         float *data_normal3f;
630         float *data_texcoordtexture2f;
631         float *data_texcoordlightmap2f;
632         float *data_color4f;
633
634         // freed after loading!
635         int num_triangles;
636         int *data_element3i;
637
638         int num_effects;
639         q3deffect_t *data_effects;
640
641         // lightmap textures
642         int num_originallightmaps;
643         int num_mergedlightmaps;
644         int num_lightmapmergepower;
645         int num_lightmapmerge;
646         rtexture_t **data_lightmaps;
647         rtexture_t **data_deluxemaps;
648
649         // voxel light data with directional shading
650         int num_lightgrid;
651         q3dlightgrid_t *data_lightgrid;
652         // size of each cell (may vary by map, typically 64 64 128)
653         float num_lightgrid_cellsize[3];
654         // 1.0 / num_lightgrid_cellsize
655         float num_lightgrid_scale[3];
656         // dimensions of the world model in lightgrid cells
657         int num_lightgrid_imins[3];
658         int num_lightgrid_imaxs[3];
659         int num_lightgrid_isize[3];
660         // indexing/clamping
661         int num_lightgrid_dimensions[3];
662         // transform modelspace coordinates to lightgrid index
663         matrix4x4_t num_lightgrid_indexfromworld;
664
665         // true if this q3bsp file has been detected as using deluxemapping
666         // (lightmap texture pairs, every odd one is never directly refernced,
667         //  and contains lighting normals, not colors)
668         qboolean deluxemapping;
669         // true if the detected deluxemaps are the modelspace kind, rather than
670         // the faster tangentspace kind
671         qboolean deluxemapping_modelspace;
672 }
673 model_brushq3_t;
674
675 typedef struct model_s
676 {
677         // name and path of model, for example "progs/player.mdl"
678         char                    name[MAX_QPATH];
679         // model needs to be loaded if this is false
680         qboolean                loaded;
681         // set if the model is used in current map, models which are not, are purged
682         qboolean                used;
683         // true if this is the world model (I.E. defines what sky to use, and may contain submodels)
684         qboolean                isworldmodel;
685         // CRC of the file this model was loaded from, to reload if changed
686         unsigned int    crc;
687         // mod_brush, mod_alias, mod_sprite
688         modtype_t               type;
689         // memory pool for allocations
690         mempool_t               *mempool;
691         // all models use textures...
692         rtexturepool_t  *texturepool;
693         // EF_* flags (translated from the model file's different flags layout)
694         int                             effects;
695         // number of QC accessible frame(group)s in the model
696         int                             numframes;
697         // number of QC accessible skin(group)s in the model
698         int                             numskins;
699         // whether to randomize animated framegroups
700         synctype_t              synctype;
701         // bounding box at angles '0 0 0'
702         vec3_t                  normalmins, normalmaxs;
703         // bounding box if yaw angle is not 0, but pitch and roll are
704         vec3_t                  yawmins, yawmaxs;
705         // bounding box if pitch or roll are used
706         vec3_t                  rotatedmins, rotatedmaxs;
707         // sphere radius, usable at any angles
708         float                   radius;
709         // squared sphere radius for easier comparisons
710         float                   radius2;
711         // skin animation info
712         animscene_t             *skinscenes; // [numskins]
713         // skin animation info
714         animscene_t             *animscenes; // [numframes]
715         // range of surface numbers in this (sub)model
716         int                             firstmodelsurface;
717         int                             nummodelsurfaces;
718         // range of collision brush numbers in this (sub)model
719         int                             firstmodelbrush;
720         int                             nummodelbrushes;
721         // list of surface numbers in this (sub)model
722         int                             *surfacelist;
723         // for md3 models
724         int                             num_tags;
725         int                             num_tagframes;
726         aliastag_t              *data_tags;
727         // for skeletal models
728         int                             num_bones;
729         aliasbone_t             *data_bones;
730         int                             num_poses;
731         float                   *data_poses;
732         float                   *data_baseboneposeinverse;
733         // textures of this model
734         int                             num_textures;
735         int                             num_texturesperskin;
736         texture_t               *data_textures;
737         // surfaces of this model
738         int                             num_surfaces;
739         msurface_t              *data_surfaces;
740         // optional lightmapinfo data for surface lightmap updates
741         msurface_lightmapinfo_t *data_surfaces_lightmapinfo;
742         // all surfaces belong to this mesh
743         surfmesh_t              surfmesh;
744         // draw the model's sky polygons (only used by brush models)
745         void(*DrawSky)(struct entity_render_s *ent);
746         // draw the model using lightmap/dlight shading
747         void(*Draw)(struct entity_render_s *ent);
748         // draw the model to the depth buffer (no color rendering at all)
749         void(*DrawDepth)(struct entity_render_s *ent);
750         // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
751         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);
752         // compile a shadow volume for the model based on light source
753         void(*CompileShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
754         // draw a shadow volume for the model based on light source
755         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);
756         // draw the lighting on a model (through stencil)
757         void(*DrawLight)(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
758         // trace a box against this model
759         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);
760         // fields belonging to some types of model
761         model_sprite_t  sprite;
762         model_brush_t   brush;
763         model_brushq1_t brushq1;
764         /* MSVC can't handle an empty struct, so this is commented out for now
765         model_brushq2_t brushq2;
766         */
767         model_brushq3_t brushq3;
768         // skin files can have different tags for each skin
769         overridetagnameset_t    *data_overridetagnamesforskin;
770         // flags this model for offseting sounds to the model center (used by brush models)
771         int soundfromcenter;
772 }
773 model_t;
774
775 //============================================================================
776
777 // model loading
778 extern model_t *loadmodel;
779 extern unsigned char *mod_base;
780 // sky/water subdivision
781 //extern cvar_t gl_subdivide_size;
782 // texture fullbrights
783 extern cvar_t r_fullbrights;
784
785 void Mod_Init (void);
786 void Mod_Reload (void);
787 model_t *Mod_LoadModel(model_t *mod, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
788 model_t *Mod_FindName (const char *name);
789 model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
790 void Mod_UnloadModel (model_t *mod);
791
792 void Mod_ClearUsed(void);
793 void Mod_PurgeUnused(void);
794 void Mod_RemoveStaleWorldModels(model_t *skip); // only used during loading!
795
796 extern model_t *loadmodel;
797 extern char loadname[32];       // for hunk tags
798
799 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
800 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
801 void Mod_ValidateElements(int *elements, int numtriangles, int firstvertex, int numverts, const char *filename, int fileline);
802 void Mod_BuildNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const int *elements, float *normal3f, qboolean areaweighting);
803 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);
804
805 void Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, qboolean lightmapoffsets, qboolean vertexcolors, qboolean neighbors);
806
807 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);
808 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
809 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
810 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
811 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);
812 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);
813 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, qboolean light, qboolean neighbors, qboolean createvbo);
814 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
815 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
816
817 void Mod_LoadQ3Shaders(void);
818 q3shaderinfo_t *Mod_LookupQ3Shader(const char *name);
819 qboolean Mod_LoadTextureFromQ3Shader(texture_t *texture, const char *name, qboolean q1bsp, qboolean q3bsp, qboolean md3);
820
821 extern cvar_t r_mipskins;
822
823 typedef struct skinfileitem_s
824 {
825         struct skinfileitem_s *next;
826         char name[MAX_QPATH];
827         char replacement[MAX_QPATH];
828 }
829 skinfileitem_t;
830
831 typedef struct skinfile_s
832 {
833         struct skinfile_s *next;
834         skinfileitem_t *items;
835 }
836 skinfile_t;
837
838 skinfile_t *Mod_LoadSkinFiles(void);
839 void Mod_FreeSkinFiles(skinfile_t *skinfile);
840 int Mod_CountSkinFiles(skinfile_t *skinfile);
841
842 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
843 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
844 void Mod_VertexRangeFromElements(int numelements, const int *elements, int *firstvertexpointer, int *lastvertexpointer);
845
846 // bsp models
847 void Mod_BrushInit(void);
848 // used for talking to the QuakeC mainly
849 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
850 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
851
852 // a lot of model formats use the Q1BSP code, so here are the prototypes...
853 struct entity_render_s;
854 void R_Q1BSP_DrawSky(struct entity_render_s *ent);
855 void R_Q1BSP_Draw(struct entity_render_s *ent);
856 void R_Q1BSP_DrawDepth(struct entity_render_s *ent);
857 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);
858 void R_Q1BSP_CompileShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
859 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);
860 void R_Q1BSP_DrawLight(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
861
862 // alias models
863 struct frameblend_s;
864 void Mod_AliasInit(void);
865 void Mod_Alias_GetMesh_Vertices(const model_t *model, const struct frameblend_s *frameblend, float *vertex3f, float *normal3f, float *svector3f, float *tvector3f);
866 int Mod_Alias_GetTagMatrix(const model_t *model, int poseframe, int tagindex, matrix4x4_t *outmatrix);
867 int Mod_Alias_GetTagIndexForName(const model_t *model, unsigned int skin, const char *tagname);
868
869 // sprite models
870 void Mod_SpriteInit(void);
871
872 // loaders
873 void Mod_Q1BSP_Load(model_t *mod, void *buffer, void *bufferend);
874 void Mod_IBSP_Load(model_t *mod, void *buffer, void *bufferend);
875 void Mod_MAP_Load(model_t *mod, void *buffer, void *bufferend);
876 void Mod_IDP0_Load(model_t *mod, void *buffer, void *bufferend);
877 void Mod_IDP2_Load(model_t *mod, void *buffer, void *bufferend);
878 void Mod_IDP3_Load(model_t *mod, void *buffer, void *bufferend);
879 void Mod_ZYMOTICMODEL_Load(model_t *mod, void *buffer, void *bufferend);
880 void Mod_DARKPLACESMODEL_Load(model_t *mod, void *buffer, void *bufferend);
881 void Mod_PSKMODEL_Load(model_t *mod, void *buffer, void *bufferend);
882 void Mod_IDSP_Load(model_t *mod, void *buffer, void *bufferend);
883 void Mod_IDS2_Load(model_t *mod, void *buffer, void *bufferend);
884
885 // utility
886 qboolean Mod_CanSeeBox_Trace(int numsamples, float t, model_t *model, vec3_t eye, vec3_t minsX, vec3_t maxsX);
887
888 #endif  // MODEL_SHARED_H
889