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