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 int *data_element3i; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
83 float *data_texcoordtexture2f; // float[verts*2] texcoords for surface texture
84 float *data_texcoordlightmap2f; // float[verts*2] texcoords for lightmap texture
85 float *data_lightmapcolor4f;
86 float *data_svector3f; // float[verts*3] direction of 'S' (right) texture axis for each vertex
87 float *data_tvector3f; // float[verts*3] direction of 'T' (down) texture axis for each vertex
88 float *data_normal3f; // float[verts*3] direction of 'R' (out) texture axis for each vertex
89 int *data_lightmapoffsets; // index into surface's lightmap samples for vertex lighting
90 float *data_texcoorddetail2f; // float[verts*2] texcoords for detail texture
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)
179 // if non-zero this is a submodel
180 // (this is the number of the submodel, an index into submodels)
183 // number of submodels in this map (just used by server to know how many
184 // submodels to load)
186 // pointers to each of the submodels if .isworldmodel is true
187 struct model_s **submodels;
190 mplane_t *data_planes;
195 // visible leafs, not counting 0 (solid)
197 // number of actual leafs (including 0 which is solid)
202 int *data_leafbrushes;
204 int num_leafsurfaces;
205 int *data_leafsurfaces;
208 mportal_t *data_portals;
210 int num_portalpoints;
211 mvertex_t *data_portalpoints;
214 texture_t *data_textures;
217 msurface_t *data_surfaces;
220 q3mbrush_t *data_brushes;
223 q3mbrushside_t *data_brushsides;
227 int num_pvsclusterbytes;
228 unsigned char *data_pvsclusters;
230 //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
231 //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
233 // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
234 shadowmesh_t *shadowmesh;
237 int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
238 int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
239 qbyte *(*GetPVS)(struct model_s *model, const vec3_t p);
240 int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, qbyte *pvsbuffer, int pvsbufferlength);
241 int (*BoxTouchingPVS)(struct model_s *model, const qbyte *pvs, const vec3_t mins, const vec3_t maxs);
242 int (*BoxTouchingVisibleLeafs)(struct model_s *model, const qbyte *visibleleafs, const vec3_t mins, const vec3_t maxs);
243 void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
244 void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
245 // these are actually only found on brushq1, but NULL is handled gracefully
246 void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, qbyte *out, int outsize);
247 void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
251 rtexture_t *solidskytexture;
252 rtexture_t *alphaskytexture;
256 typedef struct model_brushq1_s
258 // lightmap format, set to r_lightmaprgba when model is loaded
276 dclipnode_t *clipnodes;
278 hull_t hulls[MAX_MAP_HULLS];
280 int num_compressedpvs;
281 qbyte *data_compressedpvs;
289 // lightmap update chains for light styles
292 int *light_stylevalue;
293 msurface_t ***light_styleupdatechains;
294 msurface_t **light_styleupdatechainsbuffer;
296 mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
300 /* MSVC can't compile empty structs, so this is commented out for now
301 typedef struct model_brushq2_s
307 typedef struct model_brushq3_s
310 q3dmodel_t *data_models;
312 // freed after loading!
314 float *data_vertex3f;
315 float *data_texcoordtexture2f;
316 float *data_texcoordlightmap2f;
319 // freed after loading!
324 q3deffect_t *data_effects;
328 rtexture_t **data_lightmaps;
330 // voxel light data with directional shading
332 q3dlightgrid_t *data_lightgrid;
333 // size of each cell (may vary by map, typically 64 64 128)
334 float num_lightgrid_cellsize[3];
335 // 1.0 / num_lightgrid_cellsize
336 float num_lightgrid_scale[3];
337 // dimensions of the world model in lightgrid cells
338 int num_lightgrid_imins[3];
339 int num_lightgrid_imaxs[3];
340 int num_lightgrid_isize[3];
342 int num_lightgrid_dimensions[3];
343 // transform modelspace coordinates to lightgrid index
344 matrix4x4_t num_lightgrid_indexfromworld;
348 typedef struct model_s
350 // name and path of model, for example "progs/player.mdl"
351 char name[MAX_QPATH];
352 // model needs to be loaded if this is false
354 // set if the model is used in current map, models which are not, are purged
356 // true if this is the world model (I.E. defines what sky to use, and may contain submodels)
357 qboolean isworldmodel;
358 // CRC of the file this model was loaded from, to reload if changed
360 // mod_brush, mod_alias, mod_sprite
362 // memory pool for allocations
364 // all models use textures...
365 rtexturepool_t *texturepool;
366 // flags from the model file
368 // engine calculated flags, ones that can not be set in the file
370 // number of QC accessible frame(group)s in the model
372 // number of QC accessible skin(group)s in the model
374 // whether to randomize animated framegroups
376 // bounding box at angles '0 0 0'
377 vec3_t normalmins, normalmaxs;
378 // bounding box if yaw angle is not 0, but pitch and roll are
379 vec3_t yawmins, yawmaxs;
380 // bounding box if pitch or roll are used
381 vec3_t rotatedmins, rotatedmaxs;
382 // sphere radius, usable at any angles
384 // squared sphere radius for easier comparisons
386 // skin animation info
387 animscene_t *skinscenes; // [numskins]
388 // skin animation info
389 animscene_t *animscenes; // [numframes]
390 // range of surface numbers in this (sub)model
391 int firstmodelsurface;
392 int nummodelsurfaces;
393 // range of collision brush numbers in this (sub)model
396 // list of surface numbers in this (sub)model
398 // surface meshes are merged to a smaller set of meshes to allow reduced
399 // vertex array switching, the meshes are limited to 65536 vertices each
400 // to play nice with Geforce1 hardware
402 surfmesh_t **meshlist;
403 // draw the model's sky polygons (only used by brush models)
404 void(*DrawSky)(struct entity_render_s *ent);
405 // draw the model using lightmap/dlight shading
406 void(*Draw)(struct entity_render_s *ent);
407 // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
408 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);
409 // draw a shadow volume for the model based on light source
410 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);
411 // draw the lighting on a model (through stencil)
412 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);
413 // trace a box against this model
414 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);
415 // fields belonging to each type of model
417 model_sprite_t sprite;
419 model_brushq1_t brushq1;
420 /* MSVC can't handle an empty struct, so this is commented out for now
421 model_brushq2_t brushq2;
423 model_brushq3_t brushq3;
424 // skin files can have different tags for each skin
425 overridetagnameset_t *data_overridetagnamesforskin;
426 // flags this model for offseting sounds to the model center (used by brush models)
431 //============================================================================
433 // this can be used for anything without a valid texture
434 extern rtexture_t *r_texture_notexture;
435 #define NUM_DETAILTEXTURES 1
436 extern rtexture_t *mod_shared_detailtextures[NUM_DETAILTEXTURES];
437 // every texture must be in a pool...
438 extern rtexturepool_t *mod_shared_texturepool;
440 extern rtexture_t *mod_shared_distorttexture[64];
443 extern model_t *loadmodel;
444 extern qbyte *mod_base;
445 // sky/water subdivision
446 //extern cvar_t gl_subdivide_size;
447 // texture fullbrights
448 extern cvar_t r_fullbrights;
450 void Mod_Init (void);
451 void Mod_CheckLoaded (model_t *mod);
452 void Mod_ClearAll (void);
453 model_t *Mod_FindName (const char *name);
454 model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
455 void Mod_UnloadModel (model_t *mod);
457 void Mod_ClearUsed(void);
458 void Mod_PurgeUnused(void);
459 void Mod_RemoveStaleWorldModels(model_t *skip); // only used during loading!
460 void Mod_LoadModels(void);
462 extern model_t *loadmodel;
463 extern char loadname[32]; // for hunk tags
465 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
466 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
467 void Mod_ValidateElements(const int *elements, int numtriangles, int numverts, const char *filename, int fileline);
468 void Mod_BuildNormals(int numverts, int numtriangles, const float *vertex3f, const int *elements, float *normal3f);
469 void Mod_BuildTextureVectorsAndNormals(int numverts, int numtriangles, const float *vertex, const float *texcoord, const int *elements, float *svectors, float *tvectors, float *normals);
471 surfmesh_t *Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, int numcollisionvertices, int numcollisiontriangles, qboolean detailtexcoords, qboolean lightmapoffsets, qboolean vertexcolors);
473 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);
474 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
475 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
476 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
477 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);
478 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);
479 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, int light, int neighbors);
480 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
481 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
483 int Mod_LoadSkinFrame(skinframe_t *skinframe, char *basename, int textureflags, int loadpantsandshirt, int usedetailtexture, int loadglowtexture);
484 int Mod_LoadSkinFrame_Internal(skinframe_t *skinframe, char *basename, int textureflags, int loadpantsandshirt, int usedetailtexture, int loadglowtexture, qbyte *skindata, int width, int height);
486 // used for talking to the QuakeC mainly
487 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
488 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
490 extern cvar_t r_mipskins;
492 typedef struct skinfileitem_s
494 struct skinfileitem_s *next;
495 char name[MAX_QPATH];
496 char replacement[MAX_QPATH];
500 typedef struct skinfile_s
502 struct skinfile_s *next;
503 skinfileitem_t *items;
507 skinfile_t *Mod_LoadSkinFiles(void);
508 void Mod_FreeSkinFiles(skinfile_t *skinfile);
509 int Mod_CountSkinFiles(skinfile_t *skinfile);
511 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
512 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
514 #endif // MODEL_SHARED_H