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
254 #define Q3TEXTUREFLAG_TRANSPARENTSORT 4096
256 #define Q3PATHLENGTH 64
257 #define TEXTURE_MAXFRAMES 64
258 #define Q3WAVEPARMS 4
259 #define Q3DEFORM_MAXPARMS 3
260 #define Q3SHADER_MAXLAYERS 2 // FIXME support more than that (currently only two are used, so why keep more in RAM?)
261 #define Q3RGBGEN_MAXPARMS 3
262 #define Q3ALPHAGEN_MAXPARMS 1
263 #define Q3TCGEN_MAXPARMS 6
264 #define Q3TCMOD_MAXPARMS 6
265 #define Q3MAXTCMODS 8
266 #define Q3MAXDEFORMS 4
268 typedef enum q3wavefunc_e
271 Q3WAVEFUNC_INVERSESAWTOOTH,
280 typedef int q3wavefunc_t;
281 #define Q3WAVEFUNC_USER_COUNT 4
282 #define Q3WAVEFUNC_USER_SHIFT 8 // use 8 bits for wave func type
284 typedef enum q3deform_e
287 Q3DEFORM_PROJECTIONSHADOW,
289 Q3DEFORM_AUTOSPRITE2,
306 typedef enum q3rgbgen_e
311 Q3RGBGEN_EXACTVERTEX,
312 Q3RGBGEN_IDENTITYLIGHTING,
313 Q3RGBGEN_LIGHTINGDIFFUSE,
314 Q3RGBGEN_ONEMINUSENTITY,
315 Q3RGBGEN_ONEMINUSVERTEX,
322 typedef enum q3alphagen_e
327 Q3ALPHAGEN_LIGHTINGSPECULAR,
328 Q3ALPHAGEN_ONEMINUSENTITY,
329 Q3ALPHAGEN_ONEMINUSVERTEX,
337 typedef enum q3tcgen_e
340 Q3TCGEN_TEXTURE, // very common
341 Q3TCGEN_ENVIRONMENT, // common
348 typedef enum q3tcmod_e
351 Q3TCMOD_ENTITYTRANSLATE,
363 typedef struct q3shaderinfo_layer_rgbgen_s
366 float parms[Q3RGBGEN_MAXPARMS];
367 q3wavefunc_t wavefunc;
368 float waveparms[Q3WAVEPARMS];
370 q3shaderinfo_layer_rgbgen_t;
372 typedef struct q3shaderinfo_layer_alphagen_s
374 q3alphagen_t alphagen;
375 float parms[Q3ALPHAGEN_MAXPARMS];
376 q3wavefunc_t wavefunc;
377 float waveparms[Q3WAVEPARMS];
379 q3shaderinfo_layer_alphagen_t;
381 typedef struct q3shaderinfo_layer_tcgen_s
384 float parms[Q3TCGEN_MAXPARMS];
386 q3shaderinfo_layer_tcgen_t;
388 typedef struct q3shaderinfo_layer_tcmod_s
391 float parms[Q3TCMOD_MAXPARMS];
392 q3wavefunc_t wavefunc;
393 float waveparms[Q3WAVEPARMS];
395 q3shaderinfo_layer_tcmod_t;
397 typedef struct q3shaderinfo_layer_s
406 q3shaderinfo_layer_rgbgen_t rgbgen;
407 q3shaderinfo_layer_alphagen_t alphagen;
408 q3shaderinfo_layer_tcgen_t tcgen;
409 q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
411 q3shaderinfo_layer_t;
413 typedef struct q3shaderinfo_deform_s
416 float parms[Q3DEFORM_MAXPARMS];
417 q3wavefunc_t wavefunc;
418 float waveparms[Q3WAVEPARMS];
420 q3shaderinfo_deform_t;
422 typedef enum dpoffsetmapping_technique_s
424 OFFSETMAPPING_OFF, // none
425 OFFSETMAPPING_DEFAULT, // cvar-set
426 OFFSETMAPPING_LINEAR, // linear
427 OFFSETMAPPING_RELIEF // relief
428 }dpoffsetmapping_technique_t;
430 typedef enum dptransparentsort_category_e
433 TRANSPARENTSORT_DISTANCE,
435 }dptransparentsortcategory_t;
437 typedef struct q3shaderinfo_s
439 char name[Q3PATHLENGTH];
440 #define Q3SHADERINFO_COMPARE_START surfaceparms
446 qboolean vertexalpha;
447 qboolean textureblendalpha;
448 int primarylayer, backgroundlayer;
449 q3shaderinfo_layer_t layers[Q3SHADER_MAXLAYERS];
450 char skyboxname[Q3PATHLENGTH];
451 q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
453 // dp-specific additions:
456 qboolean dpnortlight;
460 // add collisions to all triangles of the surface
461 qboolean dpmeshcollisions;
463 // kill shader based on cvar checks
464 qboolean dpshaderkill;
467 char dpreflectcube[Q3PATHLENGTH];
470 float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
471 float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
472 float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
473 vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
474 float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
475 vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
476 float r_water_wateralpha; // additional wateralpha to apply when r_water is active
477 float r_water_waterscroll[2]; // water normalmapscrollblend - scale and speed
480 dpoffsetmapping_technique_t offsetmapping;
482 float offsetbias; // 0 is normal, 1 leads to alpha 0 being neutral and alpha 1 pushing "out"
484 // polygonoffset (only used if Q3TEXTUREFLAG_POLYGONOFFSET)
485 float biaspolygonoffset, biaspolygonfactor;
487 // transparent sort category
488 dptransparentsortcategory_t transparentsort;
491 float specularscalemod;
492 float specularpowermod;
494 // rtlighting ambient addition
495 float rtlightambient;
496 #define Q3SHADERINFO_COMPARE_END rtlightambient
500 typedef enum texturelayertype_e
502 TEXTURELAYERTYPE_INVALID,
503 TEXTURELAYERTYPE_LITTEXTURE,
504 TEXTURELAYERTYPE_TEXTURE,
509 typedef struct texturelayer_s
511 texturelayertype_t type;
516 matrix4x4_t texmatrix;
521 typedef struct texture_s
527 unsigned int width, height;
529 //unsigned int flags;
531 // base material flags
532 int basematerialflags;
533 // current material flags (updated each bmodel render)
534 int currentmaterialflags;
536 // PolygonOffset values for rendering this material
537 // (these are added to the r_refdef values and submodel values)
538 float biaspolygonfactor;
539 float biaspolygonoffset;
541 // textures to use when rendering this material
542 skinframe_t *currentskinframe;
545 skinframe_t *skinframes[TEXTURE_MAXFRAMES];
546 // background layer (for terrain texture blending)
547 skinframe_t *backgroundcurrentskinframe;
548 int backgroundnumskinframes;
549 float backgroundskinframerate;
550 skinframe_t *backgroundskinframes[TEXTURE_MAXFRAMES];
552 // total frames in sequence and alternate sequence
554 // direct pointers to each of the frames in the sequences
555 // (indexed as [alternate][frame])
556 struct texture_s *anim_frames[2][10];
557 // set if animated or there is an alternate frame set
558 // (this is an optimization in the renderer)
561 // renderer checks if this texture needs updating...
562 int update_lastrenderframe;
563 void *update_lastrenderentity;
564 // the current alpha of this texture (may be affected by r_wateralpha)
566 // the current texture frame in animation
567 struct texture_s *currentframe;
568 // current texture transform matrix (used for water scrolling)
569 matrix4x4_t currenttexmatrix;
570 matrix4x4_t currentbackgroundtexmatrix;
572 // various q3 shader features
573 q3shaderinfo_layer_rgbgen_t rgbgen;
574 q3shaderinfo_layer_alphagen_t alphagen;
575 q3shaderinfo_layer_tcgen_t tcgen;
576 q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
577 q3shaderinfo_layer_tcmod_t backgroundtcmods[Q3MAXTCMODS];
578 q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
580 qboolean colormapping;
581 rtexture_t *basetexture; // original texture without pants/shirt/glow
582 rtexture_t *pantstexture; // pants only (in greyscale)
583 rtexture_t *shirttexture; // shirt only (in greyscale)
584 rtexture_t *nmaptexture; // normalmap (bumpmap for dot3)
585 rtexture_t *glosstexture; // glossmap (for dot3)
586 rtexture_t *glowtexture; // glow only (fullbrights)
587 rtexture_t *fogtexture; // alpha of the base texture (if not opaque)
588 rtexture_t *reflectmasktexture; // mask for fake reflections
589 rtexture_t *reflectcubetexture; // fake reflections cubemap
590 rtexture_t *backgroundbasetexture; // original texture without pants/shirt/glow
591 rtexture_t *backgroundnmaptexture; // normalmap (bumpmap for dot3)
592 rtexture_t *backgroundglosstexture; // glossmap (for dot3)
593 rtexture_t *backgroundglowtexture; // glow only (fullbrights)
596 // color tint (colormod * currentalpha) used for rtlighting this material
597 float dlightcolor[3];
598 // color tint (colormod * 2) used for lightmapped lighting on this material
599 // includes alpha as 4th component
600 // replaces role of gl_Color in GLSL shader
601 float lightmapcolor[4];
604 int customblendfunc[2];
606 int currentnumlayers;
607 texturelayer_t currentlayers[16];
616 float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
617 float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
618 float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
619 vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
620 float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
621 vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
622 float r_water_wateralpha; // additional wateralpha to apply when r_water is active
623 float r_water_waterscroll[2]; // scale and speed
624 int camera_entity; // entity number for use by cameras
627 dpoffsetmapping_technique_t offsetmapping;
631 // transparent sort category
632 dptransparentsortcategory_t transparentsort;
635 float specularscalemod;
636 float specularpowermod;
638 // diffuse and ambient
639 float rtlightambient;
643 typedef struct mtexinfo_s
651 typedef struct msurface_lightmapinfo_s
653 // texture mapping properties used by this surface
654 mtexinfo_t *texinfo; // q1bsp
655 // index into r_refdef.scene.lightstylevalue array, 255 means not used (black)
656 unsigned char styles[MAXLIGHTMAPS]; // q1bsp
657 // RGB lighting data [numstyles][height][width][3]
658 unsigned char *samples; // q1bsp
659 // RGB normalmap data [numstyles][height][width][3]
660 unsigned char *nmapsamples; // q1bsp
661 // stain to apply on lightmap (soot/dirt/blood/whatever)
662 unsigned char *stainsamples; // q1bsp
663 int texturemins[2]; // q1bsp
664 int extents[2]; // q1bsp
665 int lightmaporigin[2]; // q1bsp
667 msurface_lightmapinfo_t;
670 typedef struct msurface_s
672 // bounding box for onscreen checks
675 // the texture to use on the surface
677 // the lightmap texture fragment to use on the rendering mesh
678 rtexture_t *lightmaptexture;
679 // the lighting direction texture fragment to use on the rendering mesh
680 rtexture_t *deluxemaptexture;
681 // lightmaptexture rebuild information not used in q3bsp
682 msurface_lightmapinfo_t *lightmapinfo; // q1bsp
683 // fog volume info in q3bsp
684 struct q3deffect_s *effect; // q3bsp
685 // mesh information for collisions (only used by q3bsp curves)
686 int num_firstcollisiontriangle;
687 int *deprecatedq3data_collisionelement3i; // q3bsp
688 float *deprecatedq3data_collisionvertex3f; // q3bsp
689 float *deprecatedq3data_collisionbbox6f; // collision optimization - contains combined bboxes of every data_collisionstride triangles
690 float *deprecatedq3data_bbox6f; // collision optimization - contains combined bboxes of every data_collisionstride triangles
692 // surfaces own ranges of vertices and triangles in the model->surfmesh
693 int num_triangles; // number of triangles
694 int num_firsttriangle; // first triangle
695 int num_vertices; // number of vertices
696 int num_firstvertex; // first vertex
698 // shadow volume building information
699 int num_firstshadowmeshtriangle; // index into model->brush.shadowmesh
701 // mesh information for collisions (only used by q3bsp curves)
702 int num_collisiontriangles; // q3bsp
703 int num_collisionvertices; // q3bsp
704 int deprecatedq3num_collisionbboxstride;
705 int deprecatedq3num_bboxstride;
706 // FIXME: collisionmarkframe should be kept in a separate array
707 int deprecatedq3collisionmarkframe; // q3bsp // don't collide twice in one trace
711 #include "matrixlib.h"
714 #include "model_brush.h"
715 #include "model_sprite.h"
716 #include "model_alias.h"
718 typedef struct model_sprite_s
721 mspriteframe_t *sprdata_frames;
727 typedef struct model_brush_lightstyleinfo_s
734 model_brush_lightstyleinfo_t;
736 typedef struct model_brush_s
738 // true if this model is a HalfLife .bsp file
740 // true if this model is a BSP2 .bsp file (expanded 32bit bsp format for DarkPlaces, RMQ, others?)
742 // string of entity definitions (.map format)
745 // if not NULL this is a submodel
746 struct model_s *parentmodel;
747 // (this is the number of the submodel, an index into submodels)
750 // number of submodels in this map (just used by server to know how many
751 // submodels to load)
753 // pointers to each of the submodels
754 struct model_s **submodels;
757 mplane_t *data_planes;
762 // visible leafs, not counting 0 (solid)
764 // number of actual leafs (including 0 which is solid)
769 int *data_leafbrushes;
771 int num_leafsurfaces;
772 int *data_leafsurfaces;
775 mportal_t *data_portals;
777 int num_portalpoints;
778 mvertex_t *data_portalpoints;
781 q3mbrush_t *data_brushes;
784 q3mbrushside_t *data_brushsides;
788 int num_pvsclusterbytes;
789 unsigned char *data_pvsclusters;
791 //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
792 //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
794 // collision geometry for q3 curves
795 int num_collisionvertices;
796 int num_collisiontriangles;
797 float *data_collisionvertex3f;
798 int *data_collisionelement3i;
800 // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
801 shadowmesh_t *shadowmesh;
803 // a mesh containing all SUPERCONTENTS_SOLID surfaces for this model or submodel, for physics engines to use
804 shadowmesh_t *collisionmesh;
807 int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
808 int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
809 unsigned char *(*GetPVS)(struct model_s *model, const vec3_t p);
810 int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, unsigned char *pvsbuffer, int pvsbufferlength, qboolean merge);
811 int (*BoxTouchingPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
812 int (*BoxTouchingLeafPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
813 int (*BoxTouchingVisibleLeafs)(struct model_s *model, const unsigned char *visibleleafs, const vec3_t mins, const vec3_t maxs);
814 int (*FindBoxClusters)(struct model_s *model, const vec3_t mins, const vec3_t maxs, int maxclusters, int *clusterlist);
815 void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
816 void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
817 mleaf_t *(*PointInLeaf)(struct model_s *model, const vec3_t p);
818 // these are actually only found on brushq1, but NULL is handled gracefully
819 void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, unsigned char *out, int outsize);
820 void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
821 // trace a line of sight through this model (returns false if the line if sight is definitely blocked)
822 qboolean (*TraceLineOfSight)(struct model_s *model, const vec3_t start, const vec3_t end);
824 char skybox[MAX_QPATH];
826 skinframe_t *solidskyskinframe;
827 skinframe_t *alphaskyskinframe;
829 qboolean supportwateralpha;
837 typedef struct model_brushq1_s
854 mclipnode_t *clipnodes;
856 hull_t hulls[MAX_MAP_HULLS];
858 int num_compressedpvs;
859 unsigned char *data_compressedpvs;
862 unsigned char *lightdata;
863 unsigned char *nmaplightdata; // deluxemap file
865 // lightmap update chains for light styles
867 model_brush_lightstyleinfo_t *data_lightstyleinfo;
869 // this contains bytes that are 1 if a surface needs its lightmap rebuilt
870 unsigned char *lightmapupdateflags;
871 qboolean firstrender; // causes all surface lightmaps to be loaded in first frame
875 /* MSVC can't compile empty structs, so this is commented out for now
876 typedef struct model_brushq2_s
882 typedef struct model_brushq3_s
885 q3dmodel_t *data_models;
887 // used only during loading - freed after loading!
889 float *data_vertex3f;
890 float *data_normal3f;
891 float *data_texcoordtexture2f;
892 float *data_texcoordlightmap2f;
895 // freed after loading!
900 q3deffect_t *data_effects;
903 int num_originallightmaps;
904 int num_mergedlightmaps;
905 int num_lightmapmergedwidthpower;
906 int num_lightmapmergedheightpower;
907 int num_lightmapmergedwidthheightdeluxepower;
908 int num_lightmapmerge;
909 rtexture_t **data_lightmaps;
910 rtexture_t **data_deluxemaps;
912 // voxel light data with directional shading
914 q3dlightgrid_t *data_lightgrid;
915 // size of each cell (may vary by map, typically 64 64 128)
916 float num_lightgrid_cellsize[3];
917 // 1.0 / num_lightgrid_cellsize
918 float num_lightgrid_scale[3];
919 // dimensions of the world model in lightgrid cells
920 int num_lightgrid_imins[3];
921 int num_lightgrid_imaxs[3];
922 int num_lightgrid_isize[3];
923 // transform modelspace coordinates to lightgrid index
924 matrix4x4_t num_lightgrid_indexfromworld;
926 // true if this q3bsp file has been detected as using deluxemapping
927 // (lightmap texture pairs, every odd one is never directly refernced,
928 // and contains lighting normals, not colors)
929 qboolean deluxemapping;
930 // true if the detected deluxemaps are the modelspace kind, rather than
931 // the faster tangentspace kind
932 qboolean deluxemapping_modelspace;
933 // size of lightmaps (128 by default, but may be another poweroftwo if
934 // external lightmaps are used (q3map2 -lightmapsize)
942 typedef struct model_s
944 // name and path of model, for example "progs/player.mdl"
945 char name[MAX_QPATH];
946 // model needs to be loaded if this is false
948 // set if the model is used in current map, models which are not, are purged
950 // CRC of the file this model was loaded from, to reload if changed
952 // mod_brush, mod_alias, mod_sprite
954 // memory pool for allocations
956 // all models use textures...
957 rtexturepool_t *texturepool;
958 // EF_* flags (translated from the model file's different flags layout)
960 // number of QC accessible frame(group)s in the model
962 // number of QC accessible skin(group)s in the model
964 // whether to randomize animated framegroups
966 // bounding box at angles '0 0 0'
967 vec3_t normalmins, normalmaxs;
968 // bounding box if yaw angle is not 0, but pitch and roll are
969 vec3_t yawmins, yawmaxs;
970 // bounding box if pitch or roll are used
971 vec3_t rotatedmins, rotatedmaxs;
972 // sphere radius, usable at any angles
974 // squared sphere radius for easier comparisons
976 // skin animation info
977 animscene_t *skinscenes; // [numskins]
978 // skin animation info
979 animscene_t *animscenes; // [numframes]
980 // range of surface numbers in this (sub)model
981 int firstmodelsurface;
982 int nummodelsurfaces;
983 int *sortedmodelsurfaces;
984 // range of collision brush numbers in this (sub)model
987 // BIH (Bounding Interval Hierarchy) for this (sub)model
989 bih_t render_bih; // if not set, use collision_bih instead for rendering purposes too
993 aliastag_t *data_tags;
994 // for skeletal models
996 aliasbone_t *data_bones;
997 float num_posescale; // scaling factor from origin in poses7s format (includes divide by 32767)
998 float num_poseinvscale; // scaling factor to origin in poses7s format (includes multiply by 32767)
1000 short *data_poses7s; // origin xyz, quat xyzw, unit length, values normalized to +/-32767 range
1001 float *data_baseboneposeinverse;
1002 // textures of this model
1004 int num_texturesperskin;
1005 texture_t *data_textures;
1006 qboolean wantnormals;
1007 qboolean wanttangents;
1008 // surfaces of this model
1010 msurface_t *data_surfaces;
1011 // optional lightmapinfo data for surface lightmap updates
1012 msurface_lightmapinfo_t *data_surfaces_lightmapinfo;
1013 // all surfaces belong to this mesh
1014 surfmesh_t surfmesh;
1015 // data type of model
1016 const char *modeldatatypestring;
1017 // generates vertex data for a given frameblend
1018 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);
1019 // draw the model's sky polygons (only used by brush models)
1020 void(*DrawSky)(struct entity_render_s *ent);
1021 // draw refraction/reflection textures for the model's water polygons (only used by brush models)
1022 void(*DrawAddWaterPlanes)(struct entity_render_s *ent);
1023 // draw the model using lightmap/dlight shading
1024 void(*Draw)(struct entity_render_s *ent);
1025 // draw the model to the depth buffer (no color rendering at all)
1026 void(*DrawDepth)(struct entity_render_s *ent);
1027 // draw any enabled debugging effects on this model (such as showing triangles, normals, collision brushes...)
1028 void(*DrawDebug)(struct entity_render_s *ent);
1029 // draw geometry textures for deferred rendering
1030 void(*DrawPrepass)(struct entity_render_s *ent);
1031 // compile an optimized shadowmap mesh for the model based on light source
1032 void(*CompileShadowMap)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1033 // draw depth into a shadowmap
1034 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);
1035 // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
1036 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);
1037 // compile a shadow volume for the model based on light source
1038 void(*CompileShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1039 // draw a shadow volume for the model based on light source
1040 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);
1041 // draw the lighting on a model (through stencil)
1042 void(*DrawLight)(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
1043 // trace a box against this model
1044 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);
1045 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);
1046 // trace a box against this model
1047 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);
1048 // trace a point against this model (like PointSuperContents)
1049 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);
1050 // find the supercontents value at a point in this model
1051 int (*PointSuperContents)(struct model_s *model, int frame, const vec3_t point);
1052 // trace a line against geometry in this model and report correct texture (used by r_shadow_bouncegrid)
1053 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);
1054 // fields belonging to some types of model
1055 model_sprite_t sprite;
1056 model_brush_t brush;
1057 model_brushq1_t brushq1;
1058 /* MSVC can't handle an empty struct, so this is commented out for now
1059 model_brushq2_t brushq2;
1061 model_brushq3_t brushq3;
1062 // flags this model for offseting sounds to the model center (used by brush models)
1063 int soundfromcenter;
1065 // if set, the model contains light information (lightmap, or vertexlight)
1067 float lightmapscale;
1071 //============================================================================
1074 extern dp_model_t *loadmodel;
1075 extern unsigned char *mod_base;
1076 // sky/water subdivision
1077 //extern cvar_t gl_subdivide_size;
1078 // texture fullbrights
1079 extern cvar_t r_fullbrights;
1080 extern cvar_t r_enableshadowvolumes;
1082 void Mod_Init (void);
1083 void Mod_Reload (void);
1084 dp_model_t *Mod_LoadModel(dp_model_t *mod, qboolean crash, qboolean checkdisk);
1085 dp_model_t *Mod_FindName (const char *name, const char *parentname);
1086 dp_model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, const char *parentname);
1087 void Mod_UnloadModel (dp_model_t *mod);
1089 void Mod_ClearUsed(void);
1090 void Mod_PurgeUnused(void);
1091 void Mod_RemoveStaleWorldModels(dp_model_t *skip); // only used during loading!
1093 extern dp_model_t *loadmodel;
1094 extern char loadname[32]; // for hunk tags
1096 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
1097 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
1098 void Mod_ValidateElements(int *elements, int numtriangles, int firstvertex, int numverts, const char *filename, int fileline);
1099 void Mod_BuildNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const int *elements, float *normal3f, qboolean areaweighting);
1100 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);
1102 void Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, qboolean lightmapoffsets, qboolean vertexcolors, qboolean neighbors);
1103 void Mod_MakeSortedSurfaces(dp_model_t *mod);
1105 // called specially by brush model loaders before generating submodels
1106 // automatically called after model loader returns
1107 void Mod_BuildVBOs(void);
1109 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);
1110 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
1111 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
1112 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
1113 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);
1114 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);
1115 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, qboolean light, qboolean neighbors, qboolean createvbo);
1116 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
1117 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
1119 void Mod_CreateCollisionMesh(dp_model_t *mod);
1121 void Mod_FreeQ3Shaders(void);
1122 void Mod_LoadQ3Shaders(void);
1123 q3shaderinfo_t *Mod_LookupQ3Shader(const char *name);
1124 qboolean Mod_LoadTextureFromQ3Shader(texture_t *texture, const char *name, qboolean warnmissing, qboolean fallback, int defaulttexflags);
1126 extern cvar_t r_mipskins;
1127 extern cvar_t r_mipnormalmaps;
1129 typedef struct skinfileitem_s
1131 struct skinfileitem_s *next;
1132 char name[MAX_QPATH];
1133 char replacement[MAX_QPATH];
1137 typedef struct skinfile_s
1139 struct skinfile_s *next;
1140 skinfileitem_t *items;
1144 skinfile_t *Mod_LoadSkinFiles(void);
1145 void Mod_FreeSkinFiles(skinfile_t *skinfile);
1146 int Mod_CountSkinFiles(skinfile_t *skinfile);
1147 void Mod_BuildAliasSkinsFromSkinFiles(texture_t *skin, skinfile_t *skinfile, const char *meshname, const char *shadername);
1149 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
1150 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
1151 void Mod_VertexRangeFromElements(int numelements, const int *elements, int *firstvertexpointer, int *lastvertexpointer);
1153 typedef struct mod_alloclightmap_row_s
1158 mod_alloclightmap_row_t;
1160 typedef struct mod_alloclightmap_state_s
1165 mod_alloclightmap_row_t *rows;
1167 mod_alloclightmap_state_t;
1169 void Mod_AllocLightmap_Init(mod_alloclightmap_state_t *state, int width, int height);
1170 void Mod_AllocLightmap_Free(mod_alloclightmap_state_t *state);
1171 void Mod_AllocLightmap_Reset(mod_alloclightmap_state_t *state);
1172 qboolean Mod_AllocLightmap_Block(mod_alloclightmap_state_t *state, int blockwidth, int blockheight, int *outx, int *outy);
1175 void Mod_BrushInit(void);
1176 // used for talking to the QuakeC mainly
1177 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
1178 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
1180 // a lot of model formats use the Q1BSP code, so here are the prototypes...
1181 struct entity_render_s;
1182 void R_Q1BSP_DrawAddWaterPlanes(struct entity_render_s *ent);
1183 void R_Q1BSP_DrawSky(struct entity_render_s *ent);
1184 void R_Q1BSP_Draw(struct entity_render_s *ent);
1185 void R_Q1BSP_DrawDepth(struct entity_render_s *ent);
1186 void R_Q1BSP_DrawDebug(struct entity_render_s *ent);
1187 void R_Q1BSP_DrawPrepass(struct entity_render_s *ent);
1188 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);
1189 void R_Q1BSP_CompileShadowMap(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1190 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);
1191 void R_Q1BSP_CompileShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1192 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);
1193 void R_Q1BSP_DrawLight(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
1195 // Collision optimization using Bounding Interval Hierarchy
1196 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);
1197 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);
1198 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);
1199 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);
1200 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);
1201 int Mod_CollisionBIH_PointSuperContents_Mesh(struct model_s *model, int frame, const vec3_t point);
1202 bih_t *Mod_MakeCollisionBIH(dp_model_t *model, qboolean userendersurfaces, bih_t *out);
1205 struct frameblend_s;
1207 void Mod_AliasInit(void);
1208 int Mod_Alias_GetTagMatrix(const dp_model_t *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, int tagindex, matrix4x4_t *outmatrix);
1209 int Mod_Alias_GetTagIndexForName(const dp_model_t *model, unsigned int skin, const char *tagname);
1210 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);
1212 void Mod_Skeletal_FreeBuffers(void);
1215 void Mod_SpriteInit(void);
1218 void Mod_Q1BSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1219 void Mod_IBSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1220 void Mod_MAP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1221 void Mod_OBJ_Load(dp_model_t *mod, void *buffer, void *bufferend);
1222 void Mod_IDP0_Load(dp_model_t *mod, void *buffer, void *bufferend);
1223 void Mod_IDP2_Load(dp_model_t *mod, void *buffer, void *bufferend);
1224 void Mod_IDP3_Load(dp_model_t *mod, void *buffer, void *bufferend);
1225 void Mod_ZYMOTICMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1226 void Mod_DARKPLACESMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1227 void Mod_PSKMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1228 void Mod_IDSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1229 void Mod_IDS2_Load(dp_model_t *mod, void *buffer, void *bufferend);
1230 void Mod_INTERQUAKEMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1232 #endif // MODEL_SHARED_H