tools/quake3/q3map2/writebsp.c

   1 /* -------------------------------------------------------------------------------
   2
   3 Copyright (C) 1999-2007 id Software, Inc. and contributors.
   4 For a list of contributors, see the accompanying CONTRIBUTORS file.
   5
   6 This file is part of GtkRadiant.
   7
   8 GtkRadiant is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2 of the License, or
  11 (at your option) any later version.
  12
  13 GtkRadiant is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GtkRadiant; if not, write to the Free Software
  20 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  21
  22 ----------------------------------------------------------------------------------
  23
  24 This code has been altered significantly from its original form, to support
  25 several games based on the Quake III Arena engine, in the form of "Q3Map2."
  26
  27 ------------------------------------------------------------------------------- */
  28
  29
  30
  31 /* marker */
  32 #define WRITEBSP_C
  33
  34
  35
  36 /* dependencies */
  37 #include "q3map2.h"
  38
  39
  40
  41 /*
  42 EmitShader()
  43 emits a bsp shader entry
  44 */
  45
  46 int     EmitShader( const char *shader, int *contentFlags, int *surfaceFlags )
  47 {
  48         int                             i;
  49         shaderInfo_t    *si;
  50
  51
  52         /* handle special cases */
  53         if( shader == NULL )
  54                 shader = "noshader";
  55
  56         /* try to find an existing shader */
  57         for( i = 0; i < numBSPShaders; i++ )
  58         {
  59                 /* ydnar: handle custom surface/content flags */
  60                 if( surfaceFlags != NULL && bspShaders[ i ].surfaceFlags != *surfaceFlags )
  61                         continue;
  62                 if( contentFlags != NULL && bspShaders[ i ].contentFlags != *contentFlags )
  63                         continue;
  64
  65                 /* compare name */
  66                 if( !Q_stricmp( shader, bspShaders[ i ].shader ) )
  67                         return i;
  68         }
  69
  70         // i == numBSPShaders
  71
  72         /* get shaderinfo */
  73         si = ShaderInfoForShader( shader );
  74
  75         /* emit a new shader */
  76         AUTOEXPAND_BY_REALLOC_BSP(Shaders, 1024);
  77
  78         numBSPShaders++;
  79         strcpy( bspShaders[ i ].shader, shader );
  80         bspShaders[ i ].surfaceFlags = si->surfaceFlags;
  81         bspShaders[ i ].contentFlags = si->contentFlags;
  82
  83         /* handle custom content/surface flags */
  84         if( surfaceFlags != NULL )
  85                 bspShaders[ i ].surfaceFlags = *surfaceFlags;
  86         if( contentFlags != NULL )
  87                 bspShaders[ i ].contentFlags = *contentFlags;
  88
  89         /* recursively emit any damage shaders */
  90         if( si->damageShader != NULL && si->damageShader[ 0 ] != '\0' )
  91         {
  92                 Sys_FPrintf( SYS_VRB, "Shader %s has damage shader %s\n", si->shader, si->damageShader );
  93                 EmitShader( si->damageShader, NULL, NULL );
  94         }
  95
  96         /* return it */
  97         return i;
  98 }
  99
 100
 101
 102 /*
 103 EmitPlanes()
 104 there is no oportunity to discard planes, because all of the original
 105 brushes will be saved in the map
 106 */
 107
 108 void EmitPlanes( void )
 109 {
 110         int                     i;
 111         bspPlane_t      *bp;
 112         plane_t         *mp;
 113
 114
 115         /* walk plane list */
 116         mp = mapplanes;
 117         for( i = 0; i < nummapplanes; i++, mp++ )
 118         {
 119                 bp = &bspPlanes[ numBSPPlanes ];
 120                 VectorCopy( mp->normal, bp->normal );
 121                 bp->dist = mp->dist;
 122                 numBSPPlanes++;
 123         }
 124
 125         /* emit some statistics */
 126         Sys_FPrintf( SYS_VRB, "%9d BSP planes\n", numBSPPlanes );
 127 }
 128
 129
 130
 131 /*
 132 EmitLeaf()
 133 emits a leafnode to the bsp file
 134 */
 135
 136 void EmitLeaf( node_t *node )
 137 {
 138         bspLeaf_t               *leaf_p;
 139         brush_t                 *b;
 140         drawSurfRef_t   *dsr;
 141
 142
 143         /* check limits */
 144         if( numBSPLeafs >= MAX_MAP_LEAFS )
 145                 Error( "MAX_MAP_LEAFS" );
 146
 147         leaf_p = &bspLeafs[numBSPLeafs];
 148         numBSPLeafs++;
 149
 150         leaf_p->cluster = node->cluster;
 151         leaf_p->area = node->area;
 152
 153         /* emit bounding box */
 154         VectorCopy( node->mins, leaf_p->mins );
 155         VectorCopy( node->maxs, leaf_p->maxs );
 156
 157         /* emit leaf brushes */
 158         leaf_p->firstBSPLeafBrush = numBSPLeafBrushes;
 159         for( b = node->brushlist; b; b = b->next )
 160         {
 161                 /* something is corrupting brushes */
 162                 if( (size_t) b < 256 )
 163                 {
 164                         Sys_Printf( "WARNING: Node brush list corrupted (0x%08X)\n", b );
 165                         break;
 166                 }
 167                 //%     if( b->guard != 0xDEADBEEF )
 168                 //%             Sys_Printf( "Brush %6d: 0x%08X Guard: 0x%08X Next: 0x%08X Original: 0x%08X Sides: %d\n", b->brushNum, b, b, b->next, b->original, b->numsides );
 169
 170                 AUTOEXPAND_BY_REALLOC_BSP(LeafBrushes, 1024);
 171                 bspLeafBrushes[ numBSPLeafBrushes ] = b->original->outputNum;
 172                 numBSPLeafBrushes++;
 173         }
 174
 175         leaf_p->numBSPLeafBrushes = numBSPLeafBrushes - leaf_p->firstBSPLeafBrush;
 176
 177         /* emit leaf surfaces */
 178         if( node->opaque )
 179                 return;
 180
 181         /* add the drawSurfRef_t drawsurfs */
 182         leaf_p->firstBSPLeafSurface = numBSPLeafSurfaces;
 183         for ( dsr = node->drawSurfReferences; dsr; dsr = dsr->nextRef )
 184         {
 185                 AUTOEXPAND_BY_REALLOC_BSP(LeafSurfaces, 1024);
 186                 bspLeafSurfaces[ numBSPLeafSurfaces ] = dsr->outputNum;
 187                 numBSPLeafSurfaces++;
 188         }
 189
 190         leaf_p->numBSPLeafSurfaces = numBSPLeafSurfaces - leaf_p->firstBSPLeafSurface;
 191 }
 192
 193
 194 /*
 195 EmitDrawNode_r()
 196 recursively emit the bsp nodes
 197 */
 198
 199 int EmitDrawNode_r( node_t *node )
 200 {
 201         bspNode_t       *n;
 202         int                     i;
 203
 204
 205         /* check for leafnode */
 206         if( node->planenum == PLANENUM_LEAF )
 207         {
 208                 EmitLeaf( node );
 209                 return -numBSPLeafs;
 210         }
 211
 212         /* emit a node */
 213         AUTOEXPAND_BY_REALLOC_BSP(Nodes, 1024);
 214         n = &bspNodes[ numBSPNodes ];
 215         numBSPNodes++;
 216
 217         VectorCopy (node->mins, n->mins);
 218         VectorCopy (node->maxs, n->maxs);
 219
 220         if (node->planenum & 1)
 221                 Error ("WriteDrawNodes_r: odd planenum");
 222         n->planeNum = node->planenum;
 223
 224         //
 225         // recursively output the other nodes
 226         //
 227         for (i=0 ; i<2 ; i++)
 228         {
 229                 if (node->children[i]->planenum == PLANENUM_LEAF)
 230                 {
 231                         n->children[i] = -(numBSPLeafs + 1);
 232                         EmitLeaf (node->children[i]);
 233                 }
 234                 else
 235                 {
 236                         n->children[i] = numBSPNodes;
 237                         EmitDrawNode_r (node->children[i]);
 238                 }
 239         }
 240
 241         return n - bspNodes;
 242 }
 243
 244
 245
 246 /*
 247 ============
 248 SetModelNumbers
 249 ============
 250 */
 251 void SetModelNumbers (void)
 252 {
 253         int             i;
 254         int             models;
 255         char    value[10];
 256
 257         models = 1;
 258         for ( i=1 ; i<numEntities ; i++ ) {
 259                 if ( entities[i].brushes || entities[i].patches ) {
 260                         sprintf ( value, "*%i", models );
 261                         models++;
 262                         SetKeyValue (&entities[i], "model", value);
 263                 }
 264         }
 265
 266 }
 267
 268
 269
 270
 271 /*
 272 SetLightStyles()
 273 sets style keys for entity lights
 274 */
 275
 276 void SetLightStyles( void )
 277 {
 278         int                     i, j, style, numStyles;
 279         qboolean        keepLights;
 280         const char      *t;
 281         entity_t        *e;
 282         epair_t         *ep, *next;
 283         char            value[ 10 ];
 284         char            lightTargets[ MAX_SWITCHED_LIGHTS ][ 64 ];
 285         int                     lightStyles[ MAX_SWITCHED_LIGHTS ];
 286
 287
 288         /* ydnar: determine if we keep lights in the bsp */
 289         t = ValueForKey( &entities[ 0 ], "_keepLights" );
 290         keepLights = (t[ 0 ] == '1') ? qtrue : qfalse;
 291
 292         /* any light that is controlled (has a targetname) must have a unique style number generated for it */
 293         numStyles = 0;
 294         for( i = 1; i < numEntities; i++ )
 295         {
 296                 e = &entities[ i ];
 297
 298                 t = ValueForKey( e, "classname" );
 299                 if( Q_strncasecmp( t, "light", 5 ) )
 300                         continue;
 301                 t = ValueForKey( e, "targetname" );
 302                 if( t[ 0 ] == '\0' )
 303                 {
 304                         /* ydnar: strip the light from the BSP file */
 305                         if( keepLights == qfalse )
 306                         {
 307                                 ep = e->epairs;
 308                                 while( ep != NULL )
 309                                 {
 310                                         next = ep->next;
 311                                         free( ep->key );
 312                                         free( ep->value );
 313                                         free( ep );
 314                                         ep = next;
 315                                 }
 316                                 e->epairs = NULL;
 317                                 numStrippedLights++;
 318                         }
 319
 320                         /* next light */
 321                         continue;
 322                 }
 323
 324                 /* get existing style */
 325                 style = IntForKey( e, "style" );
 326                 if( style < LS_NORMAL || style > LS_NONE )
 327                         Error( "Invalid lightstyle (%d) on entity %d", style, i );
 328
 329                 /* find this targetname */
 330                 for( j = 0; j < numStyles; j++ )
 331                         if( lightStyles[ j ] == style && !strcmp( lightTargets[ j ], t ) )
 332                                 break;
 333
 334                 /* add a new style */
 335                 if( j >= numStyles )
 336                 {
 337                         if( numStyles == MAX_SWITCHED_LIGHTS )
 338                                 Error( "MAX_SWITCHED_LIGHTS (%d) exceeded, reduce the number of lights with targetnames", MAX_SWITCHED_LIGHTS );
 339                         strcpy( lightTargets[ j ], t );
 340                         lightStyles[ j ] = style;
 341                         numStyles++;
 342                 }
 343
 344                 /* set explicit style */
 345                 sprintf( value, "%d", 32 + j );
 346                 SetKeyValue( e, "style", value );
 347
 348                 /* set old style */
 349                 if( style != LS_NORMAL )
 350                 {
 351                         sprintf( value, "%d", style );
 352                         SetKeyValue( e, "switch_style", value );
 353                 }
 354         }
 355
 356         /* emit some statistics */
 357         Sys_FPrintf( SYS_VRB, "%9d light entities stripped\n", numStrippedLights );
 358 }
 359
 360
 361
 362 /*
 363 BeginBSPFile()
 364 starts a new bsp file
 365 */
 366
 367 void BeginBSPFile( void )
 368 {
 369         /* these values may actually be initialized if the file existed when loaded, so clear them explicitly */
 370         numBSPModels = 0;
 371         numBSPNodes = 0;
 372         numBSPBrushSides = 0;
 373         numBSPLeafSurfaces = 0;
 374         numBSPLeafBrushes = 0;
 375
 376         /* leave leaf 0 as an error, because leafs are referenced as negative number nodes */
 377         numBSPLeafs = 1;
 378
 379
 380         /* ydnar: gs mods: set the first 6 drawindexes to 0 1 2 2 1 3 for triangles and quads */
 381         numBSPDrawIndexes = 6;
 382         bspDrawIndexes[ 0 ] = 0;
 383         bspDrawIndexes[ 1 ] = 1;
 384         bspDrawIndexes[ 2 ] = 2;
 385         bspDrawIndexes[ 3 ] = 0;
 386         bspDrawIndexes[ 4 ] = 2;
 387         bspDrawIndexes[ 5 ] = 3;
 388 }
 389
 390
 391
 392 /*
 393 EndBSPFile()
 394 finishes a new bsp and writes to disk
 395 */
 396
 397 void EndBSPFile( void )
 398 {
 399         char    path[ 1024 ];
 400
 401
 402         Sys_FPrintf( SYS_VRB, "--- EndBSPFile ---\n" );
 403
 404         EmitPlanes();
 405
 406         numBSPEntities = numEntities;
 407         UnparseEntities();
 408
 409         /* write the surface extra file */
 410         WriteSurfaceExtraFile( source );
 411
 412         /* write the bsp */
 413         sprintf( path, "%s.bsp", source );
 414         Sys_Printf( "Writing %s\n", path );
 415         WriteBSPFile( path );
 416 }
 417
 418
 419
 420 /*
 421 EmitBrushes()
 422 writes the brush list to the bsp
 423 */
 424
 425 void EmitBrushes( brush_t *brushes, int *firstBrush, int *numBrushes )
 426 {
 427         int                             j;
 428         brush_t                 *b;
 429         bspBrush_t              *db;
 430         bspBrushSide_t  *cp;
 431
 432
 433         /* set initial brush */
 434         if( firstBrush != NULL )
 435                 *firstBrush = numBSPBrushes;
 436         if( numBrushes != NULL )
 437                 *numBrushes = 0;
 438
 439         /* walk list of brushes */
 440         for( b = brushes; b != NULL; b = b->next )
 441         {
 442                 /* check limits */
 443                 AUTOEXPAND_BY_REALLOC_BSP(Brushes, 1024);
 444
 445                 /* get bsp brush */
 446                 b->outputNum = numBSPBrushes;
 447                 db = &bspBrushes[ numBSPBrushes ];
 448                 numBSPBrushes++;
 449                 if( numBrushes != NULL )
 450                         (*numBrushes)++;
 451
 452                 db->shaderNum = EmitShader( b->contentShader->shader, &b->contentShader->contentFlags, &b->contentShader->surfaceFlags );
 453                 db->firstSide = numBSPBrushSides;
 454
 455                 /* walk sides */
 456                 db->numSides = 0;
 457                 for( j = 0; j < b->numsides; j++ )
 458                 {
 459                         /* set output number to bogus initially */
 460                         b->sides[ j ].outputNum = -1;
 461
 462                         /* check count */
 463                         AUTOEXPAND_BY_REALLOC_BSP(BrushSides, 1024);
 464
 465                         /* emit side */
 466                         b->sides[ j ].outputNum = numBSPBrushSides;
 467                         cp = &bspBrushSides[ numBSPBrushSides ];
 468                         db->numSides++;
 469                         numBSPBrushSides++;
 470                         cp->planeNum = b->sides[ j ].planenum;
 471
 472                         /* emit shader */
 473                         if( b->sides[ j ].shaderInfo )
 474                                 cp->shaderNum = EmitShader( b->sides[ j ].shaderInfo->shader, &b->sides[ j ].shaderInfo->contentFlags, &b->sides[ j ].shaderInfo->surfaceFlags );
 475                         else
 476                                 cp->shaderNum = EmitShader( NULL, NULL, NULL );
 477                 }
 478         }
 479 }
 480
 481
 482
 483 /*
 484 EmitFogs() - ydnar
 485 turns map fogs into bsp fogs
 486 */
 487
 488 void EmitFogs( void )
 489 {
 490         int                     i, j;
 491
 492
 493         /* setup */
 494         numBSPFogs = numMapFogs;
 495
 496         /* walk list */
 497         for( i = 0; i < numMapFogs; i++ )
 498         {
 499                 /* set shader */
 500                 strcpy( bspFogs[ i ].shader, mapFogs[ i ].si->shader );
 501
 502                 /* global fog doesn't have an associated brush */
 503                 if( mapFogs[ i ].brush == NULL )
 504                 {
 505                         bspFogs[ i ].brushNum = -1;
 506                         bspFogs[ i ].visibleSide = -1;
 507                 }
 508                 else
 509                 {
 510                         /* set brush */
 511                         bspFogs[ i ].brushNum = mapFogs[ i ].brush->outputNum;
 512
 513                         /* try to use forced visible side */
 514                         if( mapFogs[ i ].visibleSide >= 0 )
 515                         {
 516                                 bspFogs[ i ].visibleSide = mapFogs[ i ].visibleSide;
 517                                 continue;
 518                         }
 519
 520                         /* find visible side */
 521                         for( j = 0; j < 6; j++ )
 522                         {
 523                                 if( mapFogs[ i ].brush->sides[ j ].visibleHull != NULL )
 524                                 {
 525                                         Sys_Printf( "Fog %d has visible side %d\n", i, j );
 526                                         bspFogs[ i ].visibleSide = j;
 527                                         break;
 528                                 }
 529                         }
 530                 }
 531         }
 532 }
 533
 534
 535
 536 /*
 537 BeginModel()
 538 sets up a new brush model
 539 */
 540
 541 void BeginModel( void )
 542 {
 543         bspModel_t      *mod;
 544         brush_t         *b;
 545         entity_t        *e;
 546         vec3_t          mins, maxs;
 547         vec3_t          lgMins, lgMaxs;         /* ydnar: lightgrid mins/maxs */
 548         parseMesh_t     *p;
 549         int                     i;
 550
 551
 552         /* test limits */
 553         AUTOEXPAND_BY_REALLOC_BSP(Models, 256);
 554
 555         /* get model and entity */
 556         mod = &bspModels[ numBSPModels ];
 557         e = &entities[ mapEntityNum ];
 558
 559         /* ydnar: lightgrid mins/maxs */
 560         ClearBounds( lgMins, lgMaxs );
 561
 562         /* bound the brushes */
 563         ClearBounds( mins, maxs );
 564         for ( b = e->brushes; b; b = b->next )
 565         {
 566                 /* ignore non-real brushes (origin, etc) */
 567                 if( b->numsides == 0 )
 568                         continue;
 569                 AddPointToBounds( b->mins, mins, maxs );
 570                 AddPointToBounds( b->maxs, mins, maxs );
 571
 572                 /* ydnar: lightgrid bounds */
 573                 if( b->compileFlags & C_LIGHTGRID )
 574                 {
 575                         AddPointToBounds( b->mins, lgMins, lgMaxs );
 576                         AddPointToBounds( b->maxs, lgMins, lgMaxs );
 577                 }
 578         }
 579
 580         /* bound patches */
 581         for( p = e->patches; p; p = p->next )
 582         {
 583                 for( i = 0; i < (p->mesh.width * p->mesh.height); i++ )
 584                         AddPointToBounds( p->mesh.verts[i].xyz, mins, maxs );
 585         }
 586
 587         /* ydnar: lightgrid mins/maxs */
 588         if( lgMins[ 0 ] < 99999 )
 589         {
 590                 /* use lightgrid bounds */
 591                 VectorCopy( lgMins, mod->mins );
 592                 VectorCopy( lgMaxs, mod->maxs );
 593         }
 594         else
 595         {
 596                 /* use brush/patch bounds */
 597                 VectorCopy( mins, mod->mins );
 598                 VectorCopy( maxs, mod->maxs );
 599         }
 600
 601         /* note size */
 602         Sys_FPrintf( SYS_VRB, "BSP bounds: { %f %f %f } { %f %f %f }\n", mins[ 0 ], mins[ 1 ], mins[ 2 ], maxs[ 0 ], maxs[ 1 ], maxs[ 2 ] );
 603         Sys_FPrintf( SYS_VRB, "Lightgrid bounds: { %f %f %f } { %f %f %f }\n", lgMins[ 0 ], lgMins[ 1 ], lgMins[ 2 ], lgMaxs[ 0 ], lgMaxs[ 1 ], lgMaxs[ 2 ] );
 604
 605         /* set firsts */
 606         mod->firstBSPSurface = numBSPDrawSurfaces;
 607         mod->firstBSPBrush = numBSPBrushes;
 608 }
 609
 610
 611
 612
 613 /*
 614 EndModel()
 615 finish a model's processing
 616 */
 617
 618 void EndModel( entity_t *e, node_t *headnode )
 619 {
 620         bspModel_t      *mod;
 621
 622
 623         /* note it */
 624         Sys_FPrintf( SYS_VRB, "--- EndModel ---\n" );
 625
 626         /* emit the bsp */
 627         mod = &bspModels[ numBSPModels ];
 628         EmitDrawNode_r( headnode );
 629
 630         /* set surfaces and brushes */
 631         mod->numBSPSurfaces = numBSPDrawSurfaces - mod->firstBSPSurface;
 632         mod->firstBSPBrush = e->firstBrush;
 633         mod->numBSPBrushes = e->numBrushes;
 634
 635         /* increment model count */
 636         numBSPModels++;
 637 }
 638
 639
 640