2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
21 #ifndef MODEL_SHARED_H
22 #define MODEL_SHARED_H
24 typedef enum {ST_SYNC=0, ST_RAND } synctype_t;
28 d*_t structures are on-disk representations
29 m*_t structures are in-memory
33 typedef enum {mod_invalid, mod_brushq1, mod_sprite, mod_alias, mod_brushq2, mod_brushq3} modtype_t;
35 typedef struct animscene_s
37 char name[32]; // for viewthing support
40 int loop; // true or false
45 typedef struct skinframe_s
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 *detail; // detail texture (silly bumps for non-dot3)
55 rtexture_t *glow; // glow only (fullbrights)
56 rtexture_t *fog; // alpha of the base texture (if not opaque)
62 typedef struct overridetagname_s
68 // a replacement set of tag names, per skin
69 typedef struct overridetagnameset_s
71 int num_overridetagnames;
72 overridetagname_t *data_overridetagnames;
76 // LordHavoc: replaces glpoly, triangle mesh
77 typedef struct surfmesh_s
79 int num_vertices; // number of vertices in the mesh
80 int num_triangles; // number of triangles in the mesh
81 float *data_vertex3f; // float[verts*3] vertex locations
82 float *data_svector3f; // float[verts*3] direction of 'S' (right) texture axis for each vertex
83 float *data_tvector3f; // float[verts*3] direction of 'T' (down) texture axis for each vertex
84 float *data_normal3f; // float[verts*3] direction of 'R' (out) texture axis for each vertex
85 int *data_lightmapoffsets; // index into surface's lightmap samples for vertex lighting
86 float *data_texcoordtexture2f; // float[verts*2] texcoords for surface texture
87 float *data_texcoordlightmap2f; // float[verts*2] texcoords for lightmap texture
88 float *data_texcoorddetail2f; // float[verts*2] texcoords for detail texture
89 float *data_lightmapcolor4f;
90 int *data_element3i; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
91 int *data_neighbor3i; // int[tris*3] neighboring triangle on each edge (-1 if none)
93 int num_collisionvertices;
94 int num_collisiontriangles;
95 float *data_collisionvertex3f;
96 int *data_collisionelement3i;
100 #define SHADOWMESHVERTEXHASH 1024
101 typedef struct shadowmeshvertexhash_s
103 struct shadowmeshvertexhash_s *next;
105 shadowmeshvertexhash_t;
107 typedef struct shadowmesh_s
109 // next mesh in chain
110 struct shadowmesh_s *next;
111 // used for light mesh (NULL on shadow mesh)
112 rtexture_t *map_diffuse;
113 rtexture_t *map_specular;
114 rtexture_t *map_normal;
116 int numverts, maxverts;
117 int numtriangles, maxtriangles;
120 // used for light mesh (NULL on shadow mesh)
127 // used for shadow mesh (NULL on light mesh)
129 // these are NULL after Mod_ShadowMesh_Finish is performed, only used
130 // while building meshes
131 shadowmeshvertexhash_t **vertexhashtable, *vertexhashentries;
136 #include "matrixlib.h"
138 #include "model_brush.h"
139 #include "model_sprite.h"
140 #include "model_alias.h"
142 typedef struct model_alias_s
144 // mdl/md2/md3/zym model formats are treated the same after loading
146 // the shader meshes comprising this model
148 aliasmesh_t *aliasdata_meshes;
152 int aliasnum_tagframes;
153 aliastag_t *aliasdata_tags;
155 // for skeletal models
157 aliasbone_t *aliasdata_bones;
159 float *aliasdata_poses;
163 typedef struct model_sprite_s
166 mspriteframe_t *sprdata_frames;
172 typedef struct model_brush_s
174 // true if this model is a HalfLife .bsp file
176 // string of entity definitions (.map format)
178 // number of submodels in this map (just used by server to know how many
179 // submodels to load)
181 // pointers to each of the submodels if .isworldmodel is true
182 struct model_s **submodels;
186 int num_pvsclusterbytes;
187 unsigned char *data_pvsclusters;
189 //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
190 //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
192 // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
193 shadowmesh_t *shadowmesh;
196 int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
197 int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
198 qbyte *(*GetPVS)(struct model_s *model, const vec3_t p);
199 int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, qbyte *pvsbuffer, int pvsbufferlength);
200 int (*BoxTouchingPVS)(struct model_s *model, const qbyte *pvs, const vec3_t mins, const vec3_t maxs);
201 void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
202 void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
203 // these are actually only found on brushq1, but NULL is handled gracefully
204 void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, qbyte *out, int outsize);
205 void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
209 rtexture_t *solidskytexture;
210 rtexture_t *alphaskytexture;
214 typedef struct model_brushq1_s
216 // lightmap format, set to r_lightmaprgba when model is loaded
224 // number of actual leafs (including 0 which is solid)
226 // visible leafs, not counting 0 (solid)
243 msurface_t *surfaces;
244 int *surfacevisframes;
245 int *surfacepvsframes;
246 msurface_t *surfacepvsnext;
252 dclipnode_t *clipnodes;
257 hull_t hulls[MAX_MAP_HULLS];
262 int num_compressedpvs;
263 qbyte *data_compressedpvs;
272 mvertex_t *portalpoints;
277 // pvs visibility marking
278 mleaf_t *pvsviewleaf;
279 int pvsviewleafnovis;
281 mleaf_t *pvsleafchain;
283 int pvssurflistlength;
284 // these get rebuilt as the player moves around if this is the world,
285 // otherwise they are left alone (no pvs for bmodels)
286 msurface_t ***pvstexturechains;
287 msurface_t **pvstexturechainsbuffer;
288 int *pvstexturechainslength;
290 // lightmap update chains for light styles
293 int *light_stylevalue;
294 msurface_t ***light_styleupdatechains;
295 msurface_t **light_styleupdatechainsbuffer;
297 mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
298 void (*BuildPVSTextureChains)(struct model_s *model);
302 /* MSVC can't compile empty structs, so this is commented out for now
303 typedef struct model_brushq2_s
309 // surfaceflags from bsp
310 #define Q3SURFACEFLAG_NODAMAGE 1
311 #define Q3SURFACEFLAG_SLICK 2
312 #define Q3SURFACEFLAG_SKY 4
313 #define Q3SURFACEFLAG_LADDER 8
314 #define Q3SURFACEFLAG_NOIMPACT 16
315 #define Q3SURFACEFLAG_NOMARKS 32
316 #define Q3SURFACEFLAG_FLESH 64
317 #define Q3SURFACEFLAG_NODRAW 128
318 #define Q3SURFACEFLAG_HINT 256
319 #define Q3SURFACEFLAG_SKIP 512
320 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
321 #define Q3SURFACEFLAG_POINTLIGHT 2048
322 #define Q3SURFACEFLAG_METALSTEPS 4096
323 #define Q3SURFACEFLAG_NOSTEPS 8192
324 #define Q3SURFACEFLAG_NONSOLID 16384
325 #define Q3SURFACEFLAG_LIGHTFILTER 32768
326 #define Q3SURFACEFLAG_ALPHASHADOW 65536
327 #define Q3SURFACEFLAG_NODLIGHT 131072
328 #define Q3SURFACEFLAG_DUST 262144
330 // surfaceparms from shaders
331 #define Q3SURFACEPARM_ALPHASHADOW 1
332 #define Q3SURFACEPARM_AREAPORTAL 2
333 #define Q3SURFACEPARM_CLUSTERPORTAL 4
334 #define Q3SURFACEPARM_DETAIL 8
335 #define Q3SURFACEPARM_DONOTENTER 16
336 #define Q3SURFACEPARM_FOG 32
337 #define Q3SURFACEPARM_LAVA 64
338 #define Q3SURFACEPARM_LIGHTFILTER 128
339 #define Q3SURFACEPARM_METALSTEPS 256
340 #define Q3SURFACEPARM_NODAMAGE 512
341 #define Q3SURFACEPARM_NODLIGHT 1024
342 #define Q3SURFACEPARM_NODRAW 2048
343 #define Q3SURFACEPARM_NODROP 4096
344 #define Q3SURFACEPARM_NOIMPACT 8192
345 #define Q3SURFACEPARM_NOLIGHTMAP 16384
346 #define Q3SURFACEPARM_NOMARKS 32768
347 #define Q3SURFACEPARM_NOMIPMAPS 65536
348 #define Q3SURFACEPARM_NONSOLID 131072
349 #define Q3SURFACEPARM_ORIGIN 262144
350 #define Q3SURFACEPARM_PLAYERCLIP 524288
351 #define Q3SURFACEPARM_SKY 1048576
352 #define Q3SURFACEPARM_SLICK 2197152
353 #define Q3SURFACEPARM_SLIME 4194304
354 #define Q3SURFACEPARM_STRUCTURAL 8388608
355 #define Q3SURFACEPARM_TRANS 16777216
356 #define Q3SURFACEPARM_WATER 33554432
357 #define Q3SURFACEPARM_POINTLIGHT 67108864
359 // various flags from shaders
360 #define Q3TEXTUREFLAG_TWOSIDED 1
361 #define Q3TEXTUREFLAG_ADDITIVE 2
362 #define Q3TEXTUREFLAG_NOMIPMAPS 4
363 #define Q3TEXTUREFLAG_NOPICMIP 8
364 #define Q3TEXTUREFLAG_AUTOSPRITE 16
365 #define Q3TEXTUREFLAG_AUTOSPRITE2 32
366 #define Q3TEXTUREFLAG_ALPHATEST 64
369 typedef struct q3mtexture_s
371 char name[Q3PATHLENGTH];
372 char firstpasstexturename[Q3PATHLENGTH];
383 struct q3msurface_s **facelist;
388 typedef struct q3mnode_s
390 //this part shared between node and leaf
391 struct mplane_s *plane; // != NULL
392 struct q3mnode_s *parent;
395 // this part unique to nodes
396 struct q3mnode_s *children[2];
400 typedef struct q3mleaf_s
402 //this part shared between node and leaf
403 struct mplane_s *plane; // == NULL
404 struct q3mnode_s *parent;
407 // this part unique to leafs
411 struct q3msurface_s **firstleafface;
412 int *firstleaffacenum;
414 struct q3mbrush_s **firstleafbrush;
418 typedef struct q3mmodel_s
423 struct q3msurface_s *firstface;
425 struct q3mbrush_s *firstbrush;
429 typedef struct q3mbrush_s
431 struct colbrushf_s *colbrushf;
433 struct q3mbrushside_s *firstbrushside;
434 struct q3mtexture_s *texture;
438 typedef struct q3mbrushside_s
440 struct mplane_s *plane;
441 struct q3mtexture_s *texture;
445 typedef struct q3meffect_s
447 char shadername[Q3PATHLENGTH];
448 struct q3mbrush_s *brush;
449 int unknown; // 5 or -1
453 typedef struct q3msurface_s
455 // FIXME: collisionmarkframe should be kept in a separate array
456 // FIXME: visframe should be kept in a separate array
457 // FIXME: shadowmark should be kept in a separate array
459 struct q3mtexture_s *texture;
460 struct q3meffect_s *effect;
461 rtexture_t *lightmaptexture;
462 int collisionmarkframe; // don't collide twice in one trace
463 int visframe; // visframe == r_framecount means it is visible this frame
464 // bounding box for culling
470 // index into model->brush.shadowmesh
471 int num_firstshadowmeshtriangle;
473 // used for shadow volume generation
478 typedef struct model_brushq3_s
480 // if non-zero this is a submodel
481 // (this is the number of the submodel, an index into data_models)
485 q3mtexture_t *data_textures;
486 q3msurface_t **data_texturefaces;
487 int *data_texturefacenums;
490 mplane_t *data_planes;
493 q3mnode_t *data_nodes;
496 q3mleaf_t *data_leafs;
499 q3mbrush_t **data_leafbrushes;
502 q3msurface_t **data_leaffaces;
503 int *data_leaffacenums;
506 q3mmodel_t *data_models;
507 // each submodel gets its own model struct so this is different for each.
508 q3mmodel_t *data_thismodel;
511 q3mbrush_t *data_brushes;
514 q3mbrushside_t *data_brushsides;
517 float *data_vertex3f;
518 float *data_texcoordtexture2f;
519 float *data_texcoordlightmap2f;
520 float *data_svector3f;
521 float *data_tvector3f;
522 float *data_normal3f;
527 int *data_neighbor3i;
530 q3meffect_t *data_effects;
533 q3msurface_t *data_faces;
537 rtexture_t **data_lightmaps;
539 // voxel light data with directional shading
541 q3dlightgrid_t *data_lightgrid;
542 // size of each cell (may vary by map, typically 64 64 128)
543 float num_lightgrid_cellsize[3];
544 // 1.0 / num_lightgrid_cellsize
545 float num_lightgrid_scale[3];
546 // dimensions of the world model in lightgrid cells
547 int num_lightgrid_imins[3];
548 int num_lightgrid_imaxs[3];
549 int num_lightgrid_isize[3];
551 int num_lightgrid_dimensions[3];
552 // transform modelspace coordinates to lightgrid index
553 matrix4x4_t num_lightgrid_indexfromworld;
557 typedef struct model_s
559 // name and path of model, for example "progs/player.mdl"
560 char name[MAX_QPATH];
561 // model needs to be loaded if this is false
563 // set if the model is used in current map, models which are not, are purged
565 // true if this is the world model (I.E. defines what sky to use, and may contain submodels)
566 qboolean isworldmodel;
567 // CRC of the file this model was loaded from, to reload if changed
569 // mod_brush, mod_alias, mod_sprite
571 // memory pool for allocations
573 // all models use textures...
574 rtexturepool_t *texturepool;
575 // flags from the model file
577 // engine calculated flags, ones that can not be set in the file
579 // number of QC accessible frame(group)s in the model
581 // number of QC accessible skin(group)s in the model
583 // whether to randomize animated framegroups
585 // bounding box at angles '0 0 0'
586 vec3_t normalmins, normalmaxs;
587 // bounding box if yaw angle is not 0, but pitch and roll are
588 vec3_t yawmins, yawmaxs;
589 // bounding box if pitch or roll are used
590 vec3_t rotatedmins, rotatedmaxs;
591 // sphere radius, usable at any angles
593 // squared sphere radius for easier comparisons
595 // skin animation info
596 animscene_t *skinscenes; // [numskins]
597 // skin animation info
598 animscene_t *animscenes; // [numframes]
599 // range of surface numbers in this (sub)model
600 int firstmodelsurface;
601 int nummodelsurfaces;
602 // list of surface numbers in this (sub)model
604 // surface meshes are merged to a smaller set of meshes to allow reduced
605 // vertex array switching, the meshes are limited to 65536 vertices each
606 // to play nice with Geforce1 hardware
608 surfmesh_t **meshlist;
609 // draw the model's sky polygons (only used by brush models)
610 void(*DrawSky)(struct entity_render_s *ent);
611 // draw the model using lightmap/dlight shading
612 void(*Draw)(struct entity_render_s *ent);
613 // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
614 void(*GetLightInfo)(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius, vec3_t outmins, vec3_t outmaxs, int *outclusterlist, qbyte *outclusterpvs, int *outnumclusterspointer, int *outsurfacelist, qbyte *outsurfacepvs, int *outnumsurfacespointer);
615 // draw a shadow volume for the model based on light source
616 void(*DrawShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius, int numsurfaces, const int *surfacelist);
617 // draw the lighting on a model (through stencil)
618 void(*DrawLight)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativeeyeorigin, float lightradius, float *lightcolor, const matrix4x4_t *matrix_modeltolight, const matrix4x4_t *matrix_modeltoattenuationxyz, const matrix4x4_t *matrix_modeltoattenuationz, rtexture_t *lightcubemap, vec_t ambientscale, vec_t diffusescale, vec_t specularscale, int numsurfaces, const int *surfacelist);
619 // trace a box against this model
620 void (*TraceBox)(struct model_s *model, int frame, struct trace_s *trace, const vec3_t boxstartmins, const vec3_t boxstartmaxs, const vec3_t boxendmins, const vec3_t boxendmaxs, int hitsupercontentsmask);
621 // fields belonging to each type of model
623 model_sprite_t sprite;
625 model_brushq1_t brushq1;
626 /* MSVC can't handle an empty struct, so this is commented out for now
627 model_brushq2_t brushq2;
629 model_brushq3_t brushq3;
630 // skin files can have different tags for each skin
631 overridetagnameset_t *data_overridetagnamesforskin;
632 // flags this model for offseting sounds to the model center (used by brush models)
637 //============================================================================
639 // this can be used for anything without a valid texture
640 extern rtexture_t *r_notexture;
641 #define NUM_DETAILTEXTURES 1
642 extern rtexture_t *mod_shared_detailtextures[NUM_DETAILTEXTURES];
643 // every texture must be in a pool...
644 extern rtexturepool_t *mod_shared_texturepool;
646 extern rtexture_t *mod_shared_distorttexture[64];
649 extern model_t *loadmodel;
650 extern qbyte *mod_base;
651 // sky/water subdivision
652 //extern cvar_t gl_subdivide_size;
653 // texture fullbrights
654 extern cvar_t r_fullbrights;
656 void Mod_Init (void);
657 void Mod_CheckLoaded (model_t *mod);
658 void Mod_ClearAll (void);
659 model_t *Mod_FindName (const char *name);
660 model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
661 void Mod_UnloadModel (model_t *mod);
663 void Mod_ClearUsed(void);
664 void Mod_PurgeUnused(void);
665 void Mod_LoadModels(void);
667 extern model_t *loadmodel;
668 extern char loadname[32]; // for hunk tags
670 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
671 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
672 void Mod_ValidateElements(const int *elements, int numtriangles, int numverts, const char *filename, int fileline);
673 void Mod_BuildNormals(int numverts, int numtriangles, const float *vertex3f, const int *elements, float *normal3f);
674 void Mod_BuildTextureVectorsAndNormals(int numverts, int numtriangles, const float *vertex, const float *texcoord, const int *elements, float *svectors, float *tvectors, float *normals);
676 surfmesh_t *Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, int numcollisionvertices, int numcollisiontriangles, qboolean detailtexcoords, qboolean lightmapoffsets, qboolean vertexcolors);
678 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);
679 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
680 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
681 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
682 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);
683 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);
684 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, int light, int neighbors);
685 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
686 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
688 int Mod_LoadSkinFrame(skinframe_t *skinframe, char *basename, int textureflags, int loadpantsandshirt, int usedetailtexture, int loadglowtexture);
689 int Mod_LoadSkinFrame_Internal(skinframe_t *skinframe, char *basename, int textureflags, int loadpantsandshirt, int usedetailtexture, int loadglowtexture, qbyte *skindata, int width, int height);
691 // used for talking to the QuakeC mainly
692 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
693 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
695 extern cvar_t r_mipskins;
697 typedef struct skinfileitem_s
699 struct skinfileitem_s *next;
700 char name[MAX_QPATH];
701 char replacement[MAX_QPATH];
705 typedef struct skinfile_s
707 struct skinfile_s *next;
708 skinfileitem_t *items;
712 skinfile_t *Mod_LoadSkinFiles(void);
713 void Mod_FreeSkinFiles(skinfile_t *skinfile);
714 int Mod_CountSkinFiles(skinfile_t *skinfile);
716 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
717 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
719 #endif // MODEL_SHARED_H