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 /*
  22 ==============================================================================
  23
  24 BRUSH MODELS
  25
  26 ==============================================================================
  27 */
  28
  29
  30 //
  31 // in memory representation
  32 //
  33 typedef struct
  34 {
  35         vec3_t          position;
  36 }
  37 mvertex_t;
  38
  39 #define SIDE_FRONT      0
  40 #define SIDE_BACK       1
  41 #define SIDE_ON         2
  42
  43
  44 // plane_t structure
  45 typedef struct mplane_s
  46 {
  47         vec3_t  normal;
  48         float   dist;
  49         int             type;                   // for texture axis selection and fast side tests
  50         // LordHavoc: faster than id's signbits system
  51         int (*BoxOnPlaneSideFunc) (vec3_t emins, vec3_t emaxs, struct mplane_s *p);
  52 }
  53 mplane_t;
  54
  55 typedef struct texture_s
  56 {
  57         char                            name[16];
  58         unsigned                        width, height;
  59         int                                     flags;                          // LordHavoc: SURF_ flags
  60
  61         rtexture_t                      *texture;
  62         rtexture_t                      *glowtexture;
  63         rtexture_t                      *fogtexture;            // alpha-only version of main texture
  64
  65         int                                     anim_total;                     // total frames in sequence (< 2 = not animated)
  66         struct texture_s        *anim_frames[10];       // LordHavoc: direct pointers to each of the frames in the sequence
  67         struct texture_s        *alternate_anims;       // bmodels in frame 1 use these
  68 }
  69 texture_t;
  70
  71
  72 #define SURF_PLANEBACK          2
  73 #define SURF_DRAWSKY            4
  74 //#define SURF_DRAWSPRITE               8
  75 #define SURF_DRAWTURB           0x10
  76 #define SURF_LIGHTMAP           0x20
  77 //#define SURF_DRAWBACKGROUND   0x40
  78 //#define SURF_UNDERWATER               0x80
  79 #define SURF_DRAWNOALPHA        0x100
  80 #define SURF_DRAWFULLBRIGHT     0x200
  81 #define SURF_LIGHTBOTHSIDES     0x400
  82 #define SURF_CLIPSOLID          0x800 // this polygon can obscure other polygons
  83
  84 typedef struct
  85 {
  86         unsigned short  v[2];
  87 }
  88 medge_t;
  89
  90 typedef struct
  91 {
  92         float           vecs[2][4];
  93         texture_t       *texture;
  94         int                     flags;
  95 }
  96 mtexinfo_t;
  97
  98 typedef struct surfvertex_s
  99 {
 100         // position
 101         float v[3];
 102         // offset into lightmap (used by vertex lighting)
 103         int lightmapoffset;
 104         // texture coordinates
 105         float st[2];
 106         // lightmap coordinates
 107         float uv[2];
 108 }
 109 surfvertex_t;
 110
 111 // LordHavoc: replaces glpoly, triangle mesh
 112 typedef struct surfmesh_s
 113 {
 114         // can be multiple meshs per surface
 115         struct surfmesh_s *chain;
 116         int numverts;
 117         int numtriangles;
 118         surfvertex_t *vertex;
 119         int *index;
 120 }
 121 surfmesh_t;
 122
 123 typedef struct msurface_s
 124 {
 125         // should be drawn if visframe == r_framecount (set by WorldNode functions)
 126         int                     visframe;
 127
 128         // the node plane this is on, backwards if SURF_PLANEBACK flag set
 129         mplane_t        *plane;
 130         // SURF_ flags
 131         int                     flags;
 132         struct Cshader_s        *shader;
 133         struct msurface_s       *chain; // shader rendering chain
 134
 135         // look up in model->surfedges[], negative numbers are backwards edges
 136         int                     firstedge;
 137         int                     numedges;
 138
 139         short           texturemins[2];
 140         short           extents[2];
 141
 142         mtexinfo_t      *texinfo;
 143         texture_t       *currenttexture; // updated (animated) during early surface processing each frame
 144
 145         // index into d_lightstylevalue array, 255 means not used (black)
 146         qbyte           styles[MAXLIGHTMAPS];
 147         // RGB lighting data [numstyles][height][width][3]
 148         qbyte           *samples;
 149         // stain to apply on lightmap (soot/dirt/blood/whatever)
 150         qbyte           *stainsamples;
 151
 152         // these fields are generated during model loading
 153         // the lightmap texture fragment to use on the surface
 154         rtexture_t *lightmaptexture;
 155         // the stride when building lightmaps to comply with fragment update
 156         int                     lightmaptexturestride;
 157         // mesh for rendering
 158         surfmesh_t      *mesh;
 159
 160         // these are just 3D points defining the outline of the polygon,
 161         // no texcoord info (that can be generated from these)
 162         int                     poly_numverts;
 163         float           *poly_verts;
 164
 165         // these are regenerated every frame
 166         // lighting info
 167         int                     dlightframe;
 168         int                     dlightbits[8];
 169         // avoid redundent addition of dlights
 170         int                     lightframe;
 171         // only render each surface once
 172         int                     worldnodeframe;
 173         // marked when surface is prepared for the frame
 174         int                     insertframe;
 175
 176         // these cause lightmap updates if regenerated
 177         // values currently used in lightmap
 178         unsigned short cached_light[MAXLIGHTMAPS];
 179         // if lightmap was lit by dynamic lights, force update on next frame
 180         short           cached_dlight;
 181         // to cause lightmap to be rerendered when v_overbrightbits changes
 182         short           cached_lightscalebit;
 183         // rerender lightmaps when r_ambient changes
 184         float           cached_ambient;
 185 }
 186 msurface_t;
 187
 188 #define SHADERSTAGE_SKY 0
 189 #define SHADERSTAGE_NORMAL 1
 190 #define SHADERSTAGE_COUNT 2
 191
 192 // change this stuff when real shaders are added
 193 typedef struct Cshader_s
 194 {
 195         void (*shaderfunc[SHADERSTAGE_COUNT])(msurface_t *firstsurf);
 196         // list of surfaces using this shader (used during surface rendering)
 197         msurface_t *chain;
 198 }
 199 Cshader_t;
 200
 201 extern Cshader_t Cshader_wall_vertex;
 202 extern Cshader_t Cshader_wall_lightmap;
 203 extern Cshader_t Cshader_wall_fullbright;
 204 extern Cshader_t Cshader_water;
 205 extern Cshader_t Cshader_sky;
 206
 207 // warning: if this is changed, references must be updated in cpu_* assembly files
 208 typedef struct mnode_s
 209 {
 210 // common with leaf
 211         int                                     contents;               // 0, to differentiate from leafs
 212
 213         struct mnode_s          *parent;
 214         struct mportal_s        *portals;
 215
 216         // for bounding box culling
 217         vec3_t                          mins;
 218         vec3_t                          maxs;
 219
 220 // node specific
 221         mplane_t                        *plane;
 222         struct mnode_s          *children[2];
 223
 224         unsigned short          firstsurface;
 225         unsigned short          numsurfaces;
 226 }
 227 mnode_t;
 228
 229 typedef struct mleaf_s
 230 {
 231 // common with node
 232         int                                     contents;               // will be a negative contents number
 233
 234         struct mnode_s          *parent;
 235         struct mportal_s        *portals;
 236
 237         // for bounding box culling
 238         vec3_t                          mins;
 239         vec3_t                          maxs;
 240
 241 // leaf specific
 242         int                                     visframe;               // visible if current (r_framecount)
 243         int                                     worldnodeframe; // used by certain worldnode variants to avoid processing the same leaf twice in a frame
 244         int                                     portalmarkid;   // used by polygon-through-portals visibility checker
 245
 246         // LordHavoc: leaf based dynamic lighting
 247         int                                     dlightbits[8];
 248         int                                     dlightframe;
 249
 250         qbyte                           *compressed_vis;
 251
 252         msurface_t                      **firstmarksurface;
 253         int                                     nummarksurfaces;
 254         qbyte                           ambient_sound_level[NUM_AMBIENTS];
 255 }
 256 mleaf_t;
 257
 258 typedef struct
 259 {
 260         dclipnode_t     *clipnodes;
 261         mplane_t        *planes;
 262         int                     firstclipnode;
 263         int                     lastclipnode;
 264         vec3_t          clip_mins;
 265         vec3_t          clip_maxs;
 266         vec3_t          clip_size;
 267 }
 268 hull_t;
 269
 270 typedef struct mportal_s
 271 {
 272         struct mportal_s *next; // the next portal on this leaf
 273         mleaf_t *here; // the leaf this portal is on
 274         mleaf_t *past; // the leaf through this portal (infront)
 275         mvertex_t *points;
 276         int numpoints;
 277         mplane_t plane;
 278         int visframe; // is this portal visible this frame?
 279 }
 280 mportal_t;
 281
 282 typedef struct mlight_s
 283 {
 284         vec3_t origin;
 285         float falloff;
 286         vec3_t light;
 287         float subtract;
 288         vec3_t spotdir;
 289         float spotcone; // cosine of spotlight cone angle (or 0 if not a spotlight)
 290         float distbias;
 291         int style;
 292         int numleafs; // used only for loading calculations, number of leafs this shines on
 293 }
 294 mlight_t;
 295
 296 extern rtexture_t *r_notexture;
 297 extern texture_t r_notexture_mip;
 298
 299 struct model_s;
 300 void Mod_LoadBrushModel (struct model_s *mod, void *buffer);
 301 void Mod_BrushInit(void);
 302 void Mod_FindNonSolidLocation(vec3_t pos, struct model_s *mod);