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