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