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