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