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_SHARED_H
  22 #define MODEL_SHARED_H
  23
  24 typedef enum {ST_SYNC=0, ST_RAND } synctype_t;
  25
  26 /*
  27
  28 d*_t structures are on-disk representations
  29 m*_t structures are in-memory
  30
  31 */
  32
  33 typedef enum {mod_invalid, mod_brushq1, mod_sprite, mod_alias, mod_brushq2, mod_brushq3} modtype_t;
  34
  35 typedef struct animscene_s
  36 {
  37         char name[32]; // for viewthing support
  38         int firstframe;
  39         int framecount;
  40         int loop; // true or false
  41         float framerate;
  42 }
  43 animscene_t;
  44
  45 typedef struct skinframe_s
  46 {
  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)
  57 }
  58 skinframe_t;
  59
  60 #define MAX_SKINS 256
  61
  62 typedef struct overridetagname_s
  63 {
  64         char name[MAX_QPATH];
  65 }
  66 overridetagname_t;
  67
  68 // a replacement set of tag names, per skin
  69 typedef struct overridetagnameset_s
  70 {
  71         int num_overridetagnames;
  72         overridetagname_t *data_overridetagnames;
  73 }
  74 overridetagnameset_t;
  75
  76 // LordHavoc: replaces glpoly, triangle mesh
  77 typedef struct surfmesh_s
  78 {
  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)
  92
  93         int num_collisionvertices;
  94         int num_collisiontriangles;
  95         float *data_collisionvertex3f;
  96         int *data_collisionelement3i;
  97 }
  98 surfmesh_t;
  99
 100 #define SHADOWMESHVERTEXHASH 1024
 101 typedef struct shadowmeshvertexhash_s
 102 {
 103         struct shadowmeshvertexhash_s *next;
 104 }
 105 shadowmeshvertexhash_t;
 106
 107 typedef struct shadowmesh_s
 108 {
 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;
 115         // buffer sizes
 116         int numverts, maxverts;
 117         int numtriangles, maxtriangles;
 118         // used always
 119         float *vertex3f;
 120         // used for light mesh (NULL on shadow mesh)
 121         float *svector3f;
 122         float *tvector3f;
 123         float *normal3f;
 124         float *texcoord2f;
 125         // used always
 126         int *element3i;
 127         // used for shadow mesh (NULL on light mesh)
 128         int *neighbor3i;
 129         // these are NULL after Mod_ShadowMesh_Finish is performed, only used
 130         // while building meshes
 131         shadowmeshvertexhash_t **vertexhashtable, *vertexhashentries;
 132 }
 133 shadowmesh_t;
 134
 135
 136 #include "matrixlib.h"
 137
 138 #include "model_brush.h"
 139 #include "model_sprite.h"
 140 #include "model_alias.h"
 141
 142 typedef struct model_alias_s
 143 {
 144         // mdl/md2/md3/zym model formats are treated the same after loading
 145
 146         // the shader meshes comprising this model
 147         int                             aliasnum_meshes;
 148         aliasmesh_t             *aliasdata_meshes;
 149
 150         // for md3 models
 151         int                             aliasnum_tags;
 152         int                             aliasnum_tagframes;
 153         aliastag_t              *aliasdata_tags;
 154
 155         // for skeletal models
 156         int                             aliasnum_bones;
 157         aliasbone_t             *aliasdata_bones;
 158         int                             aliasnum_poses;
 159         float                   *aliasdata_poses;
 160 }
 161 model_alias_t;
 162
 163 typedef struct model_sprite_s
 164 {
 165         int                             sprnum_type;
 166         mspriteframe_t  *sprdata_frames;
 167 }
 168 model_sprite_t;
 169
 170 struct trace_s;
 171
 172 typedef struct model_brush_s
 173 {
 174         // true if this model is a HalfLife .bsp file
 175         qboolean ishlbsp;
 176         // string of entity definitions (.map format)
 177         char *entities;
 178
 179         // if non-zero this is a submodel
 180         // (this is the number of the submodel, an index into submodels)
 181         int submodel;
 182
 183         // number of submodels in this map (just used by server to know how many
 184         // submodels to load)
 185         int numsubmodels;
 186         // pointers to each of the submodels if .isworldmodel is true
 187         struct model_s **submodels;
 188
 189         int num_planes;
 190         mplane_t *data_planes;
 191
 192         int num_nodes;
 193         mnode_t *data_nodes;
 194
 195         // visible leafs, not counting 0 (solid)
 196         int num_visleafs;
 197         // number of actual leafs (including 0 which is solid)
 198         int num_leafs;
 199         mleaf_t *data_leafs;
 200
 201         int num_leafbrushes;
 202         int *data_leafbrushes;
 203
 204         int num_leaffaces;
 205         int *data_leaffaces;
 206
 207         int num_portals;
 208         mportal_t *data_portals;
 209
 210         int num_portalpoints;
 211         mvertex_t *data_portalpoints;
 212
 213         int num_textures;
 214         texture_t *data_textures;
 215
 216         // pvs
 217         int num_pvsclusters;
 218         int num_pvsclusterbytes;
 219         unsigned char *data_pvsclusters;
 220         // example
 221         //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
 222         //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
 223
 224         // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
 225         shadowmesh_t *shadowmesh;
 226
 227         // common functions
 228         int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
 229         int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
 230         qbyte *(*GetPVS)(struct model_s *model, const vec3_t p);
 231         int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, qbyte *pvsbuffer, int pvsbufferlength);
 232         int (*BoxTouchingPVS)(struct model_s *model, const qbyte *pvs, const vec3_t mins, const vec3_t maxs);
 233         void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
 234         void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
 235         // these are actually only found on brushq1, but NULL is handled gracefully
 236         void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, qbyte *out, int outsize);
 237         void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
 238
 239         char skybox[64];
 240
 241         rtexture_t *solidskytexture;
 242         rtexture_t *alphaskytexture;
 243 }
 244 model_brush_t;
 245
 246 typedef struct model_brushq1_s
 247 {
 248         // lightmap format, set to r_lightmaprgba when model is loaded
 249         int                             lightmaprgba;
 250
 251         dmodel_t                *submodels;
 252
 253         int                             numvertexes;
 254         mvertex_t               *vertexes;
 255
 256         int                             numedges;
 257         medge_t                 *edges;
 258
 259         int                             numtexinfo;
 260         mtexinfo_t              *texinfo;
 261
 262         int                             numsurfaces;
 263         msurface_t              *surfaces;
 264         msurface_t              *surfacepvsnext;
 265
 266         int                             numsurfedges;
 267         int                             *surfedges;
 268
 269         int                             numclipnodes;
 270         dclipnode_t             *clipnodes;
 271
 272         hull_t                  hulls[MAX_MAP_HULLS];
 273
 274         int                             num_compressedpvs;
 275         qbyte                   *data_compressedpvs;
 276
 277         int                             num_lightdata;
 278         qbyte                   *lightdata;
 279
 280         int                             numlights;
 281         mlight_t                *lights;
 282
 283         // lightmap update chains for light styles
 284         int                             light_styles;
 285         qbyte                   *light_style;
 286         int                             *light_stylevalue;
 287         msurface_t              ***light_styleupdatechains;
 288         msurface_t              **light_styleupdatechainsbuffer;
 289
 290         mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
 291 }
 292 model_brushq1_t;
 293
 294 /* MSVC can't compile empty structs, so this is commented out for now
 295 typedef struct model_brushq2_s
 296 {
 297 }
 298 model_brushq2_t;
 299 */
 300
 301 typedef struct model_brushq3_s
 302 {
 303         int num_models;
 304         q3mmodel_t *data_models;
 305
 306         int num_brushes;
 307         q3mbrush_t *data_brushes;
 308
 309         int num_brushsides;
 310         q3mbrushside_t *data_brushsides;
 311
 312         // freed after loading!
 313         int num_vertices;
 314         float *data_vertex3f;
 315         float *data_texcoordtexture2f;
 316         float *data_texcoordlightmap2f;
 317         float *data_color4f;
 318
 319         // freed after loading!
 320         int num_triangles;
 321         int *data_element3i;
 322
 323         int num_effects;
 324         q3meffect_t *data_effects;
 325
 326         int num_faces;
 327         q3msurface_t *data_faces;
 328
 329         // lightmap textures
 330         int num_lightmaps;
 331         rtexture_t **data_lightmaps;
 332
 333         // voxel light data with directional shading
 334         int num_lightgrid;
 335         q3dlightgrid_t *data_lightgrid;
 336         // size of each cell (may vary by map, typically 64 64 128)
 337         float num_lightgrid_cellsize[3];
 338         // 1.0 / num_lightgrid_cellsize
 339         float num_lightgrid_scale[3];
 340         // dimensions of the world model in lightgrid cells
 341         int num_lightgrid_imins[3];
 342         int num_lightgrid_imaxs[3];
 343         int num_lightgrid_isize[3];
 344         // indexing/clamping
 345         int num_lightgrid_dimensions[3];
 346         // transform modelspace coordinates to lightgrid index
 347         matrix4x4_t num_lightgrid_indexfromworld;
 348 }
 349 model_brushq3_t;
 350
 351 typedef struct model_s
 352 {
 353         // name and path of model, for example "progs/player.mdl"
 354         char                    name[MAX_QPATH];
 355         // model needs to be loaded if this is false
 356         qboolean                loaded;
 357         // set if the model is used in current map, models which are not, are purged
 358         qboolean                used;
 359         // true if this is the world model (I.E. defines what sky to use, and may contain submodels)
 360         qboolean                isworldmodel;
 361         // CRC of the file this model was loaded from, to reload if changed
 362         unsigned int    crc;
 363         // mod_brush, mod_alias, mod_sprite
 364         modtype_t               type;
 365         // memory pool for allocations
 366         mempool_t               *mempool;
 367         // all models use textures...
 368         rtexturepool_t  *texturepool;
 369         // flags from the model file
 370         int                             flags;
 371         // engine calculated flags, ones that can not be set in the file
 372         int                             flags2;
 373         // number of QC accessible frame(group)s in the model
 374         int                             numframes;
 375         // number of QC accessible skin(group)s in the model
 376         int                             numskins;
 377         // whether to randomize animated framegroups
 378         synctype_t              synctype;
 379         // bounding box at angles '0 0 0'
 380         vec3_t                  normalmins, normalmaxs;
 381         // bounding box if yaw angle is not 0, but pitch and roll are
 382         vec3_t                  yawmins, yawmaxs;
 383         // bounding box if pitch or roll are used
 384         vec3_t                  rotatedmins, rotatedmaxs;
 385         // sphere radius, usable at any angles
 386         float                   radius;
 387         // squared sphere radius for easier comparisons
 388         float                   radius2;
 389         // skin animation info
 390         animscene_t             *skinscenes; // [numskins]
 391         // skin animation info
 392         animscene_t             *animscenes; // [numframes]
 393         // range of surface numbers in this (sub)model
 394         int                             firstmodelsurface;
 395         int                             nummodelsurfaces;
 396         // list of surface numbers in this (sub)model
 397         int                             *surfacelist;
 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
 401         int                             nummeshes;
 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);
 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
 416         model_alias_t   alias;
 417         model_sprite_t  sprite;
 418         model_brush_t   brush;
 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;
 422         */
 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)
 427         int soundfromcenter;
 428 }
 429 model_t;
 430
 431 //============================================================================
 432
 433 // this can be used for anything without a valid texture
 434 extern rtexture_t *r_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;
 439
 440 extern rtexture_t *mod_shared_distorttexture[64];
 441
 442 // model loading
 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;
 449
 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);
 456
 457 void Mod_ClearUsed(void);
 458 void Mod_PurgeUnused(void);
 459 void Mod_LoadModels(void);
 460
 461 extern model_t *loadmodel;
 462 extern char loadname[32];       // for hunk tags
 463
 464 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
 465 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
 466 void Mod_ValidateElements(const int *elements, int numtriangles, int numverts, const char *filename, int fileline);
 467 void Mod_BuildNormals(int numverts, int numtriangles, const float *vertex3f, const int *elements, float *normal3f);
 468 void Mod_BuildTextureVectorsAndNormals(int numverts, int numtriangles, const float *vertex, const float *texcoord, const int *elements, float *svectors, float *tvectors, float *normals);
 469
 470 surfmesh_t *Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, int numcollisionvertices, int numcollisiontriangles, qboolean detailtexcoords, qboolean lightmapoffsets, qboolean vertexcolors);
 471
 472 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);
 473 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
 474 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
 475 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
 476 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);
 477 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);
 478 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, int light, int neighbors);
 479 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
 480 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
 481
 482 int Mod_LoadSkinFrame(skinframe_t *skinframe, char *basename, int textureflags, int loadpantsandshirt, int usedetailtexture, int loadglowtexture);
 483 int Mod_LoadSkinFrame_Internal(skinframe_t *skinframe, char *basename, int textureflags, int loadpantsandshirt, int usedetailtexture, int loadglowtexture, qbyte *skindata, int width, int height);
 484
 485 // used for talking to the QuakeC mainly
 486 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
 487 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
 488
 489 extern cvar_t r_mipskins;
 490
 491 typedef struct skinfileitem_s
 492 {
 493         struct skinfileitem_s *next;
 494         char name[MAX_QPATH];
 495         char replacement[MAX_QPATH];
 496 }
 497 skinfileitem_t;
 498
 499 typedef struct skinfile_s
 500 {
 501         struct skinfile_s *next;
 502         skinfileitem_t *items;
 503 }
 504 skinfile_t;
 505
 506 skinfile_t *Mod_LoadSkinFiles(void);
 507 void Mod_FreeSkinFiles(skinfile_t *skinfile);
 508 int Mod_CountSkinFiles(skinfile_t *skinfile);
 509
 510 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
 511 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
 512
 513 #endif  // MODEL_SHARED_H
 514