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