Tomaz's awesome new GeForce3 water effect, thanks!
[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__
22 #define __MODEL__
23
24 #ifndef SYNCTYPE_T
25 #define SYNCTYPE_T
26 typedef enum {ST_SYNC=0, ST_RAND } synctype_t;
27 #endif
28
29 /*
30
31 d*_t structures are on-disk representations
32 m*_t structures are in-memory
33
34 */
35
36 typedef enum {mod_invalid, mod_brush, mod_sprite, mod_alias, mod_brushq2, mod_brushq3} modtype_t;
37
38 typedef struct animscene_s
39 {
40         char name[32]; // for viewthing support
41         int firstframe;
42         int framecount;
43         int loop; // true or false
44         float framerate;
45 }
46 animscene_t;
47
48 typedef struct skinframe_s
49 {
50         rtexture_t *base; // original texture without pants/shirt/glow
51         rtexture_t *pants; // pants only (in greyscale)
52         rtexture_t *shirt; // shirt only (in greyscale)
53         rtexture_t *glow; // glow only (fullbrights)
54         rtexture_t *merged; // original texture without glow
55         rtexture_t *fog; // alpha of the base texture (if not opaque)
56         rtexture_t *nmap; // normalmap (bumpmap for dot3)
57         rtexture_t *gloss; // glossmap (for dot3)
58         rtexture_t *detail; // detail texture (silly bumps for non-dot3)
59 }
60 skinframe_t;
61
62 #define MAX_SKINS 256
63
64 typedef struct overridetagname_s
65 {
66         char name[MAX_QPATH];
67 }
68 overridetagname_t;
69
70 // a replacement set of tag names, per skin
71 typedef struct overridetagnameset_s
72 {
73         int num_overridetagnames;
74         overridetagname_t *data_overridetagnames;
75 }
76 overridetagnameset_t;
77
78 #define SHADOWMESHVERTEXHASH 1024
79 typedef struct shadowmeshvertexhash_s
80 {
81         struct shadowmeshvertexhash_s *next;
82 }
83 shadowmeshvertexhash_t;
84
85 typedef struct shadowmesh_s
86 {
87         struct shadowmesh_s *next;
88         int numverts, maxverts;
89         int numtriangles, maxtriangles;
90         float *vertex3f;
91         int *element3i;
92         int *neighbor3i;
93         // these are NULL after Mod_ShadowMesh_Finish is performed, only used
94         // while building meshes
95         shadowmeshvertexhash_t **vertexhashtable, *vertexhashentries;
96 }
97 shadowmesh_t;
98
99
100 #include "matrixlib.h"
101
102 #include "model_brush.h"
103 #include "model_sprite.h"
104 #include "model_alias.h"
105
106 typedef struct model_alias_s
107 {
108         // LordHavoc: Q2/ZYM model support
109         int                             aliastype;
110
111         // mdl/md2/md3 models are the same after loading
112         int                             aliasnum_meshes;
113         aliasmesh_t             *aliasdata_meshes;
114
115         int                             aliasnum_tags;
116         int                             aliasnum_tagframes;
117         aliastag_t              *aliasdata_tags;
118
119         // for Zymotic models
120         int                             zymnum_verts;
121         int                             zymnum_tris;
122         int                             zymnum_shaders;
123         int                             zymnum_bones;
124         int                             zymnum_scenes;
125         float                   *zymdata_texcoords;
126         rtexture_t              **zymdata_textures;
127         qbyte                   *zymdata_trizone;
128         zymbone_t               *zymdata_bones;
129         unsigned int    *zymdata_vertbonecounts;
130         zymvertex_t             *zymdata_verts;
131         unsigned int    *zymdata_renderlist;
132         float                   *zymdata_poses;
133 }
134 model_alias_t;
135
136 typedef struct model_sprite_s
137 {
138         int                             sprnum_type;
139         mspriteframe_t  *sprdata_frames;
140 }
141 model_sprite_t;
142
143 struct trace_s;
144
145 typedef struct model_brush_s
146 {
147         // true if this model is a HalfLife .bsp file
148         qboolean ishlbsp;
149         // string of entity definitions (.map format)
150         char *entities;
151         // number of submodels in this map (just used by server to know how many
152         // submodels to load)
153         int numsubmodels;
154         // common functions
155         int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
156         int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
157         qbyte *(*GetPVS)(struct model_s *model, const vec3_t p);
158         int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, qbyte *pvsbuffer, int pvsbufferlength);
159         int (*BoxTouchingPVS)(struct model_s *model, const qbyte *pvs, const vec3_t mins, const vec3_t maxs);
160         void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
161         void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
162         void (*TraceBox)(struct model_s *model, struct trace_s *trace, const vec3_t boxstartmins, const vec3_t boxstartmaxs, const vec3_t boxendmins, const vec3_t boxendmaxs, int hitsupercontentsmask);
163         // these are actually only found on brushq1, but NULL is handled gracefully
164         void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, qbyte *out, int outsize);
165         void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
166 }
167 model_brush_t;
168
169 typedef struct model_brushq1_s
170 {
171         int                             firstmodelsurface, nummodelsurfaces;
172
173         // lightmap format, set to r_lightmaprgba when model is loaded
174         int                             lightmaprgba;
175
176         dmodel_t                *submodels;
177
178         int                             numplanes;
179         mplane_t                *planes;
180
181         // number of actual leafs (including 0 which is solid)
182         int                             numleafs;
183         // visible leafs, not counting 0 (solid)
184         int                             visleafs;
185         mleaf_t                 *leafs;
186
187         int                             numvertexes;
188         mvertex_t               *vertexes;
189
190         int                             numedges;
191         medge_t                 *edges;
192
193         int                             numnodes;
194         mnode_t                 *nodes;
195
196         int                             numtexinfo;
197         mtexinfo_t              *texinfo;
198
199         int                             numsurfaces;
200         msurface_t              *surfaces;
201         int                             *surfacevisframes;
202         int                             *surfacepvsframes;
203         msurface_t              *surfacepvsnext;
204         surfmesh_t              *entiremesh;
205         surfmesh_t              *surfmeshes;
206
207         int                             numsurfedges;
208         int                             *surfedges;
209
210         int                             numclipnodes;
211         dclipnode_t             *clipnodes;
212
213         int                             nummarksurfaces;
214         int                             *marksurfaces;
215
216         hull_t                  hulls[MAX_MAP_HULLS];
217
218         int                             numtextures;
219         texture_t               *textures;
220
221         int                             num_compressedpvs;
222         qbyte                   *data_compressedpvs;
223         qbyte                   *data_decompressedpvs;
224
225         int                             num_lightdata;
226         qbyte                   *lightdata;
227
228         int                             numportals;
229         mportal_t               *portals;
230
231         int                             numportalpoints;
232         mvertex_t               *portalpoints;
233
234         int                             numlights;
235         mlight_t                *lights;
236
237         // pvs visibility marking
238         mleaf_t                 *pvsviewleaf;
239         int                             pvsviewleafnovis;
240         int                             pvsframecount;
241         mleaf_t                 *pvsleafchain;
242         int                             *pvssurflist;
243         int                             pvssurflistlength;
244         // these get rebuilt as the player moves around if this is the world,
245         // otherwise they are left alone (no pvs for bmodels)
246         msurface_t              ***pvstexturechains;
247         msurface_t              **pvstexturechainsbuffer;
248         int                             *pvstexturechainslength;
249
250         // lightmap update chains for light styles
251         int                             light_styles;
252         qbyte                   *light_style;
253         int                             *light_stylevalue;
254         msurface_t              ***light_styleupdatechains;
255         msurface_t              **light_styleupdatechainsbuffer;
256         int                             light_scalebit;
257         float                   light_ambient;
258
259         mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
260         void (*BuildPVSTextureChains)(struct model_s *model);
261 }
262 model_brushq1_t;
263
264 /* MSVC can't compile empty structs, so this is commented out for now
265 typedef struct model_brushq2_s
266 {
267 }
268 model_brushq2_t;
269 */
270
271 #define Q3MTEXTURERENDERFLAGS_NODRAW 1
272
273 typedef struct q3mtexture_s
274 {
275         char name[Q3PATHLENGTH];
276         int surfaceflags;
277         int nativecontents;
278         int supercontents;
279         int renderflags;
280
281         int number;
282         skinframe_t skin;
283 }
284 q3mtexture_t;
285
286 typedef struct q3mnode_s
287 {
288         //this part shared between node and leaf
289         int isnode; // true
290         struct q3mnode_s *parent;
291         vec3_t mins;
292         vec3_t maxs;
293         // this part unique to nodes
294         struct mplane_s *plane;
295         struct q3mnode_s *children[2];
296 }
297 q3mnode_t;
298
299 typedef struct q3mleaf_s
300 {
301         //this part shared between node and leaf
302         int isnode; // false
303         struct q3mnode_s *parent;
304         vec3_t mins;
305         vec3_t maxs;
306         // this part unique to leafs
307         int clusterindex;
308         int areaindex;
309         int numleaffaces;
310         struct q3mface_s **firstleafface;
311         int numleafbrushes;
312         struct q3mbrush_s **firstleafbrush;
313 }
314 q3mleaf_t;
315
316 typedef struct q3mmodel_s
317 {
318         vec3_t mins;
319         vec3_t maxs;
320         int numfaces;
321         struct q3mface_s *firstface;
322         int numbrushes;
323         struct q3mbrush_s *firstbrush;
324 }
325 q3mmodel_t;
326
327 typedef struct q3mbrush_s
328 {
329         struct colbrushf_s *colbrushf;
330         int numbrushsides;
331         struct q3mbrushside_s *firstbrushside;
332         struct q3mtexture_s *texture;
333 }
334 q3mbrush_t;
335
336 typedef struct q3mbrushside_s
337 {
338         struct mplane_s *plane;
339         struct q3mtexture_s *texture;
340 }
341 q3mbrushside_t;
342
343 typedef struct q3meffect_s
344 {
345         char shadername[Q3PATHLENGTH];
346         struct q3mbrush_s *brush;
347         int unknown; // 5 or -1
348 }
349 q3meffect_t;
350
351 typedef struct q3mface_s
352 {
353         struct q3mtexture_s *texture;
354         struct q3meffect_s *effect;
355         rtexture_t *lightmaptexture;
356         int collisions; // performs per triangle collisions on this surface
357         int collisionmarkframe; // don't collide twice in one trace
358         int type;
359         int firstvertex;
360         int numvertices;
361         int firstelement;
362         int numelements;
363         int patchsize[2];
364         // used for processing
365         int markframe;
366         // (world only) visframe == r_framecount means it is visible this frame
367         int visframe;
368         // bounding box for culling
369         float mins[3];
370         float maxs[3];
371
372         float *data_vertex3f;
373         float *data_texcoordtexture2f;
374         float *data_texcoordlightmap2f;
375         float *data_svector3f;
376         float *data_tvector3f;
377         float *data_normal3f;
378         float *data_color4f;
379         int numtriangles;
380         int *data_element3i;
381         int *data_neighbor3i;
382 }
383 q3mface_t;
384
385 typedef struct model_brushq3_s
386 {
387         // if non-zero this is a submodel
388         // (this is the number of the submodel, an index into data_models)
389         int submodel;
390
391         int num_textures;
392         q3mtexture_t *data_textures;
393
394         int num_planes;
395         mplane_t *data_planes;
396
397         int num_nodes;
398         q3mnode_t *data_nodes;
399
400         int num_leafs;
401         q3mleaf_t *data_leafs;
402
403         int num_leafbrushes;
404         q3mbrush_t **data_leafbrushes;
405
406         int num_leaffaces;
407         q3mface_t **data_leaffaces;
408
409         int num_models;
410         q3mmodel_t *data_models;
411         // each submodel gets its own model struct so this is different for each.
412         q3mmodel_t *data_thismodel;
413
414         int num_brushes;
415         q3mbrush_t *data_brushes;
416
417         int num_brushsides;
418         q3mbrushside_t *data_brushsides;
419
420         int num_vertices;
421         float *data_vertex3f;
422         float *data_texcoordtexture2f;
423         float *data_texcoordlightmap2f;
424         float *data_svector3f;
425         float *data_tvector3f;
426         float *data_normal3f;
427         float *data_color4f;
428
429         int num_triangles;
430         int *data_element3i;
431         int *data_neighbor3i;
432
433         int num_effects;
434         q3meffect_t *data_effects;
435
436         int num_faces;
437         q3mface_t *data_faces;
438
439         // lightmap textures
440         int num_lightmaps;
441         rtexture_t **data_lightmaps;
442
443         // voxel light data with directional shading
444         int num_lightgrid;
445         q3dlightgrid_t *data_lightgrid;
446         // size of each cell (may vary by map, typically 64 64 128)
447         float num_lightgrid_cellsize[3];
448         // 1.0 / num_lightgrid_cellsize
449         float num_lightgrid_scale[3];
450         // dimensions of the world model in lightgrid cells
451         int num_lightgrid_imins[3];
452         int num_lightgrid_imaxs[3];
453         int num_lightgrid_isize[3];
454         // indexing/clamping
455         int num_lightgrid_dimensions[3];
456         // transform modelspace coordinates to lightgrid index
457         matrix4x4_t num_lightgrid_indexfromworld;
458
459         // pvs
460         int num_pvsclusters;
461         int num_pvschainlength;
462         unsigned char *data_pvschains;
463         // example
464         //pvschain = model->brushq3.data_pvschains + mycluster * model->brushq3.num_pvschainlength;
465         //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
466 }
467 model_brushq3_t;
468
469 typedef struct model_s
470 {
471         // name and path of model, for example "progs/player.mdl"
472         char                    name[MAX_QPATH];
473         // model needs to be loaded if this is true
474         qboolean                needload;
475         // set if the model is used in current map, models which are not, are purged
476         qboolean                used;
477         // true if this is the world model (I.E. defines what sky to use, and may contain submodels)
478         qboolean                isworldmodel;
479         // CRC of the file this model was loaded from, to reload if changed
480         unsigned int    crc;
481         // mod_brush, mod_alias, mod_sprite
482         modtype_t               type;
483         // memory pool for allocations
484         mempool_t               *mempool;
485         // all models use textures...
486         rtexturepool_t  *texturepool;
487         // flags from the model file
488         int                             flags;
489         // engine calculated flags, ones that can not be set in the file
490         int                             flags2;
491         // LordHavoc: if true (normally only for sprites) the model/sprite/bmodel is always rendered fullbright
492         int                             fullbright;
493         // number of QC accessible frame(group)s in the model
494         int                             numframes;
495         // number of QC accessible skin(group)s in the model
496         int                             numskins;
497         // whether to randomize animated framegroups
498         synctype_t              synctype;
499         // bounding box at angles '0 0 0'
500         vec3_t                  normalmins, normalmaxs;
501         // bounding box if yaw angle is not 0, but pitch and roll are
502         vec3_t                  yawmins, yawmaxs;
503         // bounding box if pitch or roll are used
504         vec3_t                  rotatedmins, rotatedmaxs;
505         // sphere radius, usable at any angles
506         float                   radius;
507         // squared sphere radius for easier comparisons
508         float                   radius2;
509         // skin animation info
510         animscene_t             *skinscenes; // [numskins]
511         // skin animation info
512         animscene_t             *animscenes; // [numframes]
513         // draw the model's sky polygons (only used by brush models)
514         void(*DrawSky)(struct entity_render_s *ent);
515         // draw the model using lightmap/dlight shading
516         void(*Draw)(struct entity_render_s *ent);
517         // draw a fake shadow for the model
518         void(*DrawFakeShadow)(struct entity_render_s *ent);
519         // draw a shadow volume for the model based on light source
520         void(*DrawShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius);
521         // draw the lighting on a model (through stencil)
522         void(*DrawLight)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativeeyeorigin, float lightradius, float *lightcolor, const matrix4x4_t *matrix_modeltofilter, const matrix4x4_t *matrix_modeltoattenuationxyz, const matrix4x4_t *matrix_modeltoattenuationz);
523         // fields belonging to each type of model
524         model_alias_t   alias;
525         model_sprite_t  sprite;
526         model_brush_t   brush;
527         model_brushq1_t brushq1;
528         /* MSVC can't handle an empty struct, so this is commented out for now
529         model_brushq2_t brushq2;
530         */
531         model_brushq3_t brushq3;
532         // skin files can have different tags for each skin
533         overridetagnameset_t    *data_overridetagnamesforskin;
534 }
535 model_t;
536
537 //============================================================================
538
539 // this can be used for anything without a valid texture
540 extern rtexture_t *r_notexture;
541 #define NUM_DETAILTEXTURES 1
542 extern rtexture_t *mod_shared_detailtextures[NUM_DETAILTEXTURES];
543 // every texture must be in a pool...
544 extern rtexturepool_t *mod_shared_texturepool;
545
546 extern rtexture_t *mod_shared_distorttexture;
547
548 // model loading
549 extern model_t *loadmodel;
550 extern qbyte *mod_base;
551 // sky/water subdivision
552 //extern cvar_t gl_subdivide_size;
553 // texture fullbrights
554 extern cvar_t r_fullbrights;
555
556 void Mod_Init (void);
557 void Mod_CheckLoaded (model_t *mod);
558 void Mod_ClearAll (void);
559 model_t *Mod_FindName (const char *name);
560 model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
561 void Mod_TouchModel (const char *name);
562 void Mod_UnloadModel (model_t *mod);
563
564 void Mod_ClearUsed(void);
565 void Mod_PurgeUnused(void);
566 void Mod_LoadModels(void);
567
568 extern model_t *loadmodel;
569 extern char loadname[32];       // for hunk tags
570
571 int Mod_FindTriangleWithEdge(const int *elements, int numtriangles, int start, int end, int ignore);
572 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
573 void Mod_ValidateElements(const int *elements, int numtriangles, int numverts, const char *filename, int fileline);
574 void Mod_BuildTextureVectorsAndNormals(int numverts, int numtriangles, const float *vertex, const float *texcoord, const int *elements, float *svectors, float *tvectors, float *normals);
575
576 shadowmesh_t *Mod_ShadowMesh_Alloc(mempool_t *mempool, int maxverts);
577 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh);
578 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *v);
579 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, float *vert0, float *vert1, float *vert2);
580 void Mod_ShadowMesh_AddPolygon(mempool_t *mempool, shadowmesh_t *mesh, int numverts, float *verts);
581 void Mod_ShadowMesh_AddMesh(mempool_t *mempool, shadowmesh_t *mesh, float *verts, int numtris, int *elements);
582 shadowmesh_t *Mod_ShadowMesh_Begin(mempool_t *mempool, int initialnumtriangles);
583 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh);
584 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
585 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
586
587 int Mod_LoadSkinFrame(skinframe_t *skinframe, char *basename, int textureflags, int loadpantsandshirt, int usedetailtexture, int loadglowtexture);
588 int Mod_LoadSkinFrame_Internal(skinframe_t *skinframe, char *basename, int textureflags, int loadpantsandshirt, int usedetailtexture, int loadglowtexture, qbyte *skindata, int width, int height);
589
590 // used for talking to the QuakeC mainly
591 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
592 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
593
594 extern cvar_t r_mipskins;
595
596 typedef struct skinfileitem_s
597 {
598         struct skinfileitem_s *next;
599         char name[MAX_QPATH];
600         char replacement[MAX_QPATH];
601 }
602 skinfileitem_t;
603
604 typedef struct skinfile_s
605 {
606         struct skinfile_s *next;
607         skinfileitem_t *items;
608 }
609 skinfile_t;
610
611 skinfile_t *Mod_LoadSkinFiles(void);
612 void Mod_FreeSkinFiles(skinfile_t *skinfile);
613 int Mod_CountSkinFiles(skinfile_t *skinfile);
614
615 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
616
617 #endif  // __MODEL__
618