2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
21 #ifndef MODEL_SHARED_H
22 #define MODEL_SHARED_H
24 typedef enum synctype_e {ST_SYNC=0, ST_RAND } synctype_t;
28 d*_t structures are on-disk representations
29 m*_t structures are in-memory
33 typedef enum modtype_e {mod_invalid, mod_brushq1, mod_sprite, mod_alias, mod_brushq2, mod_brushq3, mod_obj, mod_null} modtype_t;
35 typedef struct animscene_s
37 char name[32]; // for viewthing support
40 int loop; // true or false
45 typedef struct skinframe_s
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 rtexture_t *reflect; // colored mask for cubemap reflections
57 // accounting data for hash searches:
58 // the compare variables are used to identify internal skins from certain
60 // (so that two q1bsp maps with the same texture name for different
61 // textures do not have any conflicts)
62 struct skinframe_s *next; // next on hash chain
63 char basename[MAX_QPATH]; // name of this
64 int textureflags; // texture flags to use
68 // mark and sweep garbage collection, this value is updated to a new value
69 // on each level change for the used skinframes, if some are not used they
72 // indicates whether this texture has transparent pixels
74 // average texture color, if applicable
76 // for mdl skins, we actually only upload on first use (many are never used, and they are almost never used in both base+pants+shirt and merged modes)
77 unsigned char *qpixels;
80 qboolean qhascolormapping;
81 qboolean qgeneratebase;
82 qboolean qgeneratemerged;
83 qboolean qgeneratenmap;
84 qboolean qgenerateglow;
90 typedef struct texvecvertex_s
97 typedef struct blendweights_s
99 unsigned char index[4];
100 unsigned char influence[4];
104 typedef struct r_vertexgeneric_s
113 typedef struct r_vertexmesh_s
118 float texcoordtexture2f[2];
119 float texcoordlightmap2f[2];
126 typedef struct r_meshbuffer_s
128 int bufferobject; // OpenGL
129 void *devicebuffer; // Direct3D
131 qboolean isindexbuffer;
134 char name[MAX_QPATH];
138 // used for mesh lists in q1bsp/q3bsp map models
139 // (the surfaces reference portions of these meshes)
140 typedef struct surfmesh_s
142 // triangle data in system memory
143 int num_triangles; // number of triangles in the mesh
144 int *data_element3i; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
145 r_meshbuffer_t *data_element3i_indexbuffer;
146 size_t data_element3i_bufferoffset;
147 unsigned short *data_element3s; // unsigned short[tris*3] triangles of the mesh in unsigned short format (NULL if num_vertices > 65536)
148 r_meshbuffer_t *data_element3s_indexbuffer;
149 size_t data_element3s_bufferoffset;
150 int *data_neighbor3i; // int[tris*3] neighboring triangle on each edge (-1 if none)
151 // vertex data in system memory
152 int num_vertices; // number of vertices in the mesh
153 float *data_vertex3f; // float[verts*3] vertex locations
154 float *data_svector3f; // float[verts*3] direction of 'S' (right) texture axis for each vertex
155 float *data_tvector3f; // float[verts*3] direction of 'T' (down) texture axis for each vertex
156 float *data_normal3f; // float[verts*3] direction of 'R' (out) texture axis for each vertex
157 float *data_texcoordtexture2f; // float[verts*2] texcoords for surface texture
158 float *data_texcoordlightmap2f; // float[verts*2] texcoords for lightmap texture
159 float *data_lightmapcolor4f;
160 int *data_lightmapoffsets; // index into surface's lightmap samples for vertex lighting
161 // vertex buffer object (stores geometry in video memory)
162 r_meshbuffer_t *vbo_vertexbuffer;
163 size_t vbooffset_vertex3f;
164 size_t vbooffset_svector3f;
165 size_t vbooffset_tvector3f;
166 size_t vbooffset_normal3f;
167 size_t vbooffset_texcoordtexture2f;
168 size_t vbooffset_texcoordlightmap2f;
169 size_t vbooffset_lightmapcolor4f;
170 // morph blending, these are zero if model is skeletal or static
172 struct md3vertex_s *data_morphmd3vertex;
173 struct trivertx_s *data_morphmdlvertex;
174 struct texvecvertex_s *data_morphtexvecvertex;
175 float *data_morphmd2framesize6f;
176 float num_morphmdlframescale[3];
177 float num_morphmdlframetranslate[3];
178 // skeletal blending, these are NULL if model is morph or static
179 struct blendweights_s *data_blendweights;
181 unsigned short *blends;
182 // set if there is some kind of animation on this model
185 // vertex and index buffers for rendering
186 r_vertexmesh_t *vertexmesh;
187 r_meshbuffer_t *vertex3fbuffer;
188 r_meshbuffer_t *vertexmeshbuffer;
192 #define SHADOWMESHVERTEXHASH 1024
193 typedef struct shadowmeshvertexhash_s
195 struct shadowmeshvertexhash_s *next;
197 shadowmeshvertexhash_t;
199 typedef struct shadowmesh_s
201 // next mesh in chain
202 struct shadowmesh_s *next;
203 // used for light mesh (NULL on shadow mesh)
204 rtexture_t *map_diffuse;
205 rtexture_t *map_specular;
206 rtexture_t *map_normal;
208 int numverts, maxverts;
209 int numtriangles, maxtriangles;
212 // used for light mesh (NULL on shadow mesh)
219 r_meshbuffer_t *element3i_indexbuffer;
220 size_t element3i_bufferoffset;
221 unsigned short *element3s;
222 r_meshbuffer_t *element3s_indexbuffer;
223 size_t element3s_bufferoffset;
224 // used for shadow mapping cubemap side partitioning
225 int sideoffsets[6], sidetotals[6];
226 // used for shadow mesh (NULL on light mesh)
228 // these are NULL after Mod_ShadowMesh_Finish is performed, only used
229 // while building meshes
230 shadowmeshvertexhash_t **vertexhashtable, *vertexhashentries;
231 r_meshbuffer_t *vbo_vertexbuffer;
232 size_t vbooffset_vertex3f;
233 size_t vbooffset_svector3f;
234 size_t vbooffset_tvector3f;
235 size_t vbooffset_normal3f;
236 size_t vbooffset_texcoord2f;
237 // vertex/index buffers for rendering
238 // (created by Mod_ShadowMesh_Finish if possible)
239 r_vertexmesh_t *vertexmesh; // usually NULL
240 r_meshbuffer_t *vertex3fbuffer;
241 r_meshbuffer_t *vertexmeshbuffer; // usually NULL
245 // various flags from shaders, used for special effects not otherwise classified
246 // TODO: support these features more directly
247 #define Q3TEXTUREFLAG_TWOSIDED 1
248 #define Q3TEXTUREFLAG_NOPICMIP 16
249 #define Q3TEXTUREFLAG_POLYGONOFFSET 32
250 #define Q3TEXTUREFLAG_REFRACTION 256
251 #define Q3TEXTUREFLAG_REFLECTION 512
252 #define Q3TEXTUREFLAG_WATERSHADER 1024
253 #define Q3TEXTUREFLAG_CAMERA 2048
255 #define Q3PATHLENGTH 64
256 #define TEXTURE_MAXFRAMES 64
257 #define Q3WAVEPARMS 4
258 #define Q3DEFORM_MAXPARMS 3
259 #define Q3SHADER_MAXLAYERS 2 // FIXME support more than that (currently only two are used, so why keep more in RAM?)
260 #define Q3RGBGEN_MAXPARMS 3
261 #define Q3ALPHAGEN_MAXPARMS 1
262 #define Q3TCGEN_MAXPARMS 6
263 #define Q3TCMOD_MAXPARMS 6
264 #define Q3MAXTCMODS 8
265 #define Q3MAXDEFORMS 4
267 typedef enum q3wavefunc_e
270 Q3WAVEFUNC_INVERSESAWTOOTH,
279 typedef int q3wavefunc_t;
280 #define Q3WAVEFUNC_USER_COUNT 4
281 #define Q3WAVEFUNC_USER_SHIFT 8 // use 8 bits for wave func type
283 typedef enum q3deform_e
286 Q3DEFORM_PROJECTIONSHADOW,
288 Q3DEFORM_AUTOSPRITE2,
305 typedef enum q3rgbgen_e
310 Q3RGBGEN_EXACTVERTEX,
311 Q3RGBGEN_IDENTITYLIGHTING,
312 Q3RGBGEN_LIGHTINGDIFFUSE,
313 Q3RGBGEN_ONEMINUSENTITY,
314 Q3RGBGEN_ONEMINUSVERTEX,
321 typedef enum q3alphagen_e
326 Q3ALPHAGEN_LIGHTINGSPECULAR,
327 Q3ALPHAGEN_ONEMINUSENTITY,
328 Q3ALPHAGEN_ONEMINUSVERTEX,
336 typedef enum q3tcgen_e
339 Q3TCGEN_TEXTURE, // very common
340 Q3TCGEN_ENVIRONMENT, // common
347 typedef enum q3tcmod_e
350 Q3TCMOD_ENTITYTRANSLATE,
362 typedef struct q3shaderinfo_layer_rgbgen_s
365 float parms[Q3RGBGEN_MAXPARMS];
366 q3wavefunc_t wavefunc;
367 float waveparms[Q3WAVEPARMS];
369 q3shaderinfo_layer_rgbgen_t;
371 typedef struct q3shaderinfo_layer_alphagen_s
373 q3alphagen_t alphagen;
374 float parms[Q3ALPHAGEN_MAXPARMS];
375 q3wavefunc_t wavefunc;
376 float waveparms[Q3WAVEPARMS];
378 q3shaderinfo_layer_alphagen_t;
380 typedef struct q3shaderinfo_layer_tcgen_s
383 float parms[Q3TCGEN_MAXPARMS];
385 q3shaderinfo_layer_tcgen_t;
387 typedef struct q3shaderinfo_layer_tcmod_s
390 float parms[Q3TCMOD_MAXPARMS];
391 q3wavefunc_t wavefunc;
392 float waveparms[Q3WAVEPARMS];
394 q3shaderinfo_layer_tcmod_t;
396 typedef struct q3shaderinfo_layer_s
405 q3shaderinfo_layer_rgbgen_t rgbgen;
406 q3shaderinfo_layer_alphagen_t alphagen;
407 q3shaderinfo_layer_tcgen_t tcgen;
408 q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
410 q3shaderinfo_layer_t;
412 typedef struct q3shaderinfo_deform_s
415 float parms[Q3DEFORM_MAXPARMS];
416 q3wavefunc_t wavefunc;
417 float waveparms[Q3WAVEPARMS];
419 q3shaderinfo_deform_t;
421 typedef enum dpoffsetmapping_technique_s
423 OFFSETMAPPING_OFF, // none
424 OFFSETMAPPING_DEFAULT, // cvar-set
425 OFFSETMAPPING_LINEAR, // linear
426 OFFSETMAPPING_RELIEF // relief
427 }dpoffsetmapping_technique_t;
430 typedef struct q3shaderinfo_s
432 char name[Q3PATHLENGTH];
433 #define Q3SHADERINFO_COMPARE_START surfaceparms
438 qboolean vertexalpha;
439 qboolean textureblendalpha;
440 int primarylayer, backgroundlayer;
441 q3shaderinfo_layer_t layers[Q3SHADER_MAXLAYERS];
442 char skyboxname[Q3PATHLENGTH];
443 q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
445 // dp-specific additions:
448 qboolean dpnortlight;
452 // add collisions to all triangles of the surface
453 qboolean dpmeshcollisions;
455 // kill shader based on cvar checks
456 qboolean dpshaderkill;
459 char dpreflectcube[Q3PATHLENGTH];
462 float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
463 float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
464 float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
465 vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
466 float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
467 vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
468 float r_water_wateralpha; // additional wateralpha to apply when r_water is active
469 float r_water_waterscroll[2]; // water normalmapscrollblend - scale and speed
472 dpoffsetmapping_technique_t offsetmapping;
474 float offsetbias; // 0 is normal, 1 leads to alpha 0 being neutral and alpha 1 pushing "out"
476 // polygonoffset (only used if Q3TEXTUREFLAG_POLYGONOFFSET)
477 float biaspolygonoffset, biaspolygonfactor;
480 float specularscalemod;
481 float specularpowermod;
483 // rtlightning ambient addition
484 float rtlightambient;
485 #define Q3SHADERINFO_COMPARE_END rtlightambient
489 typedef enum texturelayertype_e
491 TEXTURELAYERTYPE_INVALID,
492 TEXTURELAYERTYPE_LITTEXTURE,
493 TEXTURELAYERTYPE_TEXTURE,
498 typedef struct texturelayer_s
500 texturelayertype_t type;
505 matrix4x4_t texmatrix;
510 typedef struct texture_s
516 unsigned int width, height;
518 //unsigned int flags;
520 // base material flags
521 int basematerialflags;
522 // current material flags (updated each bmodel render)
523 int currentmaterialflags;
525 // PolygonOffset values for rendering this material
526 // (these are added to the r_refdef values and submodel values)
527 float biaspolygonfactor;
528 float biaspolygonoffset;
530 // textures to use when rendering this material
531 skinframe_t *currentskinframe;
534 skinframe_t *skinframes[TEXTURE_MAXFRAMES];
535 // background layer (for terrain texture blending)
536 skinframe_t *backgroundcurrentskinframe;
537 int backgroundnumskinframes;
538 float backgroundskinframerate;
539 skinframe_t *backgroundskinframes[TEXTURE_MAXFRAMES];
541 // total frames in sequence and alternate sequence
543 // direct pointers to each of the frames in the sequences
544 // (indexed as [alternate][frame])
545 struct texture_s *anim_frames[2][10];
546 // set if animated or there is an alternate frame set
547 // (this is an optimization in the renderer)
550 // renderer checks if this texture needs updating...
551 int update_lastrenderframe;
552 void *update_lastrenderentity;
553 // the current alpha of this texture (may be affected by r_wateralpha)
555 // the current texture frame in animation
556 struct texture_s *currentframe;
557 // current texture transform matrix (used for water scrolling)
558 matrix4x4_t currenttexmatrix;
559 matrix4x4_t currentbackgroundtexmatrix;
561 // various q3 shader features
562 q3shaderinfo_layer_rgbgen_t rgbgen;
563 q3shaderinfo_layer_alphagen_t alphagen;
564 q3shaderinfo_layer_tcgen_t tcgen;
565 q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
566 q3shaderinfo_layer_tcmod_t backgroundtcmods[Q3MAXTCMODS];
567 q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
569 qboolean colormapping;
570 rtexture_t *basetexture; // original texture without pants/shirt/glow
571 rtexture_t *pantstexture; // pants only (in greyscale)
572 rtexture_t *shirttexture; // shirt only (in greyscale)
573 rtexture_t *nmaptexture; // normalmap (bumpmap for dot3)
574 rtexture_t *glosstexture; // glossmap (for dot3)
575 rtexture_t *glowtexture; // glow only (fullbrights)
576 rtexture_t *fogtexture; // alpha of the base texture (if not opaque)
577 rtexture_t *reflectmasktexture; // mask for fake reflections
578 rtexture_t *reflectcubetexture; // fake reflections cubemap
579 rtexture_t *backgroundbasetexture; // original texture without pants/shirt/glow
580 rtexture_t *backgroundnmaptexture; // normalmap (bumpmap for dot3)
581 rtexture_t *backgroundglosstexture; // glossmap (for dot3)
582 rtexture_t *backgroundglowtexture; // glow only (fullbrights)
585 // color tint (colormod * currentalpha) used for rtlighting this material
586 float dlightcolor[3];
587 // color tint (colormod * 2) used for lightmapped lighting on this material
588 // includes alpha as 4th component
589 // replaces role of gl_Color in GLSL shader
590 float lightmapcolor[4];
593 int customblendfunc[2];
595 int currentnumlayers;
596 texturelayer_t currentlayers[16];
606 float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
607 float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
608 float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
609 vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
610 float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
611 vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
612 float r_water_wateralpha; // additional wateralpha to apply when r_water is active
613 float r_water_waterscroll[2]; // scale and speed
614 int camera_entity; // entity number for use by cameras
617 dpoffsetmapping_technique_t offsetmapping;
622 float specularscalemod;
623 float specularpowermod;
625 // diffuse and ambient
626 float rtlightambient;
630 typedef struct mtexinfo_s
638 typedef struct msurface_lightmapinfo_s
640 // texture mapping properties used by this surface
641 mtexinfo_t *texinfo; // q1bsp
642 // index into r_refdef.scene.lightstylevalue array, 255 means not used (black)
643 unsigned char styles[MAXLIGHTMAPS]; // q1bsp
644 // RGB lighting data [numstyles][height][width][3]
645 unsigned char *samples; // q1bsp
646 // RGB normalmap data [numstyles][height][width][3]
647 unsigned char *nmapsamples; // q1bsp
648 // stain to apply on lightmap (soot/dirt/blood/whatever)
649 unsigned char *stainsamples; // q1bsp
650 int texturemins[2]; // q1bsp
651 int extents[2]; // q1bsp
652 int lightmaporigin[2]; // q1bsp
654 msurface_lightmapinfo_t;
657 typedef struct msurface_s
659 // bounding box for onscreen checks
662 // the texture to use on the surface
664 // the lightmap texture fragment to use on the rendering mesh
665 rtexture_t *lightmaptexture;
666 // the lighting direction texture fragment to use on the rendering mesh
667 rtexture_t *deluxemaptexture;
668 // lightmaptexture rebuild information not used in q3bsp
669 msurface_lightmapinfo_t *lightmapinfo; // q1bsp
670 // fog volume info in q3bsp
671 struct q3deffect_s *effect; // q3bsp
672 // mesh information for collisions (only used by q3bsp curves)
673 int num_firstcollisiontriangle;
674 int *deprecatedq3data_collisionelement3i; // q3bsp
675 float *deprecatedq3data_collisionvertex3f; // q3bsp
676 float *deprecatedq3data_collisionbbox6f; // collision optimization - contains combined bboxes of every data_collisionstride triangles
677 float *deprecatedq3data_bbox6f; // collision optimization - contains combined bboxes of every data_collisionstride triangles
679 // surfaces own ranges of vertices and triangles in the model->surfmesh
680 int num_triangles; // number of triangles
681 int num_firsttriangle; // first triangle
682 int num_vertices; // number of vertices
683 int num_firstvertex; // first vertex
685 // shadow volume building information
686 int num_firstshadowmeshtriangle; // index into model->brush.shadowmesh
688 // mesh information for collisions (only used by q3bsp curves)
689 int num_collisiontriangles; // q3bsp
690 int num_collisionvertices; // q3bsp
691 int deprecatedq3num_collisionbboxstride;
692 int deprecatedq3num_bboxstride;
693 // FIXME: collisionmarkframe should be kept in a separate array
694 int deprecatedq3collisionmarkframe; // q3bsp // don't collide twice in one trace
698 #include "matrixlib.h"
701 #include "model_brush.h"
702 #include "model_sprite.h"
703 #include "model_alias.h"
705 typedef struct model_sprite_s
708 mspriteframe_t *sprdata_frames;
714 typedef struct model_brush_lightstyleinfo_s
721 model_brush_lightstyleinfo_t;
723 typedef struct model_brush_s
725 // true if this model is a HalfLife .bsp file
727 // string of entity definitions (.map format)
730 // if not NULL this is a submodel
731 struct model_s *parentmodel;
732 // (this is the number of the submodel, an index into submodels)
735 // number of submodels in this map (just used by server to know how many
736 // submodels to load)
738 // pointers to each of the submodels
739 struct model_s **submodels;
742 mplane_t *data_planes;
747 // visible leafs, not counting 0 (solid)
749 // number of actual leafs (including 0 which is solid)
754 int *data_leafbrushes;
756 int num_leafsurfaces;
757 int *data_leafsurfaces;
760 mportal_t *data_portals;
762 int num_portalpoints;
763 mvertex_t *data_portalpoints;
766 q3mbrush_t *data_brushes;
769 q3mbrushside_t *data_brushsides;
773 int num_pvsclusterbytes;
774 unsigned char *data_pvsclusters;
776 //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
777 //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
779 // collision geometry for q3 curves
780 int num_collisionvertices;
781 int num_collisiontriangles;
782 float *data_collisionvertex3f;
783 int *data_collisionelement3i;
785 // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
786 shadowmesh_t *shadowmesh;
788 // a mesh containing all SUPERCONTENTS_SOLID surfaces for this model or submodel, for physics engines to use
789 shadowmesh_t *collisionmesh;
792 int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
793 int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
794 unsigned char *(*GetPVS)(struct model_s *model, const vec3_t p);
795 int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, unsigned char *pvsbuffer, int pvsbufferlength, qboolean merge);
796 int (*BoxTouchingPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
797 int (*BoxTouchingLeafPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
798 int (*BoxTouchingVisibleLeafs)(struct model_s *model, const unsigned char *visibleleafs, const vec3_t mins, const vec3_t maxs);
799 int (*FindBoxClusters)(struct model_s *model, const vec3_t mins, const vec3_t maxs, int maxclusters, int *clusterlist);
800 void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
801 void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
802 mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
803 // these are actually only found on brushq1, but NULL is handled gracefully
804 void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, unsigned char *out, int outsize);
805 void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
806 // trace a line of sight through this model (returns false if the line if sight is definitely blocked)
807 qboolean (*TraceLineOfSight)(struct model_s *model, const vec3_t start, const vec3_t end);
809 char skybox[MAX_QPATH];
811 skinframe_t *solidskyskinframe;
812 skinframe_t *alphaskyskinframe;
814 qboolean supportwateralpha;
822 typedef struct model_brushq1_s
839 mclipnode_t *clipnodes;
841 hull_t hulls[MAX_MAP_HULLS];
843 int num_compressedpvs;
844 unsigned char *data_compressedpvs;
847 unsigned char *lightdata;
848 unsigned char *nmaplightdata; // deluxemap file
850 // lightmap update chains for light styles
852 model_brush_lightstyleinfo_t *data_lightstyleinfo;
854 // this contains bytes that are 1 if a surface needs its lightmap rebuilt
855 unsigned char *lightmapupdateflags;
856 qboolean firstrender; // causes all surface lightmaps to be loaded in first frame
860 /* MSVC can't compile empty structs, so this is commented out for now
861 typedef struct model_brushq2_s
867 typedef struct model_brushq3_s
870 q3dmodel_t *data_models;
872 // used only during loading - freed after loading!
874 float *data_vertex3f;
875 float *data_normal3f;
876 float *data_texcoordtexture2f;
877 float *data_texcoordlightmap2f;
880 // freed after loading!
885 q3deffect_t *data_effects;
888 int num_originallightmaps;
889 int num_mergedlightmaps;
890 int num_lightmapmergedwidthpower;
891 int num_lightmapmergedheightpower;
892 int num_lightmapmergedwidthheightdeluxepower;
893 int num_lightmapmerge;
894 rtexture_t **data_lightmaps;
895 rtexture_t **data_deluxemaps;
897 // voxel light data with directional shading
899 q3dlightgrid_t *data_lightgrid;
900 // size of each cell (may vary by map, typically 64 64 128)
901 float num_lightgrid_cellsize[3];
902 // 1.0 / num_lightgrid_cellsize
903 float num_lightgrid_scale[3];
904 // dimensions of the world model in lightgrid cells
905 int num_lightgrid_imins[3];
906 int num_lightgrid_imaxs[3];
907 int num_lightgrid_isize[3];
908 // transform modelspace coordinates to lightgrid index
909 matrix4x4_t num_lightgrid_indexfromworld;
911 // true if this q3bsp file has been detected as using deluxemapping
912 // (lightmap texture pairs, every odd one is never directly refernced,
913 // and contains lighting normals, not colors)
914 qboolean deluxemapping;
915 // true if the detected deluxemaps are the modelspace kind, rather than
916 // the faster tangentspace kind
917 qboolean deluxemapping_modelspace;
918 // size of lightmaps (128 by default, but may be another poweroftwo if
919 // external lightmaps are used (q3map2 -lightmapsize)
927 typedef struct model_s
929 // name and path of model, for example "progs/player.mdl"
930 char name[MAX_QPATH];
931 // model needs to be loaded if this is false
933 // set if the model is used in current map, models which are not, are purged
935 // CRC of the file this model was loaded from, to reload if changed
937 // mod_brush, mod_alias, mod_sprite
939 // memory pool for allocations
941 // all models use textures...
942 rtexturepool_t *texturepool;
943 // EF_* flags (translated from the model file's different flags layout)
945 // number of QC accessible frame(group)s in the model
947 // number of QC accessible skin(group)s in the model
949 // whether to randomize animated framegroups
951 // bounding box at angles '0 0 0'
952 vec3_t normalmins, normalmaxs;
953 // bounding box if yaw angle is not 0, but pitch and roll are
954 vec3_t yawmins, yawmaxs;
955 // bounding box if pitch or roll are used
956 vec3_t rotatedmins, rotatedmaxs;
957 // sphere radius, usable at any angles
959 // squared sphere radius for easier comparisons
961 // skin animation info
962 animscene_t *skinscenes; // [numskins]
963 // skin animation info
964 animscene_t *animscenes; // [numframes]
965 // range of surface numbers in this (sub)model
966 int firstmodelsurface;
967 int nummodelsurfaces;
968 int *sortedmodelsurfaces;
969 // range of collision brush numbers in this (sub)model
972 // BIH (Bounding Interval Hierarchy) for this (sub)model
974 bih_t render_bih; // if not set, use collision_bih instead for rendering purposes too
978 aliastag_t *data_tags;
979 // for skeletal models
981 aliasbone_t *data_bones;
982 float num_posescale; // scaling factor from origin in poses6s format (includes divide by 32767)
983 float num_poseinvscale; // scaling factor to origin in poses6s format (includes multiply by 32767)
985 short *data_poses6s; // origin xyz, quat xyz, w implied negative, unit length, values normalized to +/-32767 range
986 float *data_baseboneposeinverse;
987 // textures of this model
989 int num_texturesperskin;
990 texture_t *data_textures;
991 qboolean wantnormals;
992 qboolean wanttangents;
993 // surfaces of this model
995 msurface_t *data_surfaces;
996 // optional lightmapinfo data for surface lightmap updates
997 msurface_lightmapinfo_t *data_surfaces_lightmapinfo;
998 // all surfaces belong to this mesh
1000 // data type of model
1001 const char *modeldatatypestring;
1002 // generates vertex data for a given frameblend
1003 void(*AnimateVertices)(const struct model_s * RESTRICT model, const struct frameblend_s * RESTRICT frameblend, const struct skeleton_s *skeleton, float * RESTRICT vertex3f, float * RESTRICT normal3f, float * RESTRICT svector3f, float * RESTRICT tvector3f);
1004 // draw the model's sky polygons (only used by brush models)
1005 void(*DrawSky)(struct entity_render_s *ent);
1006 // draw refraction/reflection textures for the model's water polygons (only used by brush models)
1007 void(*DrawAddWaterPlanes)(struct entity_render_s *ent);
1008 // draw the model using lightmap/dlight shading
1009 void(*Draw)(struct entity_render_s *ent);
1010 // draw the model to the depth buffer (no color rendering at all)
1011 void(*DrawDepth)(struct entity_render_s *ent);
1012 // draw any enabled debugging effects on this model (such as showing triangles, normals, collision brushes...)
1013 void(*DrawDebug)(struct entity_render_s *ent);
1014 // draw geometry textures for deferred rendering
1015 void(*DrawPrepass)(struct entity_render_s *ent);
1016 // compile an optimized shadowmap mesh for the model based on light source
1017 void(*CompileShadowMap)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1018 // draw depth into a shadowmap
1019 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 unsigned char *surfacesides, const vec3_t lightmins, const vec3_t lightmaxs);
1020 // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
1021 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, int numfrustumplanes, const mplane_t *frustumplanes);
1022 // compile a shadow volume for the model based on light source
1023 void(*CompileShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1024 // draw a shadow volume for the model based on light source
1025 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);
1026 // draw the lighting on a model (through stencil)
1027 void(*DrawLight)(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
1028 // trace a box against this model
1029 void (*TraceBox)(struct model_s *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, struct trace_s *trace, const vec3_t start, const vec3_t boxmins, const vec3_t boxmaxs, const vec3_t end, int hitsupercontentsmask);
1030 void (*TraceBrush)(struct model_s *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, struct trace_s *trace, struct colbrushf_s *start, struct colbrushf_s *end, int hitsupercontentsmask);
1031 // trace a box against this model
1032 void (*TraceLine)(struct model_s *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, struct trace_s *trace, const vec3_t start, const vec3_t end, int hitsupercontentsmask);
1033 // trace a point against this model (like PointSuperContents)
1034 void (*TracePoint)(struct model_s *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, struct trace_s *trace, const vec3_t start, int hitsupercontentsmask);
1035 // find the supercontents value at a point in this model
1036 int (*PointSuperContents)(struct model_s *model, int frame, const vec3_t point);
1037 // trace a line against geometry in this model and report correct texture (used by r_shadow_bouncegrid)
1038 void (*TraceLineAgainstSurfaces)(struct model_s *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, struct trace_s *trace, const vec3_t start, const vec3_t end, int hitsupercontentsmask);
1039 // fields belonging to some types of model
1040 model_sprite_t sprite;
1041 model_brush_t brush;
1042 model_brushq1_t brushq1;
1043 /* MSVC can't handle an empty struct, so this is commented out for now
1044 model_brushq2_t brushq2;
1046 model_brushq3_t brushq3;
1047 // flags this model for offseting sounds to the model center (used by brush models)
1048 int soundfromcenter;
1050 // if set, the model contains light information (lightmap, or vertexlight)
1055 //============================================================================
1058 extern dp_model_t *loadmodel;
1059 extern unsigned char *mod_base;
1060 // sky/water subdivision
1061 //extern cvar_t gl_subdivide_size;
1062 // texture fullbrights
1063 extern cvar_t r_fullbrights;
1064 extern cvar_t r_enableshadowvolumes;
1066 void Mod_Init (void);
1067 void Mod_Reload (void);
1068 dp_model_t *Mod_LoadModel(dp_model_t *mod, qboolean crash, qboolean checkdisk);
1069 dp_model_t *Mod_FindName (const char *name, const char *parentname);
1070 dp_model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, const char *parentname);
1071 void Mod_UnloadModel (dp_model_t *mod);
1073 void Mod_ClearUsed(void);
1074 void Mod_PurgeUnused(void);
1075 void Mod_RemoveStaleWorldModels(dp_model_t *skip); // only used during loading!
1077 extern dp_model_t *loadmodel;
1078 extern char loadname[32]; // for hunk tags
1080 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
1081 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
1082 void Mod_ValidateElements(int *elements, int numtriangles, int firstvertex, int numverts, const char *filename, int fileline);
1083 void Mod_BuildNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const int *elements, float *normal3f, qboolean areaweighting);
1084 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);
1086 void Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, qboolean lightmapoffsets, qboolean vertexcolors, qboolean neighbors);
1087 void Mod_MakeSortedSurfaces(dp_model_t *mod);
1089 // called specially by brush model loaders before generating submodels
1090 // automatically called after model loader returns
1091 void Mod_BuildVBOs(void);
1093 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);
1094 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
1095 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
1096 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
1097 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);
1098 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);
1099 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, qboolean light, qboolean neighbors, qboolean createvbo);
1100 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
1101 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
1103 void Mod_CreateCollisionMesh(dp_model_t *mod);
1105 void Mod_FreeQ3Shaders(void);
1106 void Mod_LoadQ3Shaders(void);
1107 q3shaderinfo_t *Mod_LookupQ3Shader(const char *name);
1108 qboolean Mod_LoadTextureFromQ3Shader(texture_t *texture, const char *name, qboolean warnmissing, qboolean fallback, int defaulttexflags);
1110 extern cvar_t r_mipskins;
1111 extern cvar_t r_mipnormalmaps;
1113 typedef struct skinfileitem_s
1115 struct skinfileitem_s *next;
1116 char name[MAX_QPATH];
1117 char replacement[MAX_QPATH];
1121 typedef struct skinfile_s
1123 struct skinfile_s *next;
1124 skinfileitem_t *items;
1128 skinfile_t *Mod_LoadSkinFiles(void);
1129 void Mod_FreeSkinFiles(skinfile_t *skinfile);
1130 int Mod_CountSkinFiles(skinfile_t *skinfile);
1131 void Mod_BuildAliasSkinsFromSkinFiles(texture_t *skin, skinfile_t *skinfile, const char *meshname, const char *shadername);
1133 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
1134 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
1135 void Mod_VertexRangeFromElements(int numelements, const int *elements, int *firstvertexpointer, int *lastvertexpointer);
1137 typedef struct mod_alloclightmap_row_s
1142 mod_alloclightmap_row_t;
1144 typedef struct mod_alloclightmap_state_s
1149 mod_alloclightmap_row_t *rows;
1151 mod_alloclightmap_state_t;
1153 void Mod_AllocLightmap_Init(mod_alloclightmap_state_t *state, int width, int height);
1154 void Mod_AllocLightmap_Free(mod_alloclightmap_state_t *state);
1155 void Mod_AllocLightmap_Reset(mod_alloclightmap_state_t *state);
1156 qboolean Mod_AllocLightmap_Block(mod_alloclightmap_state_t *state, int blockwidth, int blockheight, int *outx, int *outy);
1159 void Mod_BrushInit(void);
1160 // used for talking to the QuakeC mainly
1161 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
1162 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
1164 // a lot of model formats use the Q1BSP code, so here are the prototypes...
1165 struct entity_render_s;
1166 void R_Q1BSP_DrawAddWaterPlanes(struct entity_render_s *ent);
1167 void R_Q1BSP_DrawSky(struct entity_render_s *ent);
1168 void R_Q1BSP_Draw(struct entity_render_s *ent);
1169 void R_Q1BSP_DrawDepth(struct entity_render_s *ent);
1170 void R_Q1BSP_DrawDebug(struct entity_render_s *ent);
1171 void R_Q1BSP_DrawPrepass(struct entity_render_s *ent);
1172 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, int numfrustumplanes, const mplane_t *frustumplanes);
1173 void R_Q1BSP_CompileShadowMap(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1174 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 unsigned char *surfacesides, const vec3_t lightmins, const vec3_t lightmaxs);
1175 void R_Q1BSP_CompileShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1176 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);
1177 void R_Q1BSP_DrawLight(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
1179 // Collision optimization using Bounding Interval Hierarchy
1180 void Mod_CollisionBIH_TracePoint(dp_model_t *model, const struct frameblend_s *frameblend, const skeleton_t *skeleton, struct trace_s *trace, const vec3_t start, int hitsupercontentsmask);
1181 void Mod_CollisionBIH_TraceLine(dp_model_t *model, const struct frameblend_s *frameblend, const skeleton_t *skeleton, struct trace_s *trace, const vec3_t start, const vec3_t end, int hitsupercontentsmask);
1182 void Mod_CollisionBIH_TraceBox(dp_model_t *model, const struct frameblend_s *frameblend, const skeleton_t *skeleton, struct trace_s *trace, const vec3_t start, const vec3_t boxmins, const vec3_t boxmaxs, const vec3_t end, int hitsupercontentsmask);
1183 void Mod_CollisionBIH_TraceBrush(dp_model_t *model, const struct frameblend_s *frameblend, const skeleton_t *skeleton, struct trace_s *trace, struct colbrushf_s *start, struct colbrushf_s *end, int hitsupercontentsmask);
1184 void Mod_CollisionBIH_TracePoint_Mesh(dp_model_t *model, const struct frameblend_s *frameblend, const skeleton_t *skeleton, struct trace_s *trace, const vec3_t start, int hitsupercontentsmask);
1185 int Mod_CollisionBIH_PointSuperContents_Mesh(struct model_s *model, int frame, const vec3_t point);
1186 bih_t *Mod_MakeCollisionBIH(dp_model_t *model, qboolean userendersurfaces, bih_t *out);
1189 struct frameblend_s;
1191 void Mod_AliasInit(void);
1192 int Mod_Alias_GetTagMatrix(const dp_model_t *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, int tagindex, matrix4x4_t *outmatrix);
1193 int Mod_Alias_GetTagIndexForName(const dp_model_t *model, unsigned int skin, const char *tagname);
1194 int Mod_Alias_GetExtendedTagInfoForIndex(const dp_model_t *model, unsigned int skin, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, int tagindex, int *parentindex, const char **tagname, matrix4x4_t *tag_localmatrix);
1196 void Mod_Skeletal_FreeBuffers(void);
1199 void Mod_SpriteInit(void);
1202 void Mod_Q1BSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1203 void Mod_IBSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1204 void Mod_MAP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1205 void Mod_OBJ_Load(dp_model_t *mod, void *buffer, void *bufferend);
1206 void Mod_IDP0_Load(dp_model_t *mod, void *buffer, void *bufferend);
1207 void Mod_IDP2_Load(dp_model_t *mod, void *buffer, void *bufferend);
1208 void Mod_IDP3_Load(dp_model_t *mod, void *buffer, void *bufferend);
1209 void Mod_ZYMOTICMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1210 void Mod_DARKPLACESMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1211 void Mod_PSKMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1212 void Mod_IDSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1213 void Mod_IDS2_Load(dp_model_t *mod, void *buffer, void *bufferend);
1214 void Mod_INTERQUAKEMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1216 #endif // MODEL_SHARED_H