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 synctype_e {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 modtype_e {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 *glow; // glow only (fullbrights)
  55         rtexture_t *fog; // alpha of the base texture (if not opaque)
  56         // accounting data for hash searches:
  57         // the compare variables are used to identify internal skins from certain
  58         // model formats
  59         // (so that two q1bsp maps with the same texture name for different
  60         //  textures do not have any conflicts)
  61         struct skinframe_s *next; // next on hash chain
  62         char basename[MAX_QPATH]; // name of this
  63         int textureflags; // texture flags to use
  64         int comparewidth;
  65         int compareheight;
  66         int comparecrc;
  67         // mark and sweep garbage collection, this value is updated to a new value
  68         // on each level change for the used skinframes, if some are not used they
  69         // are freed
  70         int loadsequence;
  71         // on 32bit systems this makes the struct 128 bytes long
  72         int padding;
  73 }
  74 skinframe_t;
  75
  76 #define MAX_SKINS 256
  77
  78 typedef struct overridetagname_s
  79 {
  80         char name[MAX_QPATH];
  81 }
  82 overridetagname_t;
  83
  84 // a replacement set of tag names, per skin
  85 typedef struct overridetagnameset_s
  86 {
  87         int num_overridetagnames;
  88         overridetagname_t *data_overridetagnames;
  89 }
  90 overridetagnameset_t;
  91
  92 struct md3vertex_s;
  93 struct trivertex_s;
  94
  95 // used for mesh lists in q1bsp/q3bsp map models
  96 // (the surfaces reference portions of these meshes)
  97 typedef struct surfmesh_s
  98 {
  99         // triangle data in system memory
 100         int num_triangles; // number of triangles in the mesh
 101         int *data_element3i; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
 102         int *data_neighbor3i; // int[tris*3] neighboring triangle on each edge (-1 if none)
 103         // element buffer object (stores triangles in video memory)
 104         int ebo;
 105         // vertex data in system memory
 106         int num_vertices; // number of vertices in the mesh
 107         float *data_vertex3f; // float[verts*3] vertex locations
 108         float *data_svector3f; // float[verts*3] direction of 'S' (right) texture axis for each vertex
 109         float *data_tvector3f; // float[verts*3] direction of 'T' (down) texture axis for each vertex
 110         float *data_normal3f; // float[verts*3] direction of 'R' (out) texture axis for each vertex
 111         float *data_texcoordtexture2f; // float[verts*2] texcoords for surface texture
 112         float *data_texcoordlightmap2f; // float[verts*2] texcoords for lightmap texture
 113         float *data_lightmapcolor4f;
 114         int *data_lightmapoffsets; // index into surface's lightmap samples for vertex lighting
 115         // vertex buffer object (stores geometry in video memory)
 116         int vbo;
 117         size_t vbooffset_vertex3f;
 118         size_t vbooffset_svector3f;
 119         size_t vbooffset_tvector3f;
 120         size_t vbooffset_normal3f;
 121         size_t vbooffset_texcoordtexture2f;
 122         size_t vbooffset_texcoordlightmap2f;
 123         size_t vbooffset_lightmapcolor4f;
 124         // morph blending, these are zero if model is skeletal or static
 125         int num_morphframes;
 126         struct md3vertex_s *data_morphmd3vertex;
 127         struct trivertx_s *data_morphmdlvertex;
 128         float *data_morphmd2framesize6f;
 129         float num_morphmdlframescale[3];
 130         float num_morphmdlframetranslate[3];
 131         // skeletal blending, these are NULL if model is morph or static
 132         int *data_vertexweightindex4i;
 133         float *data_vertexweightinfluence4f;
 134         // set if there is some kind of animation on this model
 135         qboolean isanimated;
 136 }
 137 surfmesh_t;
 138
 139 #define SHADOWMESHVERTEXHASH 1024
 140 typedef struct shadowmeshvertexhash_s
 141 {
 142         struct shadowmeshvertexhash_s *next;
 143 }
 144 shadowmeshvertexhash_t;
 145
 146 typedef struct shadowmesh_s
 147 {
 148         // next mesh in chain
 149         struct shadowmesh_s *next;
 150         // used for light mesh (NULL on shadow mesh)
 151         rtexture_t *map_diffuse;
 152         rtexture_t *map_specular;
 153         rtexture_t *map_normal;
 154         // buffer sizes
 155         int numverts, maxverts;
 156         int numtriangles, maxtriangles;
 157         // used always
 158         float *vertex3f;
 159         // used for light mesh (NULL on shadow mesh)
 160         float *svector3f;
 161         float *tvector3f;
 162         float *normal3f;
 163         float *texcoord2f;
 164         // used always
 165         int *element3i;
 166         // used for shadow mesh (NULL on light mesh)
 167         int *neighbor3i;
 168         // these are NULL after Mod_ShadowMesh_Finish is performed, only used
 169         // while building meshes
 170         shadowmeshvertexhash_t **vertexhashtable, *vertexhashentries;
 171         // element buffer object (stores triangles in video memory)
 172         // (created by Mod_ShadowMesh_Finish if possible)
 173         int ebo;
 174         // vertex buffer object (stores vertices in video memory)
 175         // (created by Mod_ShadowMesh_Finish if possible)
 176         int vbo;
 177         size_t vbooffset_vertex3f;
 178         size_t vbooffset_svector3f;
 179         size_t vbooffset_tvector3f;
 180         size_t vbooffset_normal3f;
 181         size_t vbooffset_texcoord2f;
 182 }
 183 shadowmesh_t;
 184
 185 // various flags from shaders, used for special effects not otherwise classified
 186 // TODO: support these features more directly
 187 #define Q3TEXTUREFLAG_TWOSIDED 1
 188 #define Q3TEXTUREFLAG_NOPICMIP 16
 189 #define Q3TEXTUREFLAG_POLYGONOFFSET 32
 190 #define Q3TEXTUREFLAG_REFRACTION 256
 191 #define Q3TEXTUREFLAG_REFLECTION 512
 192 #define Q3TEXTUREFLAG_WATERSHADER 1024
 193
 194 #define Q3PATHLENGTH 64
 195 #define TEXTURE_MAXFRAMES 64
 196 #define Q3WAVEPARMS 4
 197 #define Q3DEFORM_MAXPARMS 3
 198 #define Q3SHADER_MAXLAYERS 2 // FIXME support more than that (currently only two are used, so why keep more in RAM?)
 199 #define Q3RGBGEN_MAXPARMS 3
 200 #define Q3ALPHAGEN_MAXPARMS 1
 201 #define Q3TCGEN_MAXPARMS 6
 202 #define Q3TCMOD_MAXPARMS 6
 203 #define Q3MAXTCMODS 8
 204 #define Q3MAXDEFORMS 4
 205
 206 typedef enum q3wavefunc_e
 207 {
 208         Q3WAVEFUNC_NONE,
 209         Q3WAVEFUNC_INVERSESAWTOOTH,
 210         Q3WAVEFUNC_NOISE,
 211         Q3WAVEFUNC_SAWTOOTH,
 212         Q3WAVEFUNC_SIN,
 213         Q3WAVEFUNC_SQUARE,
 214         Q3WAVEFUNC_TRIANGLE,
 215         Q3WAVEFUNC_COUNT
 216 }
 217 q3wavefunc_t;
 218
 219 typedef enum q3deform_e
 220 {
 221         Q3DEFORM_NONE,
 222         Q3DEFORM_PROJECTIONSHADOW,
 223         Q3DEFORM_AUTOSPRITE,
 224         Q3DEFORM_AUTOSPRITE2,
 225         Q3DEFORM_TEXT0,
 226         Q3DEFORM_TEXT1,
 227         Q3DEFORM_TEXT2,
 228         Q3DEFORM_TEXT3,
 229         Q3DEFORM_TEXT4,
 230         Q3DEFORM_TEXT5,
 231         Q3DEFORM_TEXT6,
 232         Q3DEFORM_TEXT7,
 233         Q3DEFORM_BULGE,
 234         Q3DEFORM_WAVE,
 235         Q3DEFORM_NORMAL,
 236         Q3DEFORM_MOVE,
 237         Q3DEFORM_COUNT
 238 }
 239 q3deform_t;
 240
 241 typedef enum q3rgbgen_e
 242 {
 243         Q3RGBGEN_IDENTITY,
 244         Q3RGBGEN_CONST,
 245         Q3RGBGEN_ENTITY,
 246         Q3RGBGEN_EXACTVERTEX,
 247         Q3RGBGEN_IDENTITYLIGHTING,
 248         Q3RGBGEN_LIGHTINGDIFFUSE,
 249         Q3RGBGEN_ONEMINUSENTITY,
 250         Q3RGBGEN_ONEMINUSVERTEX,
 251         Q3RGBGEN_VERTEX,
 252         Q3RGBGEN_WAVE,
 253         Q3RGBGEN_COUNT
 254 }
 255 q3rgbgen_t;
 256
 257 typedef enum q3alphagen_e
 258 {
 259         Q3ALPHAGEN_IDENTITY,
 260         Q3ALPHAGEN_CONST,
 261         Q3ALPHAGEN_ENTITY,
 262         Q3ALPHAGEN_LIGHTINGSPECULAR,
 263         Q3ALPHAGEN_ONEMINUSENTITY,
 264         Q3ALPHAGEN_ONEMINUSVERTEX,
 265         Q3ALPHAGEN_PORTAL,
 266         Q3ALPHAGEN_VERTEX,
 267         Q3ALPHAGEN_WAVE,
 268         Q3ALPHAGEN_COUNT
 269 }
 270 q3alphagen_t;
 271
 272 typedef enum q3tcgen_e
 273 {
 274         Q3TCGEN_NONE,
 275         Q3TCGEN_TEXTURE, // very common
 276         Q3TCGEN_ENVIRONMENT, // common
 277         Q3TCGEN_LIGHTMAP,
 278         Q3TCGEN_VECTOR,
 279         Q3TCGEN_COUNT
 280 }
 281 q3tcgen_t;
 282
 283 typedef enum q3tcmod_e
 284 {
 285         Q3TCMOD_NONE,
 286         Q3TCMOD_ENTITYTRANSLATE,
 287         Q3TCMOD_ROTATE,
 288         Q3TCMOD_SCALE,
 289         Q3TCMOD_SCROLL,
 290         Q3TCMOD_STRETCH,
 291         Q3TCMOD_TRANSFORM,
 292         Q3TCMOD_TURBULENT,
 293         Q3TCMOD_COUNT
 294 }
 295 q3tcmod_t;
 296
 297 typedef struct q3shaderinfo_layer_rgbgen_s
 298 {
 299         q3rgbgen_t rgbgen;
 300         float parms[Q3RGBGEN_MAXPARMS];
 301         q3wavefunc_t wavefunc;
 302         float waveparms[Q3WAVEPARMS];
 303 }
 304 q3shaderinfo_layer_rgbgen_t;
 305
 306 typedef struct q3shaderinfo_layer_alphagen_s
 307 {
 308         q3alphagen_t alphagen;
 309         float parms[Q3ALPHAGEN_MAXPARMS];
 310         q3wavefunc_t wavefunc;
 311         float waveparms[Q3WAVEPARMS];
 312 }
 313 q3shaderinfo_layer_alphagen_t;
 314
 315 typedef struct q3shaderinfo_layer_tcgen_s
 316 {
 317         q3tcgen_t tcgen;
 318         float parms[Q3TCGEN_MAXPARMS];
 319 }
 320 q3shaderinfo_layer_tcgen_t;
 321
 322 typedef struct q3shaderinfo_layer_tcmod_s
 323 {
 324         q3tcmod_t tcmod;
 325         float parms[Q3TCMOD_MAXPARMS];
 326         q3wavefunc_t wavefunc;
 327         float waveparms[Q3WAVEPARMS];
 328 }
 329 q3shaderinfo_layer_tcmod_t;
 330
 331 typedef struct q3shaderinfo_layer_s
 332 {
 333         int alphatest;
 334         int clampmap;
 335         float framerate;
 336         int numframes;
 337         char texturename[TEXTURE_MAXFRAMES][Q3PATHLENGTH];
 338         int blendfunc[2];
 339         q3shaderinfo_layer_rgbgen_t rgbgen;
 340         q3shaderinfo_layer_alphagen_t alphagen;
 341         q3shaderinfo_layer_tcgen_t tcgen;
 342         q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
 343 }
 344 q3shaderinfo_layer_t;
 345
 346 typedef struct q3shaderinfo_deform_s
 347 {
 348         q3deform_t deform;
 349         float parms[Q3DEFORM_MAXPARMS];
 350         q3wavefunc_t wavefunc;
 351         float waveparms[Q3WAVEPARMS];
 352 }
 353 q3shaderinfo_deform_t;
 354
 355 typedef struct q3shaderinfo_s
 356 {
 357         char name[Q3PATHLENGTH];
 358         int surfaceparms;
 359         int textureflags;
 360         int numlayers;
 361         qboolean lighting;
 362         qboolean vertexalpha;
 363         qboolean textureblendalpha;
 364         q3shaderinfo_layer_t *primarylayer, *backgroundlayer;
 365         q3shaderinfo_layer_t layers[Q3SHADER_MAXLAYERS];
 366         char skyboxname[Q3PATHLENGTH];
 367         q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
 368
 369         float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
 370         float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
 371         float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
 372         vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
 373         float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
 374         vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
 375 }
 376 q3shaderinfo_t;
 377
 378 typedef enum texturelayertype_e
 379 {
 380         TEXTURELAYERTYPE_INVALID,
 381         TEXTURELAYERTYPE_LITTEXTURE,
 382         TEXTURELAYERTYPE_TEXTURE,
 383         TEXTURELAYERTYPE_FOG,
 384 }
 385 texturelayertype_t;
 386
 387 typedef enum texturelayerflag_e
 388 {
 389         // indicates that the pass should apply fog darkening; used on
 390         // transparent surfaces where simply blending an alpha fog as a final
 391         // pass would not behave properly, so all the surfaces must be darkened,
 392         // and the fog color added as a separate pass
 393         TEXTURELAYERFLAG_FOGDARKEN = 1,
 394 }
 395 texturelayerflag_t;
 396
 397 typedef struct texturelayer_s
 398 {
 399         texturelayertype_t type;
 400         qboolean depthmask;
 401         int blendfunc1;
 402         int blendfunc2;
 403         rtexture_t *texture;
 404         matrix4x4_t texmatrix;
 405         vec4_t color;
 406         int flags;
 407 }
 408 texturelayer_t;
 409
 410 typedef struct texture_s
 411 {
 412         // q1bsp
 413         // name
 414         //char name[16];
 415         // size
 416         unsigned int width, height;
 417         // SURF_ flags
 418         //unsigned int flags;
 419
 420         // base material flags
 421         int basematerialflags;
 422         // current material flags (updated each bmodel render)
 423         int currentmaterialflags;
 424
 425         // current PolygonOffset values for rendering this material
 426         float currentpolygonfactor;
 427         float currentpolygonoffset;
 428         float basepolygonfactor;
 429         float basepolygonoffset;
 430
 431         // textures to use when rendering this material
 432         skinframe_t *currentskinframe;
 433         int numskinframes;
 434         float skinframerate;
 435         skinframe_t *skinframes[TEXTURE_MAXFRAMES];
 436         // background layer (for terrain texture blending)
 437         skinframe_t *backgroundcurrentskinframe;
 438         int backgroundnumskinframes;
 439         float backgroundskinframerate;
 440         skinframe_t *backgroundskinframes[TEXTURE_MAXFRAMES];
 441
 442         // total frames in sequence and alternate sequence
 443         int anim_total[2];
 444         // direct pointers to each of the frames in the sequences
 445         // (indexed as [alternate][frame])
 446         struct texture_s *anim_frames[2][10];
 447         // set if animated or there is an alternate frame set
 448         // (this is an optimization in the renderer)
 449         int animated;
 450
 451         // the current alpha of this texture (may be affected by r_wateralpha)
 452         float currentalpha;
 453         // the current texture frame in animation
 454         struct texture_s *currentframe;
 455         // current texture transform matrix (used for water scrolling)
 456         matrix4x4_t currenttexmatrix;
 457
 458         // various q3 shader features
 459         q3shaderinfo_layer_rgbgen_t rgbgen;
 460         q3shaderinfo_layer_alphagen_t alphagen;
 461         q3shaderinfo_layer_tcgen_t tcgen;
 462         q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
 463         q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
 464
 465         qboolean colormapping;
 466         rtexture_t *basetexture;
 467         rtexture_t *glosstexture;
 468         rtexture_t *backgroundbasetexture;
 469         rtexture_t *backgroundglosstexture;
 470         float specularscale;
 471         float specularpower;
 472         // color tint (colormod * currentalpha) used for rtlighting this material
 473         float dlightcolor[3];
 474
 475         // from q3 shaders
 476         int customblendfunc[2];
 477
 478         int currentnumlayers;
 479         texturelayer_t currentlayers[16];
 480
 481         // q3bsp
 482         char name[64];
 483         int surfaceflags;
 484         int supercontents;
 485         int surfaceparms;
 486         int textureflags;
 487
 488         // reflection
 489         float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
 490         float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
 491         float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
 492         vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
 493         float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
 494         vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
 495 }
 496 texture_t;
 497
 498 typedef struct mtexinfo_s
 499 {
 500         float vecs[2][4];
 501         texture_t *texture;
 502         int flags;
 503 }
 504 mtexinfo_t;
 505
 506 typedef struct msurface_lightmapinfo_s
 507 {
 508         // texture mapping properties used by this surface
 509         mtexinfo_t *texinfo; // q1bsp
 510         // index into r_refdef.lightstylevalue array, 255 means not used (black)
 511         unsigned char styles[MAXLIGHTMAPS]; // q1bsp
 512         // RGB lighting data [numstyles][height][width][3]
 513         unsigned char *samples; // q1bsp
 514         // RGB normalmap data [numstyles][height][width][3]
 515         unsigned char *nmapsamples; // q1bsp
 516         // stain to apply on lightmap (soot/dirt/blood/whatever)
 517         unsigned char *stainsamples; // q1bsp
 518         int texturemins[2]; // q1bsp
 519         int extents[2]; // q1bsp
 520         int lightmaporigin[2]; // q1bsp
 521 }
 522 msurface_lightmapinfo_t;
 523
 524 struct q3deffect_s;
 525 typedef struct msurface_s
 526 {
 527         // bounding box for onscreen checks
 528         vec3_t mins;
 529         vec3_t maxs;
 530         // the texture to use on the surface
 531         texture_t *texture;
 532         // the lightmap texture fragment to use on the rendering mesh
 533         rtexture_t *lightmaptexture;
 534         // the lighting direction texture fragment to use on the rendering mesh
 535         rtexture_t *deluxemaptexture;
 536
 537         // surfaces own ranges of vertices and triangles in the model->surfmesh
 538         int num_triangles; // number of triangles
 539         int num_firsttriangle; // first triangle
 540         int num_vertices; // number of vertices
 541         int num_firstvertex; // first vertex
 542
 543         // shadow volume building information
 544         int num_firstshadowmeshtriangle; // index into model->brush.shadowmesh
 545
 546         // lightmaptexture rebuild information not used in q3bsp
 547         int cached_dlight; // q1bsp // forces rebuild of lightmaptexture
 548         msurface_lightmapinfo_t *lightmapinfo; // q1bsp
 549
 550         // mesh information for collisions (only used by q3bsp curves)
 551         int num_collisiontriangles; // q3bsp
 552         int *data_collisionelement3i; // q3bsp
 553         int num_collisionvertices; // q3bsp
 554         float *data_collisionvertex3f; // q3bsp
 555         struct q3deffect_s *effect; // q3bsp
 556         // FIXME: collisionmarkframe should be kept in a separate array
 557         int collisionmarkframe; // q3bsp // don't collide twice in one trace
 558 }
 559 msurface_t;
 560
 561 #include "matrixlib.h"
 562
 563 #include "model_brush.h"
 564 #include "model_sprite.h"
 565 #include "model_alias.h"
 566
 567 typedef struct model_sprite_s
 568 {
 569         int                             sprnum_type;
 570         mspriteframe_t  *sprdata_frames;
 571 }
 572 model_sprite_t;
 573
 574 struct trace_s;
 575
 576 typedef struct model_brush_s
 577 {
 578         // true if this model is a HalfLife .bsp file
 579         qboolean ishlbsp;
 580         // true if this model is a Martial Concert .bsp file
 581         qboolean ismcbsp;
 582         // string of entity definitions (.map format)
 583         char *entities;
 584
 585         // if non-zero this is a submodel
 586         // (this is the number of the submodel, an index into submodels)
 587         int submodel;
 588
 589         // number of submodels in this map (just used by server to know how many
 590         // submodels to load)
 591         int numsubmodels;
 592         // pointers to each of the submodels if .isworldmodel is true
 593         struct model_s **submodels;
 594
 595         int num_planes;
 596         mplane_t *data_planes;
 597
 598         int num_nodes;
 599         mnode_t *data_nodes;
 600
 601         // visible leafs, not counting 0 (solid)
 602         int num_visleafs;
 603         // number of actual leafs (including 0 which is solid)
 604         int num_leafs;
 605         mleaf_t *data_leafs;
 606
 607         int num_leafbrushes;
 608         int *data_leafbrushes;
 609
 610         int num_leafsurfaces;
 611         int *data_leafsurfaces;
 612
 613         int num_portals;
 614         mportal_t *data_portals;
 615
 616         int num_portalpoints;
 617         mvertex_t *data_portalpoints;
 618
 619         int num_brushes;
 620         q3mbrush_t *data_brushes;
 621
 622         int num_brushsides;
 623         q3mbrushside_t *data_brushsides;
 624
 625         // pvs
 626         int num_pvsclusters;
 627         int num_pvsclusterbytes;
 628         unsigned char *data_pvsclusters;
 629         // example
 630         //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
 631         //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
 632
 633         // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
 634         shadowmesh_t *shadowmesh;
 635
 636         // common functions
 637         int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
 638         int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
 639         unsigned char *(*GetPVS)(struct model_s *model, const vec3_t p);
 640         int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, unsigned char *pvsbuffer, int pvsbufferlength, qboolean merge);
 641         int (*BoxTouchingPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
 642         int (*BoxTouchingLeafPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
 643         int (*BoxTouchingVisibleLeafs)(struct model_s *model, const unsigned char *visibleleafs, const vec3_t mins, const vec3_t maxs);
 644         int (*FindBoxClusters)(struct model_s *model, const vec3_t mins, const vec3_t maxs, int maxclusters, int *clusterlist);
 645         void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
 646         void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
 647         mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
 648         // these are actually only found on brushq1, but NULL is handled gracefully
 649         void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, unsigned char *out, int outsize);
 650         void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
 651         // trace a line of sight through this model (returns false if the line if sight is definitely blocked)
 652         qboolean (*TraceLineOfSight)(struct model_s *model, const vec3_t start, const vec3_t end);
 653
 654         char skybox[MAX_QPATH];
 655
 656         rtexture_t *solidskytexture;
 657         rtexture_t *alphaskytexture;
 658
 659         qboolean supportwateralpha;
 660
 661         // QuakeWorld
 662         int qw_md4sum;
 663         int qw_md4sum2;
 664 }
 665 model_brush_t;
 666
 667 typedef struct model_brushq1_s
 668 {
 669         dmodel_t                *submodels;
 670
 671         int                             numvertexes;
 672         mvertex_t               *vertexes;
 673
 674         int                             numedges;
 675         medge_t                 *edges;
 676
 677         int                             numtexinfo;
 678         mtexinfo_t              *texinfo;
 679
 680         int                             numsurfedges;
 681         int                             *surfedges;
 682
 683         int                             numclipnodes;
 684         mclipnode_t             *clipnodes;
 685
 686         int                             numhulls;       // this variable is only used by MCBSP, other formats know it intuitively
 687         hull_t                  hulls[MAX_MAP_HULLS];
 688
 689         int                             num_compressedpvs;
 690         unsigned char                   *data_compressedpvs;
 691
 692         int                             num_lightdata;
 693         unsigned char                   *lightdata;
 694         unsigned char                   *nmaplightdata; // deluxemap file
 695
 696         // lightmap update chains for light styles
 697         int                             light_styles;
 698         unsigned char                   *light_style;
 699         int                             *light_stylevalue;
 700         msurface_t              ***light_styleupdatechains;
 701         msurface_t              **light_styleupdatechainsbuffer;
 702 }
 703 model_brushq1_t;
 704
 705 /* MSVC can't compile empty structs, so this is commented out for now
 706 typedef struct model_brushq2_s
 707 {
 708 }
 709 model_brushq2_t;
 710 */
 711
 712 typedef struct model_brushq3_s
 713 {
 714         int num_models;
 715         q3dmodel_t *data_models;
 716
 717         // used only during loading - freed after loading!
 718         int num_vertices;
 719         float *data_vertex3f;
 720         float *data_normal3f;
 721         float *data_texcoordtexture2f;
 722         float *data_texcoordlightmap2f;
 723         float *data_color4f;
 724
 725         // freed after loading!
 726         int num_triangles;
 727         int *data_element3i;
 728
 729         int num_effects;
 730         q3deffect_t *data_effects;
 731
 732         // lightmap textures
 733         int num_originallightmaps;
 734         int num_mergedlightmaps;
 735         int num_lightmapmergepower;
 736         int num_lightmapmerge;
 737         rtexture_t **data_lightmaps;
 738         rtexture_t **data_deluxemaps;
 739
 740         // voxel light data with directional shading
 741         int num_lightgrid;
 742         q3dlightgrid_t *data_lightgrid;
 743         // size of each cell (may vary by map, typically 64 64 128)
 744         float num_lightgrid_cellsize[3];
 745         // 1.0 / num_lightgrid_cellsize
 746         float num_lightgrid_scale[3];
 747         // dimensions of the world model in lightgrid cells
 748         int num_lightgrid_imins[3];
 749         int num_lightgrid_imaxs[3];
 750         int num_lightgrid_isize[3];
 751         // indexing/clamping
 752         int num_lightgrid_dimensions[3];
 753         // transform modelspace coordinates to lightgrid index
 754         matrix4x4_t num_lightgrid_indexfromworld;
 755
 756         // true if this q3bsp file has been detected as using deluxemapping
 757         // (lightmap texture pairs, every odd one is never directly refernced,
 758         //  and contains lighting normals, not colors)
 759         qboolean deluxemapping;
 760         // true if the detected deluxemaps are the modelspace kind, rather than
 761         // the faster tangentspace kind
 762         qboolean deluxemapping_modelspace;
 763 }
 764 model_brushq3_t;
 765
 766 typedef struct model_s
 767 {
 768         // name and path of model, for example "progs/player.mdl"
 769         char                    name[MAX_QPATH];
 770         // model needs to be loaded if this is false
 771         qboolean                loaded;
 772         // set if the model is used in current map, models which are not, are purged
 773         qboolean                used;
 774         // true if this is the world model (I.E. defines what sky to use, and may contain submodels)
 775         qboolean                isworldmodel;
 776         // CRC of the file this model was loaded from, to reload if changed
 777         unsigned int    crc;
 778         // mod_brush, mod_alias, mod_sprite
 779         modtype_t               type;
 780         // memory pool for allocations
 781         mempool_t               *mempool;
 782         // all models use textures...
 783         rtexturepool_t  *texturepool;
 784         // EF_* flags (translated from the model file's different flags layout)
 785         int                             effects;
 786         // number of QC accessible frame(group)s in the model
 787         int                             numframes;
 788         // number of QC accessible skin(group)s in the model
 789         int                             numskins;
 790         // whether to randomize animated framegroups
 791         synctype_t              synctype;
 792         // bounding box at angles '0 0 0'
 793         vec3_t                  normalmins, normalmaxs;
 794         // bounding box if yaw angle is not 0, but pitch and roll are
 795         vec3_t                  yawmins, yawmaxs;
 796         // bounding box if pitch or roll are used
 797         vec3_t                  rotatedmins, rotatedmaxs;
 798         // sphere radius, usable at any angles
 799         float                   radius;
 800         // squared sphere radius for easier comparisons
 801         float                   radius2;
 802         // skin animation info
 803         animscene_t             *skinscenes; // [numskins]
 804         // skin animation info
 805         animscene_t             *animscenes; // [numframes]
 806         // range of surface numbers in this (sub)model
 807         int                             firstmodelsurface;
 808         int                             nummodelsurfaces;
 809         // range of collision brush numbers in this (sub)model
 810         int                             firstmodelbrush;
 811         int                             nummodelbrushes;
 812         // list of surface numbers in this (sub)model
 813         int                             *surfacelist;
 814         // for md3 models
 815         int                             num_tags;
 816         int                             num_tagframes;
 817         aliastag_t              *data_tags;
 818         // for skeletal models
 819         int                             num_bones;
 820         aliasbone_t             *data_bones;
 821         int                             num_poses;
 822         float                   *data_poses;
 823         float                   *data_baseboneposeinverse;
 824         // textures of this model
 825         int                             num_textures;
 826         int                             num_texturesperskin;
 827         texture_t               *data_textures;
 828         // surfaces of this model
 829         int                             num_surfaces;
 830         msurface_t              *data_surfaces;
 831         // optional lightmapinfo data for surface lightmap updates
 832         msurface_lightmapinfo_t *data_surfaces_lightmapinfo;
 833         // all surfaces belong to this mesh
 834         surfmesh_t              surfmesh;
 835         // data type of model
 836         const char              *modeldatatypestring;
 837         // draw the model's sky polygons (only used by brush models)
 838         void(*DrawSky)(struct entity_render_s *ent);
 839         // draw refraction/reflection textures for the model's water polygons (only used by brush models)
 840         void(*DrawAddWaterPlanes)(struct entity_render_s *ent);
 841         // draw the model using lightmap/dlight shading
 842         void(*Draw)(struct entity_render_s *ent);
 843         // draw the model to the depth buffer (no color rendering at all)
 844         void(*DrawDepth)(struct entity_render_s *ent);
 845         // draw any enabled debugging effects on this model (such as showing triangles, normals, collision brushes...)
 846         void(*DrawDebug)(struct entity_render_s *ent);
 847         // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
 848         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, unsigned char *outshadowtrispvs, unsigned char *outlighttrispvs);
 849         // compile a shadow volume for the model based on light source
 850         void(*CompileShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
 851         // draw a shadow volume for the model based on light source
 852         void(*DrawShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist, const vec3_t lightmins, const vec3_t lightmaxs);
 853         // draw the lighting on a model (through stencil)
 854         void(*DrawLight)(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
 855         // trace a box against this model
 856         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);
 857         // fields belonging to some types of model
 858         model_sprite_t  sprite;
 859         model_brush_t   brush;
 860         model_brushq1_t brushq1;
 861         /* MSVC can't handle an empty struct, so this is commented out for now
 862         model_brushq2_t brushq2;
 863         */
 864         model_brushq3_t brushq3;
 865         // skin files can have different tags for each skin
 866         overridetagnameset_t    *data_overridetagnamesforskin;
 867         // flags this model for offseting sounds to the model center (used by brush models)
 868         int soundfromcenter;
 869 }
 870 model_t;
 871
 872 //============================================================================
 873
 874 // model loading
 875 extern model_t *loadmodel;
 876 extern unsigned char *mod_base;
 877 // sky/water subdivision
 878 //extern cvar_t gl_subdivide_size;
 879 // texture fullbrights
 880 extern cvar_t r_fullbrights;
 881
 882 void Mod_Init (void);
 883 void Mod_Reload (void);
 884 model_t *Mod_LoadModel(model_t *mod, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
 885 model_t *Mod_FindName (const char *name);
 886 model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
 887 void Mod_UnloadModel (model_t *mod);
 888
 889 void Mod_ClearUsed(void);
 890 void Mod_PurgeUnused(void);
 891 void Mod_RemoveStaleWorldModels(model_t *skip); // only used during loading!
 892
 893 extern model_t *loadmodel;
 894 extern char loadname[32];       // for hunk tags
 895
 896 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
 897 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
 898 void Mod_ValidateElements(int *elements, int numtriangles, int firstvertex, int numverts, const char *filename, int fileline);
 899 void Mod_BuildNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const int *elements, float *normal3f, qboolean areaweighting);
 900 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);
 901
 902 void Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, qboolean lightmapoffsets, qboolean vertexcolors, qboolean neighbors);
 903
 904 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);
 905 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
 906 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
 907 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
 908 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);
 909 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);
 910 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, qboolean light, qboolean neighbors, qboolean createvbo);
 911 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
 912 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
 913
 914 void Mod_LoadQ3Shaders(void);
 915 q3shaderinfo_t *Mod_LookupQ3Shader(const char *name);
 916 qboolean Mod_LoadTextureFromQ3Shader(texture_t *texture, const char *name, qboolean q1bsp, qboolean q3bsp, qboolean md3);
 917
 918 extern cvar_t r_mipskins;
 919
 920 typedef struct skinfileitem_s
 921 {
 922         struct skinfileitem_s *next;
 923         char name[MAX_QPATH];
 924         char replacement[MAX_QPATH];
 925 }
 926 skinfileitem_t;
 927
 928 typedef struct skinfile_s
 929 {
 930         struct skinfile_s *next;
 931         skinfileitem_t *items;
 932 }
 933 skinfile_t;
 934
 935 skinfile_t *Mod_LoadSkinFiles(void);
 936 void Mod_FreeSkinFiles(skinfile_t *skinfile);
 937 int Mod_CountSkinFiles(skinfile_t *skinfile);
 938
 939 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
 940 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
 941 void Mod_VertexRangeFromElements(int numelements, const int *elements, int *firstvertexpointer, int *lastvertexpointer);
 942
 943 // bsp models
 944 void Mod_BrushInit(void);
 945 // used for talking to the QuakeC mainly
 946 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
 947 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
 948
 949 // a lot of model formats use the Q1BSP code, so here are the prototypes...
 950 struct entity_render_s;
 951 void R_Q1BSP_DrawAddWaterPlanes(struct entity_render_s *ent);
 952 void R_Q1BSP_DrawSky(struct entity_render_s *ent);
 953 void R_Q1BSP_Draw(struct entity_render_s *ent);
 954 void R_Q1BSP_DrawDepth(struct entity_render_s *ent);
 955 void R_Q1BSP_DrawDebug(struct entity_render_s *ent);
 956 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, unsigned char *outshadowtrispvs, unsigned char *outlighttrispvs);
 957 void R_Q1BSP_CompileShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
 958 void R_Q1BSP_DrawShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist, const vec3_t lightmins, const vec3_t lightmaxs);
 959 void R_Q1BSP_DrawLight(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
 960
 961 // alias models
 962 struct frameblend_s;
 963 void Mod_AliasInit(void);
 964 void Mod_Alias_GetMesh_Vertices(const model_t *model, const struct frameblend_s *frameblend, float *vertex3f, float *normal3f, float *svector3f, float *tvector3f);
 965 int Mod_Alias_GetTagMatrix(const model_t *model, int poseframe, int tagindex, matrix4x4_t *outmatrix);
 966 int Mod_Alias_GetTagIndexForName(const model_t *model, unsigned int skin, const char *tagname);
 967
 968 // sprite models
 969 void Mod_SpriteInit(void);
 970
 971 // loaders
 972 void Mod_Q1BSP_Load(model_t *mod, void *buffer, void *bufferend);
 973 void Mod_IBSP_Load(model_t *mod, void *buffer, void *bufferend);
 974 void Mod_MAP_Load(model_t *mod, void *buffer, void *bufferend);
 975 void Mod_IDP0_Load(model_t *mod, void *buffer, void *bufferend);
 976 void Mod_IDP2_Load(model_t *mod, void *buffer, void *bufferend);
 977 void Mod_IDP3_Load(model_t *mod, void *buffer, void *bufferend);
 978 void Mod_ZYMOTICMODEL_Load(model_t *mod, void *buffer, void *bufferend);
 979 void Mod_DARKPLACESMODEL_Load(model_t *mod, void *buffer, void *bufferend);
 980 void Mod_PSKMODEL_Load(model_t *mod, void *buffer, void *bufferend);
 981 void Mod_IDSP_Load(model_t *mod, void *buffer, void *bufferend);
 982 void Mod_IDS2_Load(model_t *mod, void *buffer, void *bufferend);
 983
 984 // utility
 985 qboolean Mod_CanSeeBox_Trace(int numsamples, float t, model_t *model, vec3_t eye, vec3_t minsX, vec3_t maxsX);
 986
 987 #endif  // MODEL_SHARED_H
 988