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