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