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 synctype_e {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 modtype_e {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 *glow; // glow only (fullbrights)
55 rtexture_t *fog; // alpha of the base texture (if not opaque)
61 typedef struct overridetagname_s
67 // a replacement set of tag names, per skin
68 typedef struct overridetagnameset_s
70 int num_overridetagnames;
71 overridetagname_t *data_overridetagnames;
75 // used for mesh lists in q1bsp/q3bsp map models
76 // (the surfaces reference portions of these meshes)
77 typedef struct surfmesh_s
79 int num_triangles; // number of triangles in the mesh
80 int *data_element3i; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
81 int *data_neighbor3i; // int[tris*3] neighboring triangle on each edge (-1 if none)
82 int num_vertices; // number of vertices in the mesh
83 float *data_vertex3f; // float[verts*3] vertex locations
84 float *data_svector3f; // float[verts*3] direction of 'S' (right) texture axis for each vertex
85 float *data_tvector3f; // float[verts*3] direction of 'T' (down) texture axis for each vertex
86 float *data_normal3f; // float[verts*3] direction of 'R' (out) texture axis for each vertex
87 float *data_texcoordtexture2f; // float[verts*2] texcoords for surface texture
88 float *data_texcoordlightmap2f; // float[verts*2] texcoords for lightmap texture
89 float *data_lightmapcolor4f;
90 int *data_lightmapoffsets; // index into surface's lightmap samples for vertex lighting
91 // morph blending, these are zero if model is skeletal or static
93 float *data_morphvertex3f;
94 // skeletal blending, these are NULL if model is morph or static
95 int *data_vertexweightindex4i;
96 float *data_vertexweightinfluence4f;
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;
135 typedef enum texturelayertype_e
137 TEXTURELAYERTYPE_INVALID,
138 TEXTURELAYERTYPE_LITTEXTURE,
139 TEXTURELAYERTYPE_TEXTURE,
140 TEXTURELAYERTYPE_FOG,
144 typedef enum texturelayerflag_e
146 // indicates that the pass should apply fog darkening; used on
147 // transparent surfaces where simply blending an alpha fog as a final
148 // pass would not behave properly, so all the surfaces must be darkened,
149 // and the fog color added as a separate pass
150 TEXTURELAYERFLAG_FOGDARKEN = 1,
154 typedef struct texturelayer_s
156 texturelayertype_t type;
161 matrix4x4_t texmatrix;
167 typedef struct texture_s
173 unsigned int width, height;
175 //unsigned int flags;
177 // base material flags
178 int basematerialflags;
179 // current material flags (updated each bmodel render)
180 int currentmaterialflags;
182 // loaded the same as model skins
185 // total frames in sequence and alternate sequence
187 // direct pointers to each of the frames in the sequences
188 // (indexed as [alternate][frame])
189 struct texture_s *anim_frames[2][10];
190 // set if animated or there is an alternate frame set
191 // (this is an optimization in the renderer)
194 // the current alpha of this texture (may be affected by r_wateralpha)
196 // the current texture frame in animation
197 struct texture_s *currentframe;
198 // current texture transform matrix (used for water scrolling)
199 matrix4x4_t currenttexmatrix;
201 qboolean colormapping;
202 rtexture_t *basetexture;
203 rtexture_t *glosstexture;
208 int customblendfunc[2];
210 int currentnumlayers;
211 texturelayer_t currentlayers[16];
224 typedef struct mtexinfo_s
232 typedef struct msurface_lightmapinfo_s
234 // texture mapping properties used by this surface
235 mtexinfo_t *texinfo; // q1bsp
236 // index into r_refdef.lightstylevalue array, 255 means not used (black)
237 unsigned char styles[MAXLIGHTMAPS]; // q1bsp
238 // RGB lighting data [numstyles][height][width][3]
239 unsigned char *samples; // q1bsp
240 // RGB normalmap data [numstyles][height][width][3]
241 unsigned char *nmapsamples; // q1bsp
242 // stain to apply on lightmap (soot/dirt/blood/whatever)
243 unsigned char *stainsamples; // q1bsp
244 int texturemins[2]; // q1bsp
245 int extents[2]; // q1bsp
246 int lightmaporigin[2]; // q1bsp
248 msurface_lightmapinfo_t;
251 typedef struct msurface_s
253 // bounding box for onscreen checks
256 // the texture to use on the surface
258 // the lightmap texture fragment to use on the rendering mesh
259 rtexture_t *lightmaptexture;
260 // the lighting direction texture fragment to use on the rendering mesh
261 rtexture_t *deluxemaptexture;
263 // surfaces own ranges of vertices and triangles in the model->surfmesh
264 int num_triangles; // number of triangles
265 int num_firsttriangle; // first triangle
266 int num_vertices; // number of vertices
267 int num_firstvertex; // first vertex
269 // shadow volume building information
270 int num_firstshadowmeshtriangle; // index into model->brush.shadowmesh
272 // lightmaptexture rebuild information not used in q3bsp
273 int cached_dlight; // q1bsp // forces rebuild of lightmaptexture
274 msurface_lightmapinfo_t *lightmapinfo; // q1bsp
276 // mesh information for collisions (only used by q3bsp curves)
277 int num_collisiontriangles; // q3bsp
278 int *data_collisionelement3i; // q3bsp
279 int num_collisionvertices; // q3bsp
280 float *data_collisionvertex3f; // q3bsp
281 struct q3deffect_s *effect; // q3bsp
282 // FIXME: collisionmarkframe should be kept in a separate array
283 int collisionmarkframe; // q3bsp // don't collide twice in one trace
287 #include "matrixlib.h"
289 #include "model_brush.h"
290 #include "model_sprite.h"
291 #include "model_alias.h"
293 typedef struct model_sprite_s
296 mspriteframe_t *sprdata_frames;
302 typedef struct model_brush_s
304 // true if this model is a HalfLife .bsp file
306 // true if this model is a Martial Concert .bsp file
308 // string of entity definitions (.map format)
311 // if non-zero this is a submodel
312 // (this is the number of the submodel, an index into submodels)
315 // number of submodels in this map (just used by server to know how many
316 // submodels to load)
318 // pointers to each of the submodels if .isworldmodel is true
319 struct model_s **submodels;
322 mplane_t *data_planes;
327 // visible leafs, not counting 0 (solid)
329 // number of actual leafs (including 0 which is solid)
334 int *data_leafbrushes;
336 int num_leafsurfaces;
337 int *data_leafsurfaces;
340 mportal_t *data_portals;
342 int num_portalpoints;
343 mvertex_t *data_portalpoints;
346 q3mbrush_t *data_brushes;
349 q3mbrushside_t *data_brushsides;
353 int num_pvsclusterbytes;
354 unsigned char *data_pvsclusters;
356 //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
357 //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
359 // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
360 shadowmesh_t *shadowmesh;
363 int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
364 int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
365 unsigned char *(*GetPVS)(struct model_s *model, const vec3_t p);
366 int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, unsigned char *pvsbuffer, int pvsbufferlength);
367 int (*BoxTouchingPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
368 int (*BoxTouchingLeafPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
369 int (*BoxTouchingVisibleLeafs)(struct model_s *model, const unsigned char *visibleleafs, const vec3_t mins, const vec3_t maxs);
370 int (*FindBoxClusters)(struct model_s *model, const vec3_t mins, const vec3_t maxs, int maxclusters, int *clusterlist);
371 void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
372 void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
373 mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
374 // these are actually only found on brushq1, but NULL is handled gracefully
375 void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, unsigned char *out, int outsize);
376 void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
378 char skybox[MAX_QPATH];
380 rtexture_t *solidskytexture;
381 rtexture_t *alphaskytexture;
389 typedef struct model_brushq1_s
391 // lightmap format, set to r_lightmaprgba when model is loaded
409 dclipnode_t *clipnodes;
411 hull_t hulls[MAX_MAP_HULLS];
413 int num_compressedpvs;
414 unsigned char *data_compressedpvs;
417 unsigned char *lightdata;
418 unsigned char *nmaplightdata; // deluxemap file
420 // lightmap update chains for light styles
422 unsigned char *light_style;
423 int *light_stylevalue;
424 msurface_t ***light_styleupdatechains;
425 msurface_t **light_styleupdatechainsbuffer;
429 /* MSVC can't compile empty structs, so this is commented out for now
430 typedef struct model_brushq2_s
436 typedef struct model_brushq3_s
439 q3dmodel_t *data_models;
441 // used only during loading - freed after loading!
443 float *data_vertex3f;
444 float *data_normal3f;
445 float *data_texcoordtexture2f;
446 float *data_texcoordlightmap2f;
449 // freed after loading!
454 q3deffect_t *data_effects;
458 rtexture_t **data_lightmaps;
460 // voxel light data with directional shading
462 q3dlightgrid_t *data_lightgrid;
463 // size of each cell (may vary by map, typically 64 64 128)
464 float num_lightgrid_cellsize[3];
465 // 1.0 / num_lightgrid_cellsize
466 float num_lightgrid_scale[3];
467 // dimensions of the world model in lightgrid cells
468 int num_lightgrid_imins[3];
469 int num_lightgrid_imaxs[3];
470 int num_lightgrid_isize[3];
472 int num_lightgrid_dimensions[3];
473 // transform modelspace coordinates to lightgrid index
474 matrix4x4_t num_lightgrid_indexfromworld;
476 // true if this q3bsp file has been detected as using deluxemapping
477 // (lightmap texture pairs, every odd one is never directly refernced,
478 // and contains lighting normals, not colors)
479 qboolean deluxemapping;
480 // true if the detected deluxemaps are the modelspace kind, rather than
481 // the faster tangentspace kind
482 qboolean deluxemapping_modelspace;
486 typedef struct model_s
488 // name and path of model, for example "progs/player.mdl"
489 char name[MAX_QPATH];
490 // model needs to be loaded if this is false
492 // set if the model is used in current map, models which are not, are purged
494 // true if this is the world model (I.E. defines what sky to use, and may contain submodels)
495 qboolean isworldmodel;
496 // CRC of the file this model was loaded from, to reload if changed
498 // mod_brush, mod_alias, mod_sprite
500 // memory pool for allocations
502 // all models use textures...
503 rtexturepool_t *texturepool;
504 // flags from the model file
506 // engine calculated flags, ones that can not be set in the file
508 // number of QC accessible frame(group)s in the model
510 // number of QC accessible skin(group)s in the model
512 // whether to randomize animated framegroups
514 // bounding box at angles '0 0 0'
515 vec3_t normalmins, normalmaxs;
516 // bounding box if yaw angle is not 0, but pitch and roll are
517 vec3_t yawmins, yawmaxs;
518 // bounding box if pitch or roll are used
519 vec3_t rotatedmins, rotatedmaxs;
520 // sphere radius, usable at any angles
522 // squared sphere radius for easier comparisons
524 // skin animation info
525 animscene_t *skinscenes; // [numskins]
526 // skin animation info
527 animscene_t *animscenes; // [numframes]
528 // range of surface numbers in this (sub)model
529 int firstmodelsurface;
530 int nummodelsurfaces;
531 // range of collision brush numbers in this (sub)model
534 // list of surface numbers in this (sub)model
539 aliastag_t *data_tags;
540 // for skeletal models
542 aliasbone_t *data_bones;
545 float *data_basebonepose;
546 float *data_baseboneposeinverse;
547 // textures of this model
549 texture_t *data_textures;
550 // surfaces of this model
552 msurface_t *data_surfaces;
553 // optional lightmapinfo data for surface lightmap updates
554 msurface_lightmapinfo_t *data_surfaces_lightmapinfo;
555 // all surfaces belong to this mesh
557 // draw the model's sky polygons (only used by brush models)
558 void(*DrawSky)(struct entity_render_s *ent);
559 // draw the model using lightmap/dlight shading
560 void(*Draw)(struct entity_render_s *ent);
561 // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
562 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);
563 // compile a shadow volume for the model based on light source
564 void(*CompileShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius, int numsurfaces, const int *surfacelist);
565 // draw a shadow volume for the model based on light source
566 void(*DrawShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius, int numsurfaces, const int *surfacelist, const vec3_t lightmins, const vec3_t lightmaxs);
567 // draw the lighting on a model (through stencil)
568 void(*DrawLight)(struct entity_render_s *ent, int numsurfaces, const int *surfacelist);
569 // trace a box against this model
570 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);
571 // fields belonging to some types of model
572 model_sprite_t sprite;
574 model_brushq1_t brushq1;
575 /* MSVC can't handle an empty struct, so this is commented out for now
576 model_brushq2_t brushq2;
578 model_brushq3_t brushq3;
579 // skin files can have different tags for each skin
580 overridetagnameset_t *data_overridetagnamesforskin;
581 // flags this model for offseting sounds to the model center (used by brush models)
586 //============================================================================
589 extern model_t *loadmodel;
590 extern unsigned char *mod_base;
591 // sky/water subdivision
592 //extern cvar_t gl_subdivide_size;
593 // texture fullbrights
594 extern cvar_t r_fullbrights;
596 void Mod_Init (void);
597 model_t *Mod_LoadModel(model_t *mod, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
598 model_t *Mod_FindName (const char *name);
599 model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
600 void Mod_UnloadModel (model_t *mod);
602 void Mod_ClearUsed(void);
603 void Mod_PurgeUnused(void);
604 void Mod_RemoveStaleWorldModels(model_t *skip); // only used during loading!
606 extern model_t *loadmodel;
607 extern char loadname[32]; // for hunk tags
609 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
610 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
611 void Mod_ValidateElements(int *elements, int numtriangles, int firstvertex, int numverts, const char *filename, int fileline);
612 void Mod_BuildNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const int *elements, float *normal3f, qboolean areaweighting);
613 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);
615 void Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, qboolean lightmapoffsets, qboolean vertexcolors, qboolean neighbors);
617 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);
618 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
619 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
620 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
621 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);
622 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);
623 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, int light, int neighbors);
624 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
625 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
627 int Mod_LoadSkinFrame(skinframe_t *skinframe, const char *basename, int textureflags, int loadpantsandshirt, int loadglowtexture);
628 int Mod_LoadSkinFrame_Internal(skinframe_t *skinframe, const char *basename, int textureflags, int loadpantsandshirt, int loadglowtexture, const unsigned char *skindata, int width, int height, int bitsperpixel, const unsigned int *palette, const unsigned int *alphapalette);
630 extern cvar_t r_mipskins;
632 typedef struct skinfileitem_s
634 struct skinfileitem_s *next;
635 char name[MAX_QPATH];
636 char replacement[MAX_QPATH];
640 typedef struct skinfile_s
642 struct skinfile_s *next;
643 skinfileitem_t *items;
647 skinfile_t *Mod_LoadSkinFiles(void);
648 void Mod_FreeSkinFiles(skinfile_t *skinfile);
649 int Mod_CountSkinFiles(skinfile_t *skinfile);
651 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
652 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
655 void Mod_BrushInit(void);
656 // used for talking to the QuakeC mainly
657 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
658 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
660 // a lot of model formats use the Q1BSP code, so here are the prototypes...
661 struct entity_render_s;
662 void R_Q1BSP_DrawSky(struct entity_render_s *ent);
663 void R_Q1BSP_Draw(struct entity_render_s *ent);
664 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);
665 void R_Q1BSP_CompileShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius, int numsurfaces, const int *surfacelist);
666 void R_Q1BSP_DrawShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius, int numsurfaces, const int *surfacelist, const vec3_t lightmins, const vec3_t lightmaxs);
667 void R_Q1BSP_DrawLight(struct entity_render_s *ent, int numsurfaces, const int *surfacelist);
671 void Mod_AliasInit(void);
672 void Mod_Alias_GetMesh_Vertices(const model_t *model, const struct frameblend_s *frameblend, float *vertex3f, float *normal3f, float *svector3f, float *tvector3f);
673 int Mod_Alias_GetTagMatrix(const model_t *model, int poseframe, int tagindex, matrix4x4_t *outmatrix);
674 int Mod_Alias_GetTagIndexForName(const model_t *model, unsigned int skin, const char *tagname);
677 void Mod_SpriteInit(void);
680 void Mod_Q1BSP_Load(model_t *mod, void *buffer, void *bufferend);
681 void Mod_IBSP_Load(model_t *mod, void *buffer, void *bufferend);
682 void Mod_MAP_Load(model_t *mod, void *buffer, void *bufferend);
683 void Mod_IDP0_Load(model_t *mod, void *buffer, void *bufferend);
684 void Mod_IDP2_Load(model_t *mod, void *buffer, void *bufferend);
685 void Mod_IDP3_Load(model_t *mod, void *buffer, void *bufferend);
686 void Mod_ZYMOTICMODEL_Load(model_t *mod, void *buffer, void *bufferend);
687 void Mod_DARKPLACESMODEL_Load(model_t *mod, void *buffer, void *bufferend);
688 void Mod_PSKMODEL_Load(model_t *mod, void *buffer, void *bufferend);
689 void Mod_IDSP_Load(model_t *mod, void *buffer, void *bufferend);
690 void Mod_IDS2_Load(model_t *mod, void *buffer, void *bufferend);
692 #endif // MODEL_SHARED_H