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