unified model skinframe loaders used for mdl, md2, md3, and bsp textures (both extern...
[divverent/darkplaces.git] / model_brush.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_BRUSH_H
22 #define MODEL_BRUSH_H
23
24 /*
25 ==============================================================================
26
27 BRUSH MODELS
28
29 ==============================================================================
30 */
31
32
33 //
34 // in memory representation
35 //
36 typedef struct
37 {
38         vec3_t position;
39 }
40 mvertex_t;
41
42 #define SIDE_FRONT 0
43 #define SIDE_BACK 1
44 #define SIDE_ON 2
45
46
47 // plane_t structure
48 typedef struct mplane_s
49 {
50         vec3_t normal;
51         float dist;
52         // for texture axis selection and fast side tests
53         int type;
54         int signbits;
55 }
56 mplane_t;
57
58 #define SHADERSTAGE_SKY 0
59 #define SHADERSTAGE_NORMAL 1
60 #define SHADERSTAGE_COUNT 2
61
62 #define SHADERFLAGS_NEEDLIGHTMAP 1
63
64 #define SURF_PLANEBACK 2
65 #define SURF_DRAWSKY 4
66 #define SURF_DRAWTURB 0x10
67 #define SURF_LIGHTMAP 0x20
68 #define SURF_DRAWNOALPHA 0x100
69 #define SURF_DRAWFULLBRIGHT 0x200
70 #define SURF_LIGHTBOTHSIDES 0x400
71 #define SURF_SHADOWCAST 0x1000 // this polygon can cast stencil shadows
72 #define SURF_SHADOWLIGHT 0x2000 // this polygon can be lit by stencil shadowing
73 #define SURF_WATERALPHA 0x4000 // this polygon's alpha is modulated by r_wateralpha
74
75 #define SURFRENDER_OPAQUE 0
76 #define SURFRENDER_ALPHA 1
77 #define SURFRENDER_ADD 2
78
79 struct entity_render_s;
80 struct texture_s;
81 struct msurface_s;
82 // change this stuff when real shaders are added
83 typedef struct Cshader_s
84 {
85         void (*shaderfunc[SHADERSTAGE_COUNT])(const struct entity_render_s *ent, const struct texture_s *texture, struct msurface_s **surfchain);
86         int flags;
87 }
88 Cshader_t;
89
90 extern Cshader_t Cshader_wall_lightmap;
91 extern Cshader_t Cshader_water;
92 extern Cshader_t Cshader_sky;
93
94 typedef struct texture_s
95 {
96         // name
97         char name[16];
98         // size
99         unsigned int width, height;
100         // SURF_ flags
101         unsigned int flags;
102
103         // position in the model's textures array
104         int number;
105
106         // type of rendering (SURFRENDER_ value)
107         int rendertype;
108
109         // loaded the same as model skins
110         skinframe_t skin;
111
112         // shader to use for this texture
113         Cshader_t *shader;
114
115         // total frames in sequence and alternate sequence
116         int anim_total[2];
117         // direct pointers to each of the frames in the sequences
118         // (indexed as [alternate][frame])
119         struct texture_s *anim_frames[2][10];
120         // set if animated or there is an alternate frame set
121         // (this is an optimization in the renderer)
122         int animated;
123         // the current texture frame in animation
124         struct texture_s *currentframe;
125         // current alpha of the texture
126         float currentalpha;
127 }
128 texture_t;
129
130 typedef struct
131 {
132         unsigned short v[2];
133 }
134 medge_t;
135
136 typedef struct
137 {
138         float vecs[2][4];
139         texture_t *texture;
140         int flags;
141 }
142 mtexinfo_t;
143
144 // LordHavoc: replaces glpoly, triangle mesh
145 typedef struct surfmesh_s
146 {
147         // can be multiple meshs per surface
148         struct surfmesh_s *chain;
149         int numverts; // number of vertices in the mesh
150         int numtriangles; // number of triangles in the mesh
151         float *verts; // float[verts*4] vertex locations
152         float *svectors; // float[verts*4] direction of 'S' (right) texture axis for each vertex
153         float *tvectors; // float[verts*4] direction of 'T' (down) texture axis for each vertex
154         float *normals; // float[verts*4] direction of 'R' (out) texture axis for each vertex
155         int *lightmapoffsets; // index into surface's lightmap samples for vertex lighting
156         float *str; // float[verts*4] texcoords for surface texture
157         float *uvw; // float[verts*4] texcoords for lightmap texture
158         float *abc; // float[verts*4] texcoords for detail texture
159         int *index; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
160         int *triangleneighbors; // int[tris*3] neighboring triangle on each edge (-1 if none)
161 }
162 surfmesh_t;
163
164 typedef struct msurface_s
165 {
166         // bounding box for onscreen checks
167         vec3_t poly_mins;
168         vec3_t poly_maxs;
169
170         // the node plane this is on, backwards if SURF_PLANEBACK flag set
171         mplane_t *plane;
172         // SURF_ flags
173         int flags;
174         // texture mapping properties used by this surface
175         mtexinfo_t *texinfo;
176
177         // the lightmap texture fragment to use on the rendering mesh
178         rtexture_t *lightmaptexture;
179         // mesh for rendering
180         surfmesh_t *mesh;
181         // if lightmap settings changed, this forces update
182         int cached_dlight;
183
184         // should be drawn if visframe == r_framecount (set by PrepareSurfaces)
185         int visframe;
186         // should be drawn if onscreen and not a backface (used for setting visframe)
187         //int pvsframe;
188         // chain of surfaces marked visible by pvs
189         //struct msurface_s *pvschain;
190
191         // surface number, to avoid having to do a divide to find the number of a surface from it's address
192         int number;
193
194         // center for sorting transparent meshes
195         vec3_t poly_center;
196
197         // index into d_lightstylevalue array, 255 means not used (black)
198         qbyte styles[MAXLIGHTMAPS];
199         // RGB lighting data [numstyles][height][width][3]
200         qbyte *samples;
201         // stain to apply on lightmap (soot/dirt/blood/whatever)
202         qbyte *stainsamples;
203         // the stride when building lightmaps to comply with fragment update
204         int lightmaptexturestride;
205         int texturemins[2];
206         int extents[2];
207
208         // if this == r_framecount there are dynamic lights on the surface
209         int dlightframe;
210         // which dynamic lights are touching this surface
211         // (only access this if dlightframe is current)
212         int dlightbits[8];
213         // avoid redundent addition of dlights
214         int lightframe;
215
216         // these are just 3D points defining the outline of the polygon,
217         // no texcoord info (that can be generated from these)
218         int poly_numverts;
219         float *poly_verts;
220
221         // neighboring surfaces (one per poly_numverts)
222         //struct msurface_s **neighborsurfaces;
223         // currently used only for generating static shadow volumes
224         int castshadow;
225 }
226 msurface_t;
227
228 typedef struct mnode_s
229 {
230 // common with leaf
231         // always 0 in nodes
232         int contents;
233
234         struct mnode_s *parent;
235         struct mportal_s *portals;
236
237         // for bounding box culling
238         vec3_t mins;
239         vec3_t maxs;
240
241 // node specific
242         mplane_t *plane;
243         struct mnode_s *children[2];
244
245         unsigned short firstsurface;
246         unsigned short numsurfaces;
247 }
248 mnode_t;
249
250 typedef struct mleaf_s
251 {
252 // common with node
253         // always negative in leafs
254         int contents;
255
256         struct mnode_s *parent;
257         struct mportal_s *portals;
258
259         // for bounding box culling
260         vec3_t mins;
261         vec3_t maxs;
262
263 // leaf specific
264         // next leaf in pvschain
265         struct mleaf_s *pvschain;
266         // potentially visible if current (model->pvsframecount)
267         int pvsframe;
268         // visible if marked current (r_framecount)
269         int visframe;
270         // used by certain worldnode variants to avoid processing the same leaf twice in a frame
271         int worldnodeframe;
272         // used by polygon-through-portals visibility checker
273         int portalmarkid;
274
275         qbyte *compressed_vis;
276
277         int *firstmarksurface;
278         int nummarksurfaces;
279         qbyte ambient_sound_level[NUM_AMBIENTS];
280 }
281 mleaf_t;
282
283 typedef struct
284 {
285         dclipnode_t *clipnodes;
286         mplane_t *planes;
287         int firstclipnode;
288         int lastclipnode;
289         vec3_t clip_mins;
290         vec3_t clip_maxs;
291         vec3_t clip_size;
292 }
293 hull_t;
294
295 typedef struct mportal_s
296 {
297         struct mportal_s *next; // the next portal on this leaf
298         mleaf_t *here; // the leaf this portal is on
299         mleaf_t *past; // the leaf through this portal (infront)
300         mvertex_t *points;
301         int numpoints;
302         mplane_t plane;
303         int visframe; // is this portal visible this frame?
304 }
305 mportal_t;
306
307 typedef struct svbspmesh_s
308 {
309         struct svbspmesh_s *next;
310         int numverts, maxverts;
311         int numtriangles, maxtriangles;
312         float *verts;
313         int *elements;
314 }
315 svbspmesh_t;
316
317 typedef struct mlight_s
318 {
319         // location of light
320         vec3_t origin;
321         // distance attenuation scale (smaller is a larger light)
322         float falloff;
323         // color and brightness combined
324         vec3_t light;
325         // brightness bias, used for limiting radius without a hard edge
326         float subtract;
327         // spotlight direction
328         vec3_t spotdir;
329         // cosine of spotlight cone angle (or 0 if not a spotlight)
330         float spotcone;
331         // distance bias (larger value is softer and darker)
332         float distbias;
333         // light style controlling this light
334         int style;
335         // maximum extent of the light for shading purposes
336         float lightradius;
337         // maximum extent of the light for culling purposes
338         float cullradius;
339         float cullradius2;
340         /*
341         // surfaces this shines on
342         int numsurfaces;
343         msurface_t **surfaces;
344         // lit area
345         vec3_t mins, maxs;
346         // precomputed shadow volume meshs
347         //svbspmesh_t *shadowvolume;
348         //vec3_t shadowvolumemins, shadowvolumemaxs;
349         shadowmesh_t *shadowvolume;
350         */
351 }
352 mlight_t;
353
354 extern rtexture_t *r_notexture;
355 extern texture_t r_notexture_mip;
356
357 struct model_s;
358 void Mod_LoadBrushModel (struct model_s *mod, void *buffer);
359 void Mod_BrushInit(void);
360
361 void Mod_FindNonSolidLocation(vec3_t pos, struct model_s *mod);
362 mleaf_t *Mod_PointInLeaf (const float *p, struct model_s *model);
363 int Mod_PointContents (const float *p, struct model_s *model);
364 qbyte *Mod_LeafPVS (mleaf_t *leaf, struct model_s *model);
365 void Mod_BuildPVSTextureChains(struct model_s *model);
366
367 #endif
368