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