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, const struct msurface_s *firstsurf);
  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         // type of rendering (SURFRENDER_ value)
 104         int rendertype;
 105
 106         // base texture without fullbrights, never NULL
 107         rtexture_t *texture;
 108         // fullbrights texture, NULL if no fullbrights used
 109         rtexture_t *glowtexture;
 110         // alpha texture (used for fogging), NULL if opaque
 111         rtexture_t *fogtexture;
 112         // detail texture (usually not used if transparent)
 113         rtexture_t *detailtexture;
 114         // normalmap for bumpmap shading
 115         rtexture_t *nmaptexture;
 116         // color filtering for glossy surfaces
 117         rtexture_t *glosstexture;
 118
 119         // shader to use for this texture
 120         Cshader_t *shader;
 121
 122         // total frames in sequence and alternate sequence
 123         int anim_total[2];
 124         // direct pointers to each of the frames in the sequences
 125         // (indexed as [alternate][frame])
 126         struct texture_s *anim_frames[2][10];
 127         // set if animated or there is an alternate frame set
 128         // (this is an optimization in the renderer)
 129         int animated;
 130         // the current texture frames in animation
 131         // (index with entity frame != 0)
 132         struct texture_s *currentframe[2];
 133 }
 134 texture_t;
 135
 136 typedef struct
 137 {
 138         unsigned short v[2];
 139 }
 140 medge_t;
 141
 142 typedef struct
 143 {
 144         float vecs[2][4];
 145         texture_t *texture;
 146         int flags;
 147 }
 148 mtexinfo_t;
 149
 150 // LordHavoc: replaces glpoly, triangle mesh
 151 typedef struct surfmesh_s
 152 {
 153         // can be multiple meshs per surface
 154         struct surfmesh_s *chain;
 155         int numverts;
 156         int numtriangles;
 157         float *verts;
 158         float *svectors;
 159         float *tvectors;
 160         float *normals;
 161         int *lightmapoffsets;
 162         float *str;
 163         float *uvw;
 164         float *abc;
 165         int *index;
 166         int *triangleneighbors;
 167 }
 168 surfmesh_t;
 169
 170 typedef struct msurface_s
 171 {
 172         // surface number, to avoid having to do a divide to find the number of a surface from it's address
 173         int number;
 174         // should be drawn if visframe == r_framecount (set by PrepareSurfaces)
 175         int visframe;
 176         // should be drawn if onscreen and not a backface (used for setting visframe)
 177         //int pvsframe;
 178         // chain of surfaces marked visible by pvs
 179         //struct msurface_s *pvschain;
 180
 181         // the node plane this is on, backwards if SURF_PLANEBACK flag set
 182         mplane_t *plane;
 183         // SURF_ flags
 184         int flags;
 185         // rendering chain
 186         struct msurface_s *texturechain;
 187
 188         // look up in model->surfedges[], negative numbers are backwards edges
 189         int firstedge;
 190         int numedges;
 191
 192         short texturemins[2];
 193         short extents[2];
 194
 195         mtexinfo_t *texinfo;
 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
 204         // these fields are generated during model loading
 205         // the lightmap texture fragment to use on the surface
 206         rtexture_t *lightmaptexture;
 207         // the stride when building lightmaps to comply with fragment update
 208         int lightmaptexturestride;
 209         // mesh for rendering
 210         surfmesh_t *mesh;
 211
 212         // these are just 3D points defining the outline of the polygon,
 213         // no texcoord info (that can be generated from these)
 214         int poly_numverts;
 215         float *poly_verts;
 216         // bounding box for onscreen checks, and center for sorting
 217         vec3_t poly_mins, poly_maxs, poly_center;
 218         // bounding sphere radius (around poly_center)
 219         float poly_radius, poly_radius2;
 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         // these are regenerated every frame
 227         // lighting info
 228         int dlightframe;
 229         int dlightbits[8];
 230         // avoid redundent addition of dlights
 231         int lightframe;
 232         // only render each surface once
 233         //int worldnodeframe;
 234
 235         // these cause lightmap updates if regenerated
 236         // values currently used in lightmap
 237         unsigned short cached_light[MAXLIGHTMAPS];
 238         // if lightmap was lit by dynamic lights, force update on next frame
 239         short cached_dlight;
 240         // to cause lightmap to be rerendered when v_overbrightbits changes
 241         short cached_lightmapscalebit;
 242         // rerender lightmaps when r_ambient changes
 243         float cached_ambient;
 244 }
 245 msurface_t;
 246
 247 typedef struct mnode_s
 248 {
 249 // common with leaf
 250         // always 0 in nodes
 251         int contents;
 252
 253         struct mnode_s *parent;
 254         struct mportal_s *portals;
 255
 256         // for bounding box culling
 257         vec3_t mins;
 258         vec3_t maxs;
 259
 260 // node specific
 261         mplane_t *plane;
 262         struct mnode_s *children[2];
 263
 264         unsigned short firstsurface;
 265         unsigned short numsurfaces;
 266 }
 267 mnode_t;
 268
 269 typedef struct mleaf_s
 270 {
 271 // common with node
 272         // always negative in leafs
 273         int contents;
 274
 275         struct mnode_s *parent;
 276         struct mportal_s *portals;
 277
 278         // for bounding box culling
 279         vec3_t mins;
 280         vec3_t maxs;
 281
 282 // leaf specific
 283         // next leaf in pvschain
 284         struct mleaf_s *pvschain;
 285         // potentially visible if current (model->pvsframecount)
 286         int pvsframe;
 287         // visible if marked current (r_framecount)
 288         int visframe;
 289         // used by certain worldnode variants to avoid processing the same leaf twice in a frame
 290         int worldnodeframe;
 291         // used by polygon-through-portals visibility checker
 292         int portalmarkid;
 293
 294         qbyte *compressed_vis;
 295
 296         int *firstmarksurface;
 297         int nummarksurfaces;
 298         qbyte ambient_sound_level[NUM_AMBIENTS];
 299 }
 300 mleaf_t;
 301
 302 typedef struct
 303 {
 304         dclipnode_t *clipnodes;
 305         mplane_t *planes;
 306         int firstclipnode;
 307         int lastclipnode;
 308         vec3_t clip_mins;
 309         vec3_t clip_maxs;
 310         vec3_t clip_size;
 311 }
 312 hull_t;
 313
 314 typedef struct mportal_s
 315 {
 316         struct mportal_s *next; // the next portal on this leaf
 317         mleaf_t *here; // the leaf this portal is on
 318         mleaf_t *past; // the leaf through this portal (infront)
 319         mvertex_t *points;
 320         int numpoints;
 321         mplane_t plane;
 322         int visframe; // is this portal visible this frame?
 323 }
 324 mportal_t;
 325
 326 typedef struct svbspmesh_s
 327 {
 328         struct svbspmesh_s *next;
 329         int numverts, maxverts;
 330         int numtriangles, maxtriangles;
 331         float *verts;
 332         int *elements;
 333 }
 334 svbspmesh_t;
 335
 336 typedef struct mlight_s
 337 {
 338         // location of light
 339         vec3_t origin;
 340         // distance attenuation scale (smaller is a larger light)
 341         float falloff;
 342         // color and brightness combined
 343         vec3_t light;
 344         // brightness bias, used for limiting radius without a hard edge
 345         float subtract;
 346         // spotlight direction
 347         vec3_t spotdir;
 348         // cosine of spotlight cone angle (or 0 if not a spotlight)
 349         float spotcone;
 350         // distance bias (larger value is softer and darker)
 351         float distbias;
 352         // light style controlling this light
 353         int style;
 354         // maximum extent of the light for shading purposes
 355         float lightradius;
 356         // maximum extent of the light for culling purposes
 357         float cullradius;
 358         float cullradius2;
 359         // surfaces this shines on
 360         int numsurfaces;
 361         msurface_t **surfaces;
 362         // lit area
 363         vec3_t mins, maxs;
 364         // precomputed shadow volume meshs
 365         //svbspmesh_t *shadowvolume;
 366         //vec3_t shadowvolumemins, shadowvolumemaxs;
 367         shadowmesh_t *shadowvolume;
 368 }
 369 mlight_t;
 370
 371 extern rtexture_t *r_notexture;
 372 extern texture_t r_notexture_mip;
 373
 374 struct model_s;
 375 void Mod_LoadBrushModel (struct model_s *mod, void *buffer);
 376 void Mod_BrushInit(void);
 377
 378 void Mod_FindNonSolidLocation(vec3_t pos, struct model_s *mod);
 379 mleaf_t *Mod_PointInLeaf (const float *p, struct model_s *model);
 380 int Mod_PointContents (const float *p, struct model_s *model);
 381 qbyte *Mod_LeafPVS (mleaf_t *leaf, struct model_s *model);
 382
 383 #endif
 384