corrected a few LittleLongs to LittleFloat in md3 loading (EEP those were bad)
[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         char *entities;
148         void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
149         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);
150 }
151 model_brush_t;
152
153 typedef struct model_brushq1_s
154 {
155         // true if this model is a HalfLife .bsp file
156         qboolean                ishlbsp;
157
158         int                             firstmodelsurface, nummodelsurfaces;
159
160         // lightmap format, set to r_lightmaprgba when model is loaded
161         int                             lightmaprgba;
162
163         int                             numsubmodels;
164         dmodel_t                *submodels;
165
166         int                             numplanes;
167         mplane_t                *planes;
168
169         // number of visible leafs, not counting 0 (solid)
170         int                             numleafs;
171         mleaf_t                 *leafs;
172
173         int                             numvertexes;
174         mvertex_t               *vertexes;
175
176         int                             numedges;
177         medge_t                 *edges;
178
179         int                             numnodes;
180         mnode_t                 *nodes;
181
182         int                             numtexinfo;
183         mtexinfo_t              *texinfo;
184
185         int                             numsurfaces;
186         msurface_t              *surfaces;
187         int                             *surfacevisframes;
188         int                             *surfacepvsframes;
189         msurface_t              *surfacepvsnext;
190         surfmesh_t              *entiremesh;
191         surfmesh_t              *surfmeshes;
192
193         int                             numsurfedges;
194         int                             *surfedges;
195
196         int                             numclipnodes;
197         dclipnode_t             *clipnodes;
198
199         int                             nummarksurfaces;
200         int                             *marksurfaces;
201
202         hull_t                  hulls[MAX_MAP_HULLS];
203
204         int                             numtextures;
205         texture_t               *textures;
206
207         qbyte                   *visdata;
208         qbyte                   *lightdata;
209
210         int                             numportals;
211         mportal_t               *portals;
212
213         int                             numportalpoints;
214         mvertex_t               *portalpoints;
215
216         int                             numlights;
217         mlight_t                *lights;
218
219         // pvs visibility marking
220         mleaf_t                 *pvsviewleaf;
221         int                             pvsviewleafnovis;
222         int                             pvsframecount;
223         mleaf_t                 *pvsleafchain;
224         int                             *pvssurflist;
225         int                             pvssurflistlength;
226         // these get rebuilt as the player moves around if this is the world,
227         // otherwise they are left alone (no pvs for bmodels)
228         msurface_t              ***pvstexturechains;
229         msurface_t              **pvstexturechainsbuffer;
230         int                             *pvstexturechainslength;
231
232         // lightmap update chains for light styles
233         int                             light_styles;
234         qbyte                   *light_style;
235         int                             *light_stylevalue;
236         msurface_t              ***light_styleupdatechains;
237         msurface_t              **light_styleupdatechainsbuffer;
238         int                             light_scalebit;
239         float                   light_ambient;
240
241         mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
242         qbyte *(*LeafPVS)(struct model_s *model, mleaf_t *leaf);
243         void (*BuildPVSTextureChains)(struct model_s *model);
244 }
245 model_brushq1_t;
246
247 /* MSVC can't compile empty structs, so this is commented out for now
248 typedef struct model_brushq2_s
249 {
250 }
251 model_brushq2_t;
252 */
253
254 typedef struct q3mtexture_s
255 {
256         char name[Q3PATHLENGTH];
257         int surfaceflags;
258         int contents;
259
260         int number;
261         skinframe_t skin;
262 }
263 q3mtexture_t;
264
265 typedef struct q3mnode_s
266 {
267         int isnode; // true
268         struct q3mnode_s *parent;
269         struct mplane_s *plane;
270         struct q3mnode_s *children[2];
271 }
272 q3mnode_t;
273
274 typedef struct q3mleaf_s
275 {
276         int isnode; // false
277         struct q3mnode_s *parent;
278         int clusterindex;
279         int areaindex;
280         int numleaffaces;
281         struct q3mface_s **firstleafface;
282         int numleafbrushes;
283         struct q3mbrush_s **firstleafbrush;
284         vec3_t mins;
285         vec3_t maxs;
286 }
287 q3mleaf_t;
288
289 typedef struct q3mmodel_s
290 {
291         vec3_t mins;
292         vec3_t maxs;
293         int numfaces;
294         struct q3mface_s *firstface;
295         int numbrushes;
296         struct q3mbrush_s *firstbrush;
297 }
298 q3mmodel_t;
299
300 typedef struct q3mbrush_s
301 {
302         int numbrushsides;
303         struct q3mbrushside_s *firstbrushside;
304         struct q3mtexture_s *texture;
305 }
306 q3mbrush_t;
307
308 typedef struct q3mbrushside_s
309 {
310         struct mplane_s *plane;
311         struct q3mtexture_s *texture;
312 }
313 q3mbrushside_t;
314
315 typedef struct q3meffect_s
316 {
317         char shadername[Q3PATHLENGTH];
318         struct q3mbrush_s *brush;
319         int unknown; // 5 or -1
320 }
321 q3meffect_t;
322
323 typedef struct q3mface_s
324 {
325         struct q3mtexture_s *texture;
326         struct q3meffect_s *effect;
327         rtexture_t *lightmaptexture;
328         int type;
329         int firstvertex;
330         int numvertices;
331         int firstelement;
332         int numelements;
333         int patchsize[2];
334
335         float *data_vertex3f;
336         float *data_texturetexcoord2f;
337         float *data_lightmaptexcoord2f;
338         float *data_svector3f;
339         float *data_tvector3f;
340         float *data_normal3f;
341         float *data_color4f;
342         int numtriangles;
343         int *data_element3i;
344         int *data_neighbor3i;
345 }
346 q3mface_t;
347
348 typedef struct model_brushq3_s
349 {
350         int num_textures;
351         q3mtexture_t *data_textures;
352
353         int num_planes;
354         mplane_t *data_planes;
355
356         int num_nodes;
357         q3mnode_t *data_nodes;
358
359         int num_leafs;
360         q3mleaf_t *data_leafs;
361
362         int num_leafbrushes;
363         q3mbrush_t **data_leafbrushes;
364
365         int num_leaffaces;
366         q3mface_t **data_leaffaces;
367
368         int num_models;
369         q3mmodel_t *data_models;
370         // each submodel gets its own model struct so this is different for each.
371         q3mmodel_t data_thismodel;
372
373         int num_brushes;
374         q3mbrush_t *data_brushes;
375
376         int num_brushsides;
377         q3mbrushside_t *data_brushsides;
378
379         int num_vertices;
380         float *data_vertex3f;
381         float *data_texturetexcoord2f;
382         float *data_lightmaptexcoord2f;
383         float *data_svector3f;
384         float *data_tvector3f;
385         float *data_normal3f;
386         float *data_color4f;
387
388         int num_triangles;
389         int *data_element3i;
390         int *data_neighbor3i;
391
392         int num_effects;
393         q3meffect_t *data_effects;
394
395         int num_faces;
396         q3mface_t *data_faces;
397
398         // lightmap textures
399         int num_lightmaps;
400         rtexture_t **data_lightmaps;
401
402         // voxel light data with directional shading
403         int num_lightgrid;
404         q3dlightgrid_t *data_lightgrid;
405         // size of each cell (may vary by map, typically 64 64 128)
406         float num_lightgrid_cellsize[3];
407         // 1.0 / num_lightgrid_cellsize
408         float num_lightgrid_scale[3];
409         // dimensions of the world model in lightgrid cells
410         int num_lightgrid_imins[3];
411         int num_lightgrid_imaxs[3];
412         int num_lightgrid_isize[3];
413         // indexing/clamping
414         int num_lightgrid_dimensions[3];
415         // transform modelspace coordinates to lightgrid index
416         matrix4x4_t num_lightgrid_indexfromworld;
417
418         // pvs
419         int num_pvsclusters;
420         int num_pvschainlength;
421         unsigned char *data_pvschains;
422         // example
423         //pvschain = model->brushq3.data_pvschains + mycluster * model->brushq3.num_pvschainlength;
424         //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
425 }
426 model_brushq3_t;
427
428 typedef struct model_s
429 {
430         // name and path of model, for example "progs/player.mdl"
431         char                    name[MAX_QPATH];
432         // model needs to be loaded if this is true
433         qboolean                needload;
434         // set if the model is used in current map, models which are not, are purged
435         qboolean                used;
436         // true if this is the world model (I.E. defines what sky to use, and may contain submodels)
437         qboolean                isworldmodel;
438         // CRC of the file this model was loaded from, to reload if changed
439         unsigned int    crc;
440         // mod_brush, mod_alias, mod_sprite
441         modtype_t               type;
442         // memory pool for allocations
443         mempool_t               *mempool;
444         // all models use textures...
445         rtexturepool_t  *texturepool;
446         // flags from the model file
447         int                             flags;
448         // engine calculated flags, ones that can not be set in the file
449         int                             flags2;
450         // LordHavoc: if true (normally only for sprites) the model/sprite/bmodel is always rendered fullbright
451         int                             fullbright;
452         // number of QC accessible frame(group)s in the model
453         int                             numframes;
454         // number of QC accessible skin(group)s in the model
455         int                             numskins;
456         // whether to randomize animated framegroups
457         synctype_t              synctype;
458         // bounding box at angles '0 0 0'
459         vec3_t                  normalmins, normalmaxs;
460         // bounding box if yaw angle is not 0, but pitch and roll are
461         vec3_t                  yawmins, yawmaxs;
462         // bounding box if pitch or roll are used
463         vec3_t                  rotatedmins, rotatedmaxs;
464         // sphere radius, usable at any angles
465         float                   radius;
466         // squared sphere radius for easier comparisons
467         float                   radius2;
468         // skin animation info
469         animscene_t             *skinscenes; // [numskins]
470         // skin animation info
471         animscene_t             *animscenes; // [numframes]
472         // draw the model's sky polygons (only used by brush models)
473         void(*DrawSky)(struct entity_render_s *ent);
474         // draw the model using lightmap/dlight shading
475         void(*Draw)(struct entity_render_s *ent);
476         // draw a fake shadow for the model
477         void(*DrawFakeShadow)(struct entity_render_s *ent);
478         // draw a shadow volume for the model based on light source
479         void(*DrawShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius);
480         // draw the lighting on a model (through stencil)
481         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);
482         // fields belonging to each type of model
483         model_alias_t   alias;
484         model_sprite_t  sprite;
485         model_brush_t   brush;
486         model_brushq1_t brushq1;
487         /* MSVC can't handle an empty struct, so this is commented out for now
488         model_brushq2_t brushq2;
489         */
490         model_brushq3_t brushq3;
491         // skin files can have different tags for each skin
492         overridetagnameset_t    *data_overridetagnamesforskin;
493 }
494 model_t;
495
496 //============================================================================
497
498 // this can be used for anything without a valid texture
499 extern rtexture_t *r_notexture;
500 #define NUM_DETAILTEXTURES 1
501 extern rtexture_t *mod_shared_detailtextures[NUM_DETAILTEXTURES];
502 // every texture must be in a pool...
503 extern rtexturepool_t *mod_shared_texturepool;
504
505 // model loading
506 extern model_t *loadmodel;
507 extern qbyte *mod_base;
508 // sky/water subdivision
509 //extern cvar_t gl_subdivide_size;
510 // texture fullbrights
511 extern cvar_t r_fullbrights;
512
513 void Mod_Init (void);
514 void Mod_CheckLoaded (model_t *mod);
515 void Mod_ClearAll (void);
516 model_t *Mod_FindName (const char *name);
517 model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
518 void Mod_TouchModel (const char *name);
519 void Mod_UnloadModel (model_t *mod);
520
521 void Mod_ClearUsed(void);
522 void Mod_PurgeUnused(void);
523 void Mod_LoadModels(void);
524
525 extern model_t *loadmodel;
526 extern char loadname[32];       // for hunk tags
527
528 int Mod_FindTriangleWithEdge(const int *elements, int numtriangles, int start, int end, int ignore);
529 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
530 void Mod_ValidateElements(const int *elements, int numtriangles, int numverts, const char *filename, int fileline);
531 void Mod_BuildTextureVectorsAndNormals(int numverts, int numtriangles, const float *vertex, const float *texcoord, const int *elements, float *svectors, float *tvectors, float *normals);
532
533 shadowmesh_t *Mod_ShadowMesh_Alloc(mempool_t *mempool, int maxverts);
534 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh);
535 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *v);
536 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, float *vert0, float *vert1, float *vert2);
537 void Mod_ShadowMesh_AddPolygon(mempool_t *mempool, shadowmesh_t *mesh, int numverts, float *verts);
538 void Mod_ShadowMesh_AddMesh(mempool_t *mempool, shadowmesh_t *mesh, float *verts, int numtris, int *elements);
539 shadowmesh_t *Mod_ShadowMesh_Begin(mempool_t *mempool, int initialnumtriangles);
540 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh);
541 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
542 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
543
544 int Mod_LoadSkinFrame(skinframe_t *skinframe, char *basename, int textureflags, int loadpantsandshirt, int usedetailtexture, int loadglowtexture);
545 int Mod_LoadSkinFrame_Internal(skinframe_t *skinframe, char *basename, int textureflags, int loadpantsandshirt, int usedetailtexture, int loadglowtexture, qbyte *skindata, int width, int height);
546
547 extern cvar_t r_mipskins;
548
549 typedef struct skinfileitem_s
550 {
551         struct skinfileitem_s *next;
552         char name[MAX_QPATH];
553         char replacement[MAX_QPATH];
554 }
555 skinfileitem_t;
556
557 typedef struct skinfile_s
558 {
559         struct skinfile_s *next;
560         skinfileitem_t *items;
561 }
562 skinfile_t;
563
564 skinfile_t *Mod_LoadSkinFiles(void);
565 void Mod_FreeSkinFiles(skinfile_t *skinfile);
566 int Mod_CountSkinFiles(skinfile_t *skinfile);
567
568 #endif  // __MODEL__
569