added Nexiuz TE_ effects (prefixed TE_TEI_) and Nexiuz plasma trail (an override...
[xonotic/darkplaces.git] / model_shared.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20
21 #ifndef __MODEL__
22 #define __MODEL__
23
24 #ifndef SYNCTYPE_T
25 #define SYNCTYPE_T
26 typedef enum {ST_SYNC=0, ST_RAND } synctype_t;
27 #endif
28
29 /*
30
31 d*_t structures are on-disk representations
32 m*_t structures are in-memory
33
34 */
35
36 typedef enum {mod_invalid, mod_brush, mod_sprite, mod_alias} modtype_t;
37
38 typedef struct animscene_s
39 {
40         char name[32]; // for viewthing support
41         int firstframe;
42         int framecount;
43         int loop; // true or false
44         float framerate;
45 }
46 animscene_t;
47
48 typedef struct skinframe_s
49 {
50         rtexture_t *base; // original texture minus pants/shirt/glow
51         rtexture_t *pants; // pants only (in greyscale)
52         rtexture_t *shirt; // shirt only (in greyscale)
53         rtexture_t *glow; // glow only
54         rtexture_t *merged; // original texture minus glow
55         rtexture_t *fog; // white texture with alpha of the base texture, NULL if not transparent
56         rtexture_t *nmap; // normalmap (bumpmap for dot3)
57         rtexture_t *gloss; // glossmap (for dot3)
58 }
59 skinframe_t;
60
61 #define MAX_SKINS 256
62
63 #define SHADOWMESHVERTEXHASH 1024
64 typedef struct shadowmeshvertexhash_s
65 {
66         struct shadowmeshvertexhash_s *next;
67 }
68 shadowmeshvertexhash_t;
69
70 typedef struct shadowmesh_s
71 {
72         struct shadowmesh_s *next;
73         int numverts, maxverts;
74         int numtriangles, maxtriangles;
75         float *verts;
76         int *elements;
77         int *neighbors;
78         // these are NULL after Mod_ShadowMesh_Finish is performed, only used
79         // while building meshes
80         shadowmeshvertexhash_t **vertexhashtable, *vertexhashentries;
81 }
82 shadowmesh_t;
83
84
85 #include "model_brush.h"
86 #include "model_sprite.h"
87 #include "model_alias.h"
88
89 typedef struct model_s
90 {
91         char                    name[MAX_QPATH];
92         // model needs to be loaded if this is true
93         qboolean                needload;
94         // set if the model is used in current map, models which are not, are purged
95         qboolean                used;
96         // CRC of the file this model was loaded from, to reload if changed
97         qboolean                crc;
98         // true if this is the world model (I.E. defines what sky to use, and may contain submodels)
99         qboolean                isworldmodel;
100         // true if this model is a HalfLife .bsp file
101         qboolean                ishlbsp;
102         // true if this model was not successfully loaded and should be purged
103         qboolean                error;
104
105         // mod_brush, mod_alias, mod_sprite
106         modtype_t               type;
107         // LordHavoc: Q2/ZYM model support
108         int                             aliastype;
109         // LordHavoc: if true (normally only for sprites) the model/sprite/bmodel is always rendered fullbright
110         int                             fullbright;
111         // number of QC accessable frame(group)s in the model
112         int                             numframes;
113         // whether to randomize animated framegroups
114         synctype_t              synctype;
115
116         // used for sprites and models
117         int                             numtris;
118         // used for models
119         int                             numskins;
120         // used by models
121         int                             numverts;
122
123         // flags from the model file
124         int                             flags;
125         // engine calculated flags, ones that can not be set in the file
126         int                             flags2;
127
128         // all models use textures...
129         rtexturepool_t  *texturepool;
130
131         // volume occupied by the model
132         // bounding box at angles '0 0 0'
133         vec3_t                  normalmins, normalmaxs;
134         // bounding box if yaw angle is not 0, but pitch and roll are
135         vec3_t                  yawmins, yawmaxs;
136         // bounding box if pitch or roll are used
137         vec3_t                  rotatedmins, rotatedmaxs;
138         // sphere radius, usable at any angles
139         float                   radius;
140         // squared sphere radius for easier comparisons
141         float                   radius2;
142
143         // brush model specific
144         int                             firstmodelsurface, nummodelsurfaces;
145
146         // lightmap format, set to r_lightmaprgba when model is loaded
147         int                             lightmaprgba;
148
149         int                             numsubmodels;
150         dmodel_t                *submodels;
151
152         int                             numplanes;
153         mplane_t                *planes;
154
155         // number of visible leafs, not counting 0 (solid)
156         int                             numleafs;
157         mleaf_t                 *leafs;
158
159         int                             numvertexes;
160         mvertex_t               *vertexes;
161
162         int                             numedges;
163         medge_t                 *edges;
164
165         int                             numnodes;
166         mnode_t                 *nodes;
167
168         int                             numtexinfo;
169         mtexinfo_t              *texinfo;
170
171         int                             numsurfaces;
172         msurface_t              *surfaces;
173         int                             *surfacevisframes;
174         int                             *surfacepvsframes;
175         msurface_t              *surfacepvsnext;
176
177         int                             numsurfedges;
178         int                             *surfedges;
179
180         int                             numclipnodes;
181         dclipnode_t             *clipnodes;
182
183         int                             nummarksurfaces;
184         int                             *marksurfaces;
185
186         hull_t                  hulls[MAX_MAP_HULLS];
187
188         int                             numtextures;
189         texture_t               *textures;
190
191         msurface_t              **texturesurfacechains;
192
193         qbyte                   *visdata;
194         qbyte                   *lightdata;
195         char                    *entities;
196
197         int                             numportals;
198         mportal_t               *portals;
199
200         int                             numportalpoints;
201         mvertex_t               *portalpoints;
202
203         int                             numlights;
204         mlight_t                *lights;
205
206         // used only for casting dynamic shadow volumes
207         shadowmesh_t    *shadowmesh;
208         vec3_t                  shadowmesh_mins, shadowmesh_maxs, shadowmesh_center;
209         float                   shadowmesh_radius;
210
211         // pvs visibility marking
212         mleaf_t                 *pvsviewleaf;
213         int                             pvsviewleafnovis;
214         int                             pvsframecount;
215         mleaf_t                 *pvsleafchain;
216         int                             *pvssurflist;
217         int                             pvssurflistlength;
218
219         // skin animation info
220         animscene_t             *skinscenes; // [numskins]
221         // skin frame info
222         skinframe_t             *skinframes;
223
224         animscene_t             *animscenes; // [numframes]
225
226         // Q1 and Q2 models are the same after loading
227         int                             *mdlmd2data_indices;
228         float                   *mdlmd2data_texcoords;
229         md2frame_t              *mdlmd2data_frames;
230         trivertx_t              *mdlmd2data_pose;
231         int                             *mdlmd2data_triangleneighbors;
232
233         // for Zymotic models
234         int                             zymnum_verts;
235         int                             zymnum_tris;
236         int                             zymnum_shaders;
237         int                             zymnum_bones;
238         int                             zymnum_scenes;
239         float                   *zymdata_texcoords;
240         rtexture_t              **zymdata_textures;
241         qbyte                   *zymdata_trizone;
242         zymbone_t               *zymdata_bones;
243         unsigned int    *zymdata_vertbonecounts;
244         zymvertex_t             *zymdata_verts;
245         unsigned int    *zymdata_renderlist;
246         float                   *zymdata_poses;
247
248         int                             sprnum_type;
249         mspriteframe_t  *sprdata_frames;
250
251
252         // functions used in both rendering modes
253         // draw the model's sky polygons (only used by brush models)
254         void(*DrawSky)(struct entity_render_s *ent);
255
256         // functions used only in normal rendering mode
257         // draw the model
258         void(*Draw)(struct entity_render_s *ent);
259         // draw a fake shadow for the model
260         void(*DrawFakeShadow)(struct entity_render_s *ent);
261
262         // functions used only in shadow volume rendering mode
263         // draw a shadow volume for the model based on light source
264         void(*DrawShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius);
265         // draw the lighting on a model (through stencil)
266         void(*DrawLight)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativeeyeorigin, float lightradius, float *lightcolor);
267
268         // memory pool for allocations
269         mempool_t               *mempool;
270 }
271 model_t;
272
273 //============================================================================
274
275 // this can be used for anything without a valid texture
276 extern rtexture_t *r_notexture;
277 // every texture must be in a pool...
278 extern rtexturepool_t *r_notexturepool;
279
280 // model loading
281 extern model_t *loadmodel;
282 extern qbyte *mod_base;
283 // sky/water subdivision
284 //extern cvar_t gl_subdivide_size;
285 // texture fullbrights
286 extern cvar_t r_fullbrights;
287
288 void Mod_Init (void);
289 void Mod_CheckLoaded (model_t *mod);
290 void Mod_ClearAll (void);
291 void Mod_ClearErrorModels (void);
292 model_t *Mod_FindName (const char *name);
293 model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, qboolean isworldmodel);
294 void Mod_TouchModel (const char *name);
295 void Mod_UnloadModel (model_t *mod);
296
297 void Mod_ClearUsed(void);
298 void Mod_PurgeUnused(void);
299 void Mod_LoadModels(void);
300
301 extern model_t *loadmodel;
302 extern char loadname[32];       // for hunk tags
303
304 int Mod_FindTriangleWithEdge(const int *elements, int numtriangles, int start, int end);
305 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
306 void Mod_ValidateElements(const int *elements, int numtriangles, int numverts, const char *filename, int fileline);
307 void Mod_BuildTextureVectorsAndNormals(int numverts, int numtriangles, const float *vertex, const float *texcoord, const int *elements, float *svectors, float *tvectors, float *normals);
308
309 shadowmesh_t *Mod_ShadowMesh_Alloc(mempool_t *mempool, int maxverts);
310 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh);
311 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *v);
312 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, float *vert0, float *vert1, float *vert2);
313 void Mod_ShadowMesh_AddPolygon(mempool_t *mempool, shadowmesh_t *mesh, int numverts, float *verts);
314 void Mod_ShadowMesh_AddMesh(mempool_t *mempool, shadowmesh_t *mesh, int numverts, float *verts, int numtris, int *elements);
315 shadowmesh_t *Mod_ShadowMesh_Begin(mempool_t *mempool, int initialnumtriangles);
316 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh);
317 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
318 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
319
320 #endif  // __MODEL__
321