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