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_vertexposition_s
111 typedef struct r_vertexgeneric_s
115 unsigned char color4ub[4];
120 typedef struct r_vertexmesh_s
124 unsigned char color4ub[4];
125 float texcoordtexture2f[2];
126 float texcoordlightmap2f[2];
133 typedef struct r_meshbuffer_s
135 int bufferobject; // OpenGL
136 void *devicebuffer; // Direct3D
138 qboolean isindexbuffer;
141 char name[MAX_QPATH];
145 // used for mesh lists in q1bsp/q3bsp map models
146 // (the surfaces reference portions of these meshes)
147 typedef struct surfmesh_s
149 // triangle data in system memory
150 int num_triangles; // number of triangles in the mesh
151 int *data_element3i; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
152 r_meshbuffer_t *data_element3i_indexbuffer;
153 size_t data_element3i_bufferoffset;
154 unsigned short *data_element3s; // unsigned short[tris*3] triangles of the mesh in unsigned short format (NULL if num_vertices > 65536)
155 r_meshbuffer_t *data_element3s_indexbuffer;
156 size_t data_element3s_bufferoffset;
157 int *data_neighbor3i; // int[tris*3] neighboring triangle on each edge (-1 if none)
158 // vertex data in system memory
159 int num_vertices; // number of vertices in the mesh
160 float *data_vertex3f; // float[verts*3] vertex locations
161 float *data_svector3f; // float[verts*3] direction of 'S' (right) texture axis for each vertex
162 float *data_tvector3f; // float[verts*3] direction of 'T' (down) texture axis for each vertex
163 float *data_normal3f; // float[verts*3] direction of 'R' (out) texture axis for each vertex
164 float *data_texcoordtexture2f; // float[verts*2] texcoords for surface texture
165 float *data_texcoordlightmap2f; // float[verts*2] texcoords for lightmap texture
166 float *data_lightmapcolor4f;
167 int *data_lightmapoffsets; // index into surface's lightmap samples for vertex lighting
168 // vertex buffer object (stores geometry in video memory)
169 r_meshbuffer_t *vbo_vertexbuffer;
170 size_t vbooffset_vertex3f;
171 size_t vbooffset_svector3f;
172 size_t vbooffset_tvector3f;
173 size_t vbooffset_normal3f;
174 size_t vbooffset_texcoordtexture2f;
175 size_t vbooffset_texcoordlightmap2f;
176 size_t vbooffset_lightmapcolor4f;
177 // morph blending, these are zero if model is skeletal or static
179 struct md3vertex_s *data_morphmd3vertex;
180 struct trivertx_s *data_morphmdlvertex;
181 struct texvecvertex_s *data_morphtexvecvertex;
182 float *data_morphmd2framesize6f;
183 float num_morphmdlframescale[3];
184 float num_morphmdlframetranslate[3];
185 // skeletal blending, these are NULL if model is morph or static
186 struct blendweights_s *data_blendweights;
188 unsigned short *blends;
189 // set if there is some kind of animation on this model
192 // vertex and index buffers for rendering
193 r_vertexposition_t *vertexposition;
194 r_vertexmesh_t *vertexmesh;
195 r_meshbuffer_t *vertexpositionbuffer;
196 r_meshbuffer_t *vertexmeshbuffer;
200 #define SHADOWMESHVERTEXHASH 1024
201 typedef struct shadowmeshvertexhash_s
203 struct shadowmeshvertexhash_s *next;
205 shadowmeshvertexhash_t;
207 typedef struct shadowmesh_s
209 // next mesh in chain
210 struct shadowmesh_s *next;
211 // used for light mesh (NULL on shadow mesh)
212 rtexture_t *map_diffuse;
213 rtexture_t *map_specular;
214 rtexture_t *map_normal;
216 int numverts, maxverts;
217 int numtriangles, maxtriangles;
220 // used for light mesh (NULL on shadow mesh)
227 r_meshbuffer_t *element3i_indexbuffer;
228 size_t element3i_bufferoffset;
229 unsigned short *element3s;
230 r_meshbuffer_t *element3s_indexbuffer;
231 size_t element3s_bufferoffset;
232 // used for shadow mapping cubemap side partitioning
233 int sideoffsets[6], sidetotals[6];
234 // used for shadow mesh (NULL on light mesh)
236 // these are NULL after Mod_ShadowMesh_Finish is performed, only used
237 // while building meshes
238 shadowmeshvertexhash_t **vertexhashtable, *vertexhashentries;
239 r_meshbuffer_t *vbo_vertexbuffer;
240 size_t vbooffset_vertex3f;
241 size_t vbooffset_svector3f;
242 size_t vbooffset_tvector3f;
243 size_t vbooffset_normal3f;
244 size_t vbooffset_texcoord2f;
245 // vertex/index buffers for rendering
246 // (created by Mod_ShadowMesh_Finish if possible)
247 r_vertexposition_t *vertexposition;
248 r_vertexmesh_t *vertexmesh; // usually NULL
249 r_meshbuffer_t *vertexpositionbuffer;
250 r_meshbuffer_t *vertexmeshbuffer; // usually NULL
254 // various flags from shaders, used for special effects not otherwise classified
255 // TODO: support these features more directly
256 #define Q3TEXTUREFLAG_TWOSIDED 1
257 #define Q3TEXTUREFLAG_NOPICMIP 16
258 #define Q3TEXTUREFLAG_POLYGONOFFSET 32
259 #define Q3TEXTUREFLAG_REFRACTION 256
260 #define Q3TEXTUREFLAG_REFLECTION 512
261 #define Q3TEXTUREFLAG_WATERSHADER 1024
262 #define Q3TEXTUREFLAG_CAMERA 2048
264 #define Q3PATHLENGTH 64
265 #define TEXTURE_MAXFRAMES 64
266 #define Q3WAVEPARMS 4
267 #define Q3DEFORM_MAXPARMS 3
268 #define Q3SHADER_MAXLAYERS 2 // FIXME support more than that (currently only two are used, so why keep more in RAM?)
269 #define Q3RGBGEN_MAXPARMS 3
270 #define Q3ALPHAGEN_MAXPARMS 1
271 #define Q3TCGEN_MAXPARMS 6
272 #define Q3TCMOD_MAXPARMS 6
273 #define Q3MAXTCMODS 8
274 #define Q3MAXDEFORMS 4
276 typedef enum q3wavefunc_e
279 Q3WAVEFUNC_INVERSESAWTOOTH,
288 typedef int q3wavefunc_t;
289 #define Q3WAVEFUNC_USER_COUNT 4
290 #define Q3WAVEFUNC_USER_SHIFT 8 // use 8 bits for wave func type
292 typedef enum q3deform_e
295 Q3DEFORM_PROJECTIONSHADOW,
297 Q3DEFORM_AUTOSPRITE2,
314 typedef enum q3rgbgen_e
319 Q3RGBGEN_EXACTVERTEX,
320 Q3RGBGEN_IDENTITYLIGHTING,
321 Q3RGBGEN_LIGHTINGDIFFUSE,
322 Q3RGBGEN_ONEMINUSENTITY,
323 Q3RGBGEN_ONEMINUSVERTEX,
330 typedef enum q3alphagen_e
335 Q3ALPHAGEN_LIGHTINGSPECULAR,
336 Q3ALPHAGEN_ONEMINUSENTITY,
337 Q3ALPHAGEN_ONEMINUSVERTEX,
345 typedef enum q3tcgen_e
348 Q3TCGEN_TEXTURE, // very common
349 Q3TCGEN_ENVIRONMENT, // common
356 typedef enum q3tcmod_e
359 Q3TCMOD_ENTITYTRANSLATE,
371 typedef struct q3shaderinfo_layer_rgbgen_s
374 float parms[Q3RGBGEN_MAXPARMS];
375 q3wavefunc_t wavefunc;
376 float waveparms[Q3WAVEPARMS];
378 q3shaderinfo_layer_rgbgen_t;
380 typedef struct q3shaderinfo_layer_alphagen_s
382 q3alphagen_t alphagen;
383 float parms[Q3ALPHAGEN_MAXPARMS];
384 q3wavefunc_t wavefunc;
385 float waveparms[Q3WAVEPARMS];
387 q3shaderinfo_layer_alphagen_t;
389 typedef struct q3shaderinfo_layer_tcgen_s
392 float parms[Q3TCGEN_MAXPARMS];
394 q3shaderinfo_layer_tcgen_t;
396 typedef struct q3shaderinfo_layer_tcmod_s
399 float parms[Q3TCMOD_MAXPARMS];
400 q3wavefunc_t wavefunc;
401 float waveparms[Q3WAVEPARMS];
403 q3shaderinfo_layer_tcmod_t;
405 typedef struct q3shaderinfo_layer_s
414 q3shaderinfo_layer_rgbgen_t rgbgen;
415 q3shaderinfo_layer_alphagen_t alphagen;
416 q3shaderinfo_layer_tcgen_t tcgen;
417 q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
419 q3shaderinfo_layer_t;
421 typedef struct q3shaderinfo_deform_s
424 float parms[Q3DEFORM_MAXPARMS];
425 q3wavefunc_t wavefunc;
426 float waveparms[Q3WAVEPARMS];
428 q3shaderinfo_deform_t;
430 typedef enum dpoffsetmapping_technique_s
432 OFFSETMAPPING_OFF, // none
433 OFFSETMAPPING_DEFAULT, // cvar-set
434 OFFSETMAPPING_LINEAR, // linear
435 OFFSETMAPPING_RELIEF // relief
436 }dpoffsetmapping_technique_t;
439 typedef struct q3shaderinfo_s
441 char name[Q3PATHLENGTH];
442 #define Q3SHADERINFO_COMPARE_START surfaceparms
447 qboolean vertexalpha;
448 qboolean textureblendalpha;
449 int primarylayer, backgroundlayer;
450 q3shaderinfo_layer_t layers[Q3SHADER_MAXLAYERS];
451 char skyboxname[Q3PATHLENGTH];
452 q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
454 // dp-specific additions:
460 // add collisions to all triangles of the surface
461 qboolean dpmeshcollisions;
464 char dpreflectcube[Q3PATHLENGTH];
467 float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
468 float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
469 float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
470 vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
471 float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
472 vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
473 float r_water_wateralpha; // additional wateralpha to apply when r_water is active
474 float r_water_waterscroll[2]; // water normalmapscrollblend - scale and speed
477 dpoffsetmapping_technique_t offsetmapping;
481 float specularscalemod;
482 float specularpowermod;
483 #define Q3SHADERINFO_COMPARE_END specularpowermod
487 typedef enum texturelayertype_e
489 TEXTURELAYERTYPE_INVALID,
490 TEXTURELAYERTYPE_LITTEXTURE,
491 TEXTURELAYERTYPE_TEXTURE,
496 typedef struct texturelayer_s
498 texturelayertype_t type;
503 matrix4x4_t texmatrix;
508 typedef struct texture_s
514 unsigned int width, height;
516 //unsigned int flags;
518 // base material flags
519 int basematerialflags;
520 // current material flags (updated each bmodel render)
521 int currentmaterialflags;
523 // PolygonOffset values for rendering this material
524 // (these are added to the r_refdef values and submodel values)
525 float biaspolygonfactor;
526 float biaspolygonoffset;
528 // textures to use when rendering this material
529 skinframe_t *currentskinframe;
532 skinframe_t *skinframes[TEXTURE_MAXFRAMES];
533 // background layer (for terrain texture blending)
534 skinframe_t *backgroundcurrentskinframe;
535 int backgroundnumskinframes;
536 float backgroundskinframerate;
537 skinframe_t *backgroundskinframes[TEXTURE_MAXFRAMES];
539 // total frames in sequence and alternate sequence
541 // direct pointers to each of the frames in the sequences
542 // (indexed as [alternate][frame])
543 struct texture_s *anim_frames[2][10];
544 // set if animated or there is an alternate frame set
545 // (this is an optimization in the renderer)
548 // renderer checks if this texture needs updating...
549 int update_lastrenderframe;
550 void *update_lastrenderentity;
551 // the current alpha of this texture (may be affected by r_wateralpha)
553 // the current texture frame in animation
554 struct texture_s *currentframe;
555 // current texture transform matrix (used for water scrolling)
556 matrix4x4_t currenttexmatrix;
557 matrix4x4_t currentbackgroundtexmatrix;
559 // various q3 shader features
560 q3shaderinfo_layer_rgbgen_t rgbgen;
561 q3shaderinfo_layer_alphagen_t alphagen;
562 q3shaderinfo_layer_tcgen_t tcgen;
563 q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
564 q3shaderinfo_layer_tcmod_t backgroundtcmods[Q3MAXTCMODS];
565 q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
567 qboolean colormapping;
568 rtexture_t *basetexture; // original texture without pants/shirt/glow
569 rtexture_t *pantstexture; // pants only (in greyscale)
570 rtexture_t *shirttexture; // shirt only (in greyscale)
571 rtexture_t *nmaptexture; // normalmap (bumpmap for dot3)
572 rtexture_t *glosstexture; // glossmap (for dot3)
573 rtexture_t *glowtexture; // glow only (fullbrights)
574 rtexture_t *fogtexture; // alpha of the base texture (if not opaque)
575 rtexture_t *reflectmasktexture; // mask for fake reflections
576 rtexture_t *reflectcubetexture; // fake reflections cubemap
577 rtexture_t *backgroundbasetexture; // original texture without pants/shirt/glow
578 rtexture_t *backgroundnmaptexture; // normalmap (bumpmap for dot3)
579 rtexture_t *backgroundglosstexture; // glossmap (for dot3)
580 rtexture_t *backgroundglowtexture; // glow only (fullbrights)
583 // color tint (colormod * currentalpha) used for rtlighting this material
584 float dlightcolor[3];
585 // color tint (colormod * 2) used for lightmapped lighting on this material
586 // includes alpha as 4th component
587 // replaces role of gl_Color in GLSL shader
588 float lightmapcolor[4];
591 int customblendfunc[2];
593 int currentnumlayers;
594 texturelayer_t currentlayers[16];
604 float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
605 float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
606 float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
607 vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
608 float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
609 vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
610 float r_water_wateralpha; // additional wateralpha to apply when r_water is active
611 float r_water_waterscroll[2]; // scale and speed
612 int camera_entity; // entity number for use by cameras
615 dpoffsetmapping_technique_t offsetmapping;
619 float specularscalemod;
620 float specularpowermod;
624 typedef struct mtexinfo_s
632 typedef struct msurface_lightmapinfo_s
634 // texture mapping properties used by this surface
635 mtexinfo_t *texinfo; // q1bsp
636 // index into r_refdef.scene.lightstylevalue array, 255 means not used (black)
637 unsigned char styles[MAXLIGHTMAPS]; // q1bsp
638 // RGB lighting data [numstyles][height][width][3]
639 unsigned char *samples; // q1bsp
640 // RGB normalmap data [numstyles][height][width][3]
641 unsigned char *nmapsamples; // q1bsp
642 // stain to apply on lightmap (soot/dirt/blood/whatever)
643 unsigned char *stainsamples; // q1bsp
644 int texturemins[2]; // q1bsp
645 int extents[2]; // q1bsp
646 int lightmaporigin[2]; // q1bsp
648 msurface_lightmapinfo_t;
651 typedef struct msurface_s
653 // bounding box for onscreen checks
656 // the texture to use on the surface
658 // the lightmap texture fragment to use on the rendering mesh
659 rtexture_t *lightmaptexture;
660 // the lighting direction texture fragment to use on the rendering mesh
661 rtexture_t *deluxemaptexture;
662 // lightmaptexture rebuild information not used in q3bsp
663 msurface_lightmapinfo_t *lightmapinfo; // q1bsp
664 // fog volume info in q3bsp
665 struct q3deffect_s *effect; // q3bsp
666 // mesh information for collisions (only used by q3bsp curves)
667 int num_firstcollisiontriangle;
668 int *deprecatedq3data_collisionelement3i; // q3bsp
669 float *deprecatedq3data_collisionvertex3f; // q3bsp
670 float *deprecatedq3data_collisionbbox6f; // collision optimization - contains combined bboxes of every data_collisionstride triangles
671 float *deprecatedq3data_bbox6f; // collision optimization - contains combined bboxes of every data_collisionstride triangles
673 // surfaces own ranges of vertices and triangles in the model->surfmesh
674 int num_triangles; // number of triangles
675 int num_firsttriangle; // first triangle
676 int num_vertices; // number of vertices
677 int num_firstvertex; // first vertex
679 // shadow volume building information
680 int num_firstshadowmeshtriangle; // index into model->brush.shadowmesh
682 // mesh information for collisions (only used by q3bsp curves)
683 int num_collisiontriangles; // q3bsp
684 int num_collisionvertices; // q3bsp
685 int deprecatedq3num_collisionbboxstride;
686 int deprecatedq3num_bboxstride;
687 // FIXME: collisionmarkframe should be kept in a separate array
688 int deprecatedq3collisionmarkframe; // q3bsp // don't collide twice in one trace
692 #include "matrixlib.h"
695 #include "model_brush.h"
696 #include "model_sprite.h"
697 #include "model_alias.h"
699 typedef struct model_sprite_s
702 mspriteframe_t *sprdata_frames;
708 typedef struct model_brush_lightstyleinfo_s
715 model_brush_lightstyleinfo_t;
717 typedef struct model_brush_s
719 // true if this model is a HalfLife .bsp file
721 // string of entity definitions (.map format)
724 // if not NULL this is a submodel
725 struct model_s *parentmodel;
726 // (this is the number of the submodel, an index into submodels)
729 // number of submodels in this map (just used by server to know how many
730 // submodels to load)
732 // pointers to each of the submodels
733 struct model_s **submodels;
736 mplane_t *data_planes;
741 // visible leafs, not counting 0 (solid)
743 // number of actual leafs (including 0 which is solid)
748 int *data_leafbrushes;
750 int num_leafsurfaces;
751 int *data_leafsurfaces;
754 mportal_t *data_portals;
756 int num_portalpoints;
757 mvertex_t *data_portalpoints;
760 q3mbrush_t *data_brushes;
763 q3mbrushside_t *data_brushsides;
767 int num_pvsclusterbytes;
768 unsigned char *data_pvsclusters;
770 //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
771 //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
773 // collision geometry for q3 curves
774 int num_collisionvertices;
775 int num_collisiontriangles;
776 float *data_collisionvertex3f;
777 int *data_collisionelement3i;
779 // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
780 shadowmesh_t *shadowmesh;
782 // a mesh containing all SUPERCONTENTS_SOLID surfaces for this model or submodel, for physics engines to use
783 shadowmesh_t *collisionmesh;
786 int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
787 int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
788 unsigned char *(*GetPVS)(struct model_s *model, const vec3_t p);
789 int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, unsigned char *pvsbuffer, int pvsbufferlength, qboolean merge);
790 int (*BoxTouchingPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
791 int (*BoxTouchingLeafPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
792 int (*BoxTouchingVisibleLeafs)(struct model_s *model, const unsigned char *visibleleafs, const vec3_t mins, const vec3_t maxs);
793 int (*FindBoxClusters)(struct model_s *model, const vec3_t mins, const vec3_t maxs, int maxclusters, int *clusterlist);
794 void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
795 void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
796 mleaf_t *(*PointInLeaf)(struct model_s *model, const float *p);
797 // these are actually only found on brushq1, but NULL is handled gracefully
798 void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, unsigned char *out, int outsize);
799 void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
800 // trace a line of sight through this model (returns false if the line if sight is definitely blocked)
801 qboolean (*TraceLineOfSight)(struct model_s *model, const vec3_t start, const vec3_t end);
803 char skybox[MAX_QPATH];
805 skinframe_t *solidskyskinframe;
806 skinframe_t *alphaskyskinframe;
808 qboolean supportwateralpha;
816 typedef struct model_brushq1_s
833 mclipnode_t *clipnodes;
835 hull_t hulls[MAX_MAP_HULLS];
837 int num_compressedpvs;
838 unsigned char *data_compressedpvs;
841 unsigned char *lightdata;
842 unsigned char *nmaplightdata; // deluxemap file
844 // lightmap update chains for light styles
846 model_brush_lightstyleinfo_t *data_lightstyleinfo;
848 // this contains bytes that are 1 if a surface needs its lightmap rebuilt
849 unsigned char *lightmapupdateflags;
850 qboolean firstrender; // causes all surface lightmaps to be loaded in first frame
854 /* MSVC can't compile empty structs, so this is commented out for now
855 typedef struct model_brushq2_s
861 typedef struct model_brushq3_s
864 q3dmodel_t *data_models;
866 // used only during loading - freed after loading!
868 float *data_vertex3f;
869 float *data_normal3f;
870 float *data_texcoordtexture2f;
871 float *data_texcoordlightmap2f;
874 // freed after loading!
879 q3deffect_t *data_effects;
882 int num_originallightmaps;
883 int num_mergedlightmaps;
884 int num_lightmapmergedwidthpower;
885 int num_lightmapmergedheightpower;
886 int num_lightmapmergedwidthheightdeluxepower;
887 int num_lightmapmerge;
888 rtexture_t **data_lightmaps;
889 rtexture_t **data_deluxemaps;
891 // voxel light data with directional shading
893 q3dlightgrid_t *data_lightgrid;
894 // size of each cell (may vary by map, typically 64 64 128)
895 float num_lightgrid_cellsize[3];
896 // 1.0 / num_lightgrid_cellsize
897 float num_lightgrid_scale[3];
898 // dimensions of the world model in lightgrid cells
899 int num_lightgrid_imins[3];
900 int num_lightgrid_imaxs[3];
901 int num_lightgrid_isize[3];
902 // transform modelspace coordinates to lightgrid index
903 matrix4x4_t num_lightgrid_indexfromworld;
905 // true if this q3bsp file has been detected as using deluxemapping
906 // (lightmap texture pairs, every odd one is never directly refernced,
907 // and contains lighting normals, not colors)
908 qboolean deluxemapping;
909 // true if the detected deluxemaps are the modelspace kind, rather than
910 // the faster tangentspace kind
911 qboolean deluxemapping_modelspace;
912 // size of lightmaps (128 by default, but may be another poweroftwo if
913 // external lightmaps are used (q3map2 -lightmapsize)
921 typedef struct model_s
923 // name and path of model, for example "progs/player.mdl"
924 char name[MAX_QPATH];
925 // model needs to be loaded if this is false
927 // set if the model is used in current map, models which are not, are purged
929 // CRC of the file this model was loaded from, to reload if changed
931 // mod_brush, mod_alias, mod_sprite
933 // memory pool for allocations
935 // all models use textures...
936 rtexturepool_t *texturepool;
937 // EF_* flags (translated from the model file's different flags layout)
939 // number of QC accessible frame(group)s in the model
941 // number of QC accessible skin(group)s in the model
943 // whether to randomize animated framegroups
945 // bounding box at angles '0 0 0'
946 vec3_t normalmins, normalmaxs;
947 // bounding box if yaw angle is not 0, but pitch and roll are
948 vec3_t yawmins, yawmaxs;
949 // bounding box if pitch or roll are used
950 vec3_t rotatedmins, rotatedmaxs;
951 // sphere radius, usable at any angles
953 // squared sphere radius for easier comparisons
955 // skin animation info
956 animscene_t *skinscenes; // [numskins]
957 // skin animation info
958 animscene_t *animscenes; // [numframes]
959 // range of surface numbers in this (sub)model
960 int firstmodelsurface;
961 int nummodelsurfaces;
962 int *sortedmodelsurfaces;
963 // range of collision brush numbers in this (sub)model
966 // BIH (Bounding Interval Hierarchy) for this (sub)model
968 bih_t render_bih; // if not set, use collision_bih instead for rendering purposes too
972 aliastag_t *data_tags;
973 // for skeletal models
975 aliasbone_t *data_bones;
976 float num_posescale; // scaling factor from origin in poses6s format (includes divide by 32767)
977 float num_poseinvscale; // scaling factor to origin in poses6s format (includes multiply by 32767)
979 short *data_poses6s; // origin xyz, quat xyz, w implied negative, unit length, values normalized to +/-32767 range
980 float *data_baseboneposeinverse;
981 // textures of this model
983 int num_texturesperskin;
984 texture_t *data_textures;
985 qboolean wantnormals;
986 qboolean wanttangents;
987 // surfaces of this model
989 msurface_t *data_surfaces;
990 // optional lightmapinfo data for surface lightmap updates
991 msurface_lightmapinfo_t *data_surfaces_lightmapinfo;
992 // all surfaces belong to this mesh
994 // data type of model
995 const char *modeldatatypestring;
996 // generates vertex data for a given frameblend
997 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);
998 // draw the model's sky polygons (only used by brush models)
999 void(*DrawSky)(struct entity_render_s *ent);
1000 // draw refraction/reflection textures for the model's water polygons (only used by brush models)
1001 void(*DrawAddWaterPlanes)(struct entity_render_s *ent);
1002 // draw the model using lightmap/dlight shading
1003 void(*Draw)(struct entity_render_s *ent);
1004 // draw the model to the depth buffer (no color rendering at all)
1005 void(*DrawDepth)(struct entity_render_s *ent);
1006 // draw any enabled debugging effects on this model (such as showing triangles, normals, collision brushes...)
1007 void(*DrawDebug)(struct entity_render_s *ent);
1008 // draw geometry textures for deferred rendering
1009 void(*DrawPrepass)(struct entity_render_s *ent);
1010 // compile an optimized shadowmap mesh for the model based on light source
1011 void(*CompileShadowMap)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1012 // draw depth into a shadowmap
1013 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);
1014 // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
1015 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);
1016 // compile a shadow volume for the model based on light source
1017 void(*CompileShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1018 // draw a shadow volume for the model based on light source
1019 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);
1020 // draw the lighting on a model (through stencil)
1021 void(*DrawLight)(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
1022 // trace a box against this model
1023 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);
1024 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);
1025 // trace a box against this model
1026 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);
1027 // trace a point against this model (like PointSuperContents)
1028 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);
1029 // find the supercontents value at a point in this model
1030 int (*PointSuperContents)(struct model_s *model, int frame, const vec3_t point);
1031 // fields belonging to some types of model
1032 model_sprite_t sprite;
1033 model_brush_t brush;
1034 model_brushq1_t brushq1;
1035 /* MSVC can't handle an empty struct, so this is commented out for now
1036 model_brushq2_t brushq2;
1038 model_brushq3_t brushq3;
1039 // flags this model for offseting sounds to the model center (used by brush models)
1040 int soundfromcenter;
1042 // if set, the model contains light information (lightmap, or vertexlight)
1047 //============================================================================
1050 extern dp_model_t *loadmodel;
1051 extern unsigned char *mod_base;
1052 // sky/water subdivision
1053 //extern cvar_t gl_subdivide_size;
1054 // texture fullbrights
1055 extern cvar_t r_fullbrights;
1057 void Mod_Init (void);
1058 void Mod_Reload (void);
1059 dp_model_t *Mod_LoadModel(dp_model_t *mod, qboolean crash, qboolean checkdisk);
1060 dp_model_t *Mod_FindName (const char *name, const char *parentname);
1061 dp_model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, const char *parentname);
1062 void Mod_UnloadModel (dp_model_t *mod);
1064 void Mod_ClearUsed(void);
1065 void Mod_PurgeUnused(void);
1066 void Mod_RemoveStaleWorldModels(dp_model_t *skip); // only used during loading!
1068 extern dp_model_t *loadmodel;
1069 extern char loadname[32]; // for hunk tags
1071 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
1072 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
1073 void Mod_ValidateElements(int *elements, int numtriangles, int firstvertex, int numverts, const char *filename, int fileline);
1074 void Mod_BuildNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const int *elements, float *normal3f, qboolean areaweighting);
1075 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);
1077 void Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, qboolean lightmapoffsets, qboolean vertexcolors, qboolean neighbors);
1078 void Mod_MakeSortedSurfaces(dp_model_t *mod);
1080 // called specially by brush model loaders before generating submodels
1081 // automatically called after model loader returns
1082 void Mod_BuildVBOs(void);
1084 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);
1085 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
1086 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
1087 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
1088 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);
1089 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);
1090 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, qboolean light, qboolean neighbors, qboolean createvbo);
1091 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
1092 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
1094 void Mod_CreateCollisionMesh(dp_model_t *mod);
1096 void Mod_FreeQ3Shaders(void);
1097 void Mod_LoadQ3Shaders(void);
1098 q3shaderinfo_t *Mod_LookupQ3Shader(const char *name);
1099 qboolean Mod_LoadTextureFromQ3Shader(texture_t *texture, const char *name, qboolean warnmissing, qboolean fallback, int defaulttexflags);
1101 extern cvar_t r_mipskins;
1102 extern cvar_t r_mipnormalmaps;
1104 typedef struct skeleton_s
1106 const dp_model_t *model;
1107 matrix4x4_t *relativetransforms;
1111 typedef struct skinfileitem_s
1113 struct skinfileitem_s *next;
1114 char name[MAX_QPATH];
1115 char replacement[MAX_QPATH];
1119 typedef struct skinfile_s
1121 struct skinfile_s *next;
1122 skinfileitem_t *items;
1126 skinfile_t *Mod_LoadSkinFiles(void);
1127 void Mod_FreeSkinFiles(skinfile_t *skinfile);
1128 int Mod_CountSkinFiles(skinfile_t *skinfile);
1129 void Mod_BuildAliasSkinsFromSkinFiles(texture_t *skin, skinfile_t *skinfile, const char *meshname, const char *shadername);
1131 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
1132 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
1133 void Mod_VertexRangeFromElements(int numelements, const int *elements, int *firstvertexpointer, int *lastvertexpointer);
1135 typedef struct mod_alloclightmap_row_s
1140 mod_alloclightmap_row_t;
1142 typedef struct mod_alloclightmap_state_s
1147 mod_alloclightmap_row_t *rows;
1149 mod_alloclightmap_state_t;
1151 void Mod_AllocLightmap_Init(mod_alloclightmap_state_t *state, int width, int height);
1152 void Mod_AllocLightmap_Free(mod_alloclightmap_state_t *state);
1153 void Mod_AllocLightmap_Reset(mod_alloclightmap_state_t *state);
1154 qboolean Mod_AllocLightmap_Block(mod_alloclightmap_state_t *state, int blockwidth, int blockheight, int *outx, int *outy);
1157 void Mod_BrushInit(void);
1158 // used for talking to the QuakeC mainly
1159 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
1160 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
1162 // a lot of model formats use the Q1BSP code, so here are the prototypes...
1163 struct entity_render_s;
1164 void R_Q1BSP_DrawAddWaterPlanes(struct entity_render_s *ent);
1165 void R_Q1BSP_DrawSky(struct entity_render_s *ent);
1166 void R_Q1BSP_Draw(struct entity_render_s *ent);
1167 void R_Q1BSP_DrawDepth(struct entity_render_s *ent);
1168 void R_Q1BSP_DrawDebug(struct entity_render_s *ent);
1169 void R_Q1BSP_DrawPrepass(struct entity_render_s *ent);
1170 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);
1171 void R_Q1BSP_CompileShadowMap(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1172 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);
1173 void R_Q1BSP_CompileShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1174 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);
1175 void R_Q1BSP_DrawLight(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
1177 // Collision optimization using Bounding Interval Hierarchy
1178 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);
1179 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);
1180 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);
1181 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);
1182 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);
1183 int Mod_CollisionBIH_PointSuperContents_Mesh(struct model_s *model, int frame, const vec3_t point);
1184 bih_t *Mod_MakeCollisionBIH(dp_model_t *model, qboolean userendersurfaces, bih_t *out);
1187 struct frameblend_s;
1189 void Mod_AliasInit(void);
1190 int Mod_Alias_GetTagMatrix(const dp_model_t *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, int tagindex, matrix4x4_t *outmatrix);
1191 int Mod_Alias_GetTagIndexForName(const dp_model_t *model, unsigned int skin, const char *tagname);
1192 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);
1194 void Mod_Skeletal_FreeBuffers(void);
1197 void Mod_SpriteInit(void);
1200 void Mod_Q1BSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1201 void Mod_IBSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1202 void Mod_MAP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1203 void Mod_OBJ_Load(dp_model_t *mod, void *buffer, void *bufferend);
1204 void Mod_IDP0_Load(dp_model_t *mod, void *buffer, void *bufferend);
1205 void Mod_IDP2_Load(dp_model_t *mod, void *buffer, void *bufferend);
1206 void Mod_IDP3_Load(dp_model_t *mod, void *buffer, void *bufferend);
1207 void Mod_ZYMOTICMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1208 void Mod_DARKPLACESMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1209 void Mod_PSKMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1210 void Mod_IDSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1211 void Mod_IDS2_Load(dp_model_t *mod, void *buffer, void *bufferend);
1212 void Mod_INTERQUAKEMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1214 #endif // MODEL_SHARED_H