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_CLIPSOLID 0x800 // this polygon can obscure other polygons
  72 #define SURF_SHADOWCAST 0x1000 // this polygon can cast stencil shadows
  73 #define SURF_SHADOWLIGHT 0x2000 // this polygon can be lit by stencil shadowing
  74 #define SURF_WATERALPHA 0x4000 // this polygon's alpha is modulated by r_wateralpha
  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, const struct msurface_s *firstsurf);
  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         // type of rendering (SURFRENDER_ value)
 105         int rendertype;
 106
 107         // base texture without fullbrights, never NULL
 108         rtexture_t *texture;
 109         // fullbrights texture, NULL if no fullbrights used
 110         rtexture_t *glowtexture;
 111         // alpha texture (used for fogging), NULL if opaque
 112         rtexture_t *fogtexture;
 113         // detail texture (usually not used if transparent)
 114         rtexture_t *detailtexture;
 115         // normalmap for bumpmap shading
 116         rtexture_t *nmaptexture;
 117         // color filtering for glossy surfaces
 118         rtexture_t *glosstexture;
 119
 120         // shader to use for this texture
 121         Cshader_t *shader;
 122
 123         // total frames in sequence and alternate sequence
 124         int anim_total[2];
 125         // direct pointers to each of the frames in the sequences
 126         // (indexed as [alternate][frame])
 127         struct texture_s *anim_frames[2][10];
 128         // set if animated or there is an alternate frame set
 129         // (this is an optimization in the renderer)
 130         int animated;
 131         // the current texture frames in animation
 132         // (index with entity frame != 0)
 133         struct texture_s *currentframe[2];
 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
 225         // these are regenerated every frame
 226         // lighting info
 227         int dlightframe;
 228         int dlightbits[8];
 229         // avoid redundent addition of dlights
 230         int lightframe;
 231         // only render each surface once
 232         //int worldnodeframe;
 233
 234         // these cause lightmap updates if regenerated
 235         // values currently used in lightmap
 236         unsigned short cached_light[MAXLIGHTMAPS];
 237         // if lightmap was lit by dynamic lights, force update on next frame
 238         short cached_dlight;
 239         // to cause lightmap to be rerendered when v_overbrightbits changes
 240         short cached_lightmapscalebit;
 241         // rerender lightmaps when r_ambient changes
 242         float cached_ambient;
 243 }
 244 msurface_t;
 245
 246 typedef struct mnode_s
 247 {
 248 // common with leaf
 249         // always 0 in nodes
 250         int contents;
 251
 252         struct mnode_s *parent;
 253         struct mportal_s *portals;
 254
 255         // for bounding box culling
 256         vec3_t mins;
 257         vec3_t maxs;
 258
 259 // node specific
 260         mplane_t *plane;
 261         struct mnode_s *children[2];
 262
 263         unsigned short firstsurface;
 264         unsigned short numsurfaces;
 265 }
 266 mnode_t;
 267
 268 typedef struct mleaf_s
 269 {
 270 // common with node
 271         // always negative in leafs
 272         int contents;
 273
 274         struct mnode_s *parent;
 275         struct mportal_s *portals;
 276
 277         // for bounding box culling
 278         vec3_t mins;
 279         vec3_t maxs;
 280
 281 // leaf specific
 282         // potentially visible if current (r_pvsframecount)
 283         int pvsframe;
 284         // used by certain worldnode variants to avoid processing the same leaf twice in a frame
 285         int worldnodeframe;
 286         // used by polygon-through-portals visibility checker
 287         int portalmarkid;
 288
 289         qbyte *compressed_vis;
 290
 291         int *firstmarksurface;
 292         int nummarksurfaces;
 293         qbyte ambient_sound_level[NUM_AMBIENTS];
 294 }
 295 mleaf_t;
 296
 297 typedef struct
 298 {
 299         dclipnode_t *clipnodes;
 300         mplane_t *planes;
 301         int firstclipnode;
 302         int lastclipnode;
 303         vec3_t clip_mins;
 304         vec3_t clip_maxs;
 305         vec3_t clip_size;
 306 }
 307 hull_t;
 308
 309 typedef struct mportal_s
 310 {
 311         struct mportal_s *next; // the next portal on this leaf
 312         mleaf_t *here; // the leaf this portal is on
 313         mleaf_t *past; // the leaf through this portal (infront)
 314         mvertex_t *points;
 315         int numpoints;
 316         mplane_t plane;
 317         int visframe; // is this portal visible this frame?
 318 }
 319 mportal_t;
 320
 321 typedef struct svbspmesh_s
 322 {
 323         struct svbspmesh_s *next;
 324         int numverts, maxverts;
 325         int numtriangles, maxtriangles;
 326         float *verts;
 327         int *elements;
 328 }
 329 svbspmesh_t;
 330
 331 typedef struct mlight_s
 332 {
 333         // location of light
 334         vec3_t origin;
 335         // distance attenuation scale (smaller is a larger light)
 336         float falloff;
 337         // color and brightness combined
 338         vec3_t light;
 339         // brightness bias, used for limiting radius without a hard edge
 340         float subtract;
 341         // spotlight direction
 342         vec3_t spotdir;
 343         // cosine of spotlight cone angle (or 0 if not a spotlight)
 344         float spotcone;
 345         // distance bias (larger value is softer and darker)
 346         float distbias;
 347         // light style controlling this light
 348         int style;
 349         // maximum extent of the light for shading purposes
 350         float lightradius;
 351         // maximum extent of the light for culling purposes
 352         float cullradius;
 353         float cullradius2;
 354         // surfaces this shines on
 355         int numsurfaces;
 356         msurface_t **surfaces;
 357         // lit area
 358         vec3_t mins, maxs;
 359         // precomputed shadow volume meshs
 360         //svbspmesh_t *shadowvolume;
 361         //vec3_t shadowvolumemins, shadowvolumemaxs;
 362         shadowmesh_t *shadowvolume;
 363 }
 364 mlight_t;
 365
 366 extern rtexture_t *r_notexture;
 367 extern texture_t r_notexture_mip;
 368
 369 struct model_s;
 370 void Mod_LoadBrushModel (struct model_s *mod, void *buffer);
 371 void Mod_BrushInit(void);
 372
 373 void Mod_FindNonSolidLocation(vec3_t pos, struct model_s *mod);
 374 mleaf_t *Mod_PointInLeaf (const float *p, struct model_s *model);
 375 int Mod_PointContents (const float *p, struct model_s *model);
 376 qbyte *Mod_LeafPVS (mleaf_t *leaf, struct model_s *model);
 377
 378 #endif
 379