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                 AUTOEXPAND_BY_REALLOC_BSP(Planes, 1024);
 120                 bp = &bspPlanes[ numBSPPlanes ];
 121                 VectorCopy( mp->normal, bp->normal );
 122                 bp->dist = mp->dist;
 123                 numBSPPlanes++;
 124         }
 125
 126         /* emit some statistics */
 127         Sys_FPrintf( SYS_VRB, "%9d BSP planes\n", numBSPPlanes );
 128 }
 129
 130
 131
 132 /*
 133 EmitLeaf()
 134 emits a leafnode to the bsp file
 135 */
 136
 137 void EmitLeaf( node_t *node )
 138 {
 139         bspLeaf_t               *leaf_p;
 140         brush_t                 *b;
 141         drawSurfRef_t   *dsr;
 142
 143
 144         /* check limits */
 145         if( numBSPLeafs >= MAX_MAP_LEAFS )
 146                 Error( "MAX_MAP_LEAFS" );
 147
 148         leaf_p = &bspLeafs[numBSPLeafs];
 149         numBSPLeafs++;
 150
 151         leaf_p->cluster = node->cluster;
 152         leaf_p->area = node->area;
 153
 154         /* emit bounding box */
 155         VectorCopy( node->mins, leaf_p->mins );
 156         VectorCopy( node->maxs, leaf_p->maxs );
 157
 158         /* emit leaf brushes */
 159         leaf_p->firstBSPLeafBrush = numBSPLeafBrushes;
 160         for( b = node->brushlist; b; b = b->next )
 161         {
 162                 /* something is corrupting brushes */
 163                 if( (size_t) b < 256 )
 164                 {
 165                         Sys_Printf( "WARNING: Node brush list corrupted (0x%08X)\n", b );
 166                         break;
 167                 }
 168                 //%     if( b->guard != 0xDEADBEEF )
 169                 //%             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 );
 170
 171                 AUTOEXPAND_BY_REALLOC_BSP(LeafBrushes, 1024);
 172                 bspLeafBrushes[ numBSPLeafBrushes ] = b->original->outputNum;
 173                 numBSPLeafBrushes++;
 174         }
 175
 176         leaf_p->numBSPLeafBrushes = numBSPLeafBrushes - leaf_p->firstBSPLeafBrush;
 177
 178         /* emit leaf surfaces */
 179         if( node->opaque )
 180                 return;
 181
 182         /* add the drawSurfRef_t drawsurfs */
 183         leaf_p->firstBSPLeafSurface = numBSPLeafSurfaces;
 184         for ( dsr = node->drawSurfReferences; dsr; dsr = dsr->nextRef )
 185         {
 186                 AUTOEXPAND_BY_REALLOC_BSP(LeafSurfaces, 1024);
 187                 bspLeafSurfaces[ numBSPLeafSurfaces ] = dsr->outputNum;
 188                 numBSPLeafSurfaces++;
 189         }
 190
 191         leaf_p->numBSPLeafSurfaces = numBSPLeafSurfaces - leaf_p->firstBSPLeafSurface;
 192 }
 193
 194
 195 /*
 196 EmitDrawNode_r()
 197 recursively emit the bsp nodes
 198 */
 199
 200 int EmitDrawNode_r( node_t *node )
 201 {
 202         bspNode_t       *n;
 203         int                     i, n0;
 204
 205
 206         /* check for leafnode */
 207         if( node->planenum == PLANENUM_LEAF )
 208         {
 209                 EmitLeaf( node );
 210                 return -numBSPLeafs;
 211         }
 212
 213         /* emit a node */
 214         AUTOEXPAND_BY_REALLOC_BSP(Nodes, 1024);
 215         n0 = numBSPNodes;
 216         n = &bspNodes[ n0 ];
 217         numBSPNodes++;
 218
 219         VectorCopy (node->mins, n->mins);
 220         VectorCopy (node->maxs, n->maxs);
 221
 222         if (node->planenum & 1)
 223                 Error ("WriteDrawNodes_r: odd planenum");
 224         n->planeNum = node->planenum;
 225
 226         //
 227         // recursively output the other nodes
 228         //
 229         for (i=0 ; i<2 ; i++)
 230         {
 231                 if (node->children[i]->planenum == PLANENUM_LEAF)
 232                 {
 233                         n->children[i] = -(numBSPLeafs + 1);
 234                         EmitLeaf (node->children[i]);
 235                 }
 236                 else
 237                 {
 238                         n->children[i] = numBSPNodes;
 239                         EmitDrawNode_r (node->children[i]);
 240                         // n may have become invalid here, so...
 241                         n = &bspNodes[ n0 ];
 242                 }
 243         }
 244
 245         return n - bspNodes;
 246 }
 247
 248
 249
 250 /*
 251 ============
 252 SetModelNumbers
 253 ============
 254 */
 255 void SetModelNumbers (void)
 256 {
 257         int             i;
 258         int             models;
 259         char    value[10];
 260
 261         models = 1;
 262         for ( i=1 ; i<numEntities ; i++ ) {
 263                 if ( entities[i].brushes || entities[i].patches ) {
 264                         sprintf ( value, "*%i", models );
 265                         models++;
 266                         SetKeyValue (&entities[i], "model", value);
 267                 }
 268         }
 269
 270 }
 271
 272
 273
 274
 275 /*
 276 SetLightStyles()
 277 sets style keys for entity lights
 278 */
 279
 280 void SetLightStyles( void )
 281 {
 282         int                     i, j, style, numStyles;
 283         const char      *t;
 284         entity_t        *e;
 285         epair_t         *ep, *next;
 286         char            value[ 10 ];
 287         char            lightTargets[ MAX_SWITCHED_LIGHTS ][ 64 ];
 288         int                     lightStyles[ MAX_SWITCHED_LIGHTS ];
 289
 290         /* -keeplights option: force lights to be kept and ignore what the map file says */
 291         if (keepLights)
 292                 SetKeyValue(&entities[0], "_keepLights", "1");
 293
 294         /* ydnar: determine if we keep lights in the bsp */
 295         if (KeyExists(&entities[ 0 ], "_keepLights") == qtrue)
 296         {
 297                 t = ValueForKey( &entities[ 0 ], "_keepLights" );
 298                 keepLights = (t[ 0 ] == '1') ? qtrue : qfalse;
 299         }
 300
 301         /* any light that is controlled (has a targetname) must have a unique style number generated for it */
 302         numStyles = 0;
 303         for( i = 1; i < numEntities; i++ )
 304         {
 305                 e = &entities[ i ];
 306
 307                 t = ValueForKey( e, "classname" );
 308                 if( Q_strncasecmp( t, "light", 5 ) )
 309                         continue;
 310                 t = ValueForKey( e, "targetname" );
 311                 if( t[ 0 ] == '\0' )
 312                 {
 313                         /* ydnar: strip the light from the BSP file */
 314                         if( keepLights == qfalse )
 315                         {
 316                                 ep = e->epairs;
 317                                 while( ep != NULL )
 318                                 {
 319                                         next = ep->next;
 320                                         free( ep->key );
 321                                         free( ep->value );
 322                                         free( ep );
 323                                         ep = next;
 324                                 }
 325                                 e->epairs = NULL;
 326                                 numStrippedLights++;
 327                         }
 328
 329                         /* next light */
 330                         continue;
 331                 }
 332
 333                 /* get existing style */
 334                 style = IntForKey( e, "style" );
 335                 if( style < LS_NORMAL || style > LS_NONE )
 336                         Error( "Invalid lightstyle (%d) on entity %d", style, i );
 337
 338                 /* find this targetname */
 339                 for( j = 0; j < numStyles; j++ )
 340                         if( lightStyles[ j ] == style && !strcmp( lightTargets[ j ], t ) )
 341                                 break;
 342
 343                 /* add a new style */
 344                 if( j >= numStyles )
 345                 {
 346                         if( numStyles == MAX_SWITCHED_LIGHTS )
 347                                 Error( "MAX_SWITCHED_LIGHTS (%d) exceeded, reduce the number of lights with targetnames", MAX_SWITCHED_LIGHTS );
 348                         strcpy( lightTargets[ j ], t );
 349                         lightStyles[ j ] = style;
 350                         numStyles++;
 351                 }
 352
 353                 /* set explicit style */
 354                 sprintf( value, "%d", 32 + j );
 355                 SetKeyValue( e, "style", value );
 356
 357                 /* set old style */
 358                 if( style != LS_NORMAL )
 359                 {
 360                         sprintf( value, "%d", style );
 361                         SetKeyValue( e, "switch_style", value );
 362                 }
 363         }
 364
 365         /* emit some statistics */
 366         Sys_FPrintf( SYS_VRB, "%9d light entities stripped\n", numStrippedLights );
 367 }
 368
 369
 370
 371 /*
 372 BeginBSPFile()
 373 starts a new bsp file
 374 */
 375
 376 void BeginBSPFile( void )
 377 {
 378         /* these values may actually be initialized if the file existed when loaded, so clear them explicitly */
 379         numBSPModels = 0;
 380         numBSPNodes = 0;
 381         numBSPBrushSides = 0;
 382         numBSPLeafSurfaces = 0;
 383         numBSPLeafBrushes = 0;
 384
 385         /* leave leaf 0 as an error, because leafs are referenced as negative number nodes */
 386         numBSPLeafs = 1;
 387
 388
 389         /* ydnar: gs mods: set the first 6 drawindexes to 0 1 2 2 1 3 for triangles and quads */
 390         numBSPDrawIndexes = 6;
 391         bspDrawIndexes[ 0 ] = 0;
 392         bspDrawIndexes[ 1 ] = 1;
 393         bspDrawIndexes[ 2 ] = 2;
 394         bspDrawIndexes[ 3 ] = 0;
 395         bspDrawIndexes[ 4 ] = 2;
 396         bspDrawIndexes[ 5 ] = 3;
 397 }
 398
 399
 400
 401 /*
 402 EndBSPFile()
 403 finishes a new bsp and writes to disk
 404 */
 405
 406 void EndBSPFile(qboolean do_write)
 407 {
 408         char    path[ 1024 ];
 409
 410
 411         Sys_FPrintf( SYS_VRB, "--- EndBSPFile ---\n" );
 412
 413         EmitPlanes();
 414
 415         numBSPEntities = numEntities;
 416         UnparseEntities();
 417
 418         if(do_write)
 419         {
 420                 /* write the surface extra file */
 421                 WriteSurfaceExtraFile( source );
 422
 423                 /* write the bsp */
 424                 sprintf( path, "%s.bsp", source );
 425                 Sys_Printf( "Writing %s\n", path );
 426                 WriteBSPFile( path );
 427         }
 428 }
 429
 430
 431
 432 /*
 433 EmitBrushes()
 434 writes the brush list to the bsp
 435 */
 436
 437 void EmitBrushes( brush_t *brushes, int *firstBrush, int *numBrushes )
 438 {
 439         int                             j;
 440         brush_t                 *b;
 441         bspBrush_t              *db;
 442         bspBrushSide_t  *cp;
 443
 444
 445         /* set initial brush */
 446         if( firstBrush != NULL )
 447                 *firstBrush = numBSPBrushes;
 448         if( numBrushes != NULL )
 449                 *numBrushes = 0;
 450
 451         /* walk list of brushes */
 452         for( b = brushes; b != NULL; b = b->next )
 453         {
 454                 /* check limits */
 455                 AUTOEXPAND_BY_REALLOC_BSP(Brushes, 1024);
 456
 457                 /* get bsp brush */
 458                 b->outputNum = numBSPBrushes;
 459                 db = &bspBrushes[ numBSPBrushes ];
 460                 numBSPBrushes++;
 461                 if( numBrushes != NULL )
 462                         (*numBrushes)++;
 463
 464                 db->shaderNum = EmitShader( b->contentShader->shader, &b->contentShader->contentFlags, &b->contentShader->surfaceFlags );
 465                 db->firstSide = numBSPBrushSides;
 466
 467                 /* walk sides */
 468                 db->numSides = 0;
 469                 for( j = 0; j < b->numsides; j++ )
 470                 {
 471                         /* set output number to bogus initially */
 472                         b->sides[ j ].outputNum = -1;
 473
 474                         /* check count */
 475                         AUTOEXPAND_BY_REALLOC_BSP(BrushSides, 1024);
 476
 477                         /* emit side */
 478                         b->sides[ j ].outputNum = numBSPBrushSides;
 479                         cp = &bspBrushSides[ numBSPBrushSides ];
 480                         db->numSides++;
 481                         numBSPBrushSides++;
 482                         cp->planeNum = b->sides[ j ].planenum;
 483
 484                         /* emit shader */
 485                         if( b->sides[ j ].shaderInfo )
 486                                 cp->shaderNum = EmitShader( b->sides[ j ].shaderInfo->shader, &b->sides[ j ].shaderInfo->contentFlags, &b->sides[ j ].shaderInfo->surfaceFlags );
 487                         else
 488                                 cp->shaderNum = EmitShader( NULL, NULL, NULL );
 489                 }
 490         }
 491 }
 492
 493
 494
 495 /*
 496 EmitFogs() - ydnar
 497 turns map fogs into bsp fogs
 498 */
 499
 500 void EmitFogs( void )
 501 {
 502         int                     i, j;
 503
 504
 505         /* setup */
 506         numBSPFogs = numMapFogs;
 507
 508         /* walk list */
 509         for( i = 0; i < numMapFogs; i++ )
 510         {
 511                 /* set shader */
 512                 strcpy( bspFogs[ i ].shader, mapFogs[ i ].si->shader );
 513
 514                 /* global fog doesn't have an associated brush */
 515                 if( mapFogs[ i ].brush == NULL )
 516                 {
 517                         bspFogs[ i ].brushNum = -1;
 518                         bspFogs[ i ].visibleSide = -1;
 519                 }
 520                 else
 521                 {
 522                         /* set brush */
 523                         bspFogs[ i ].brushNum = mapFogs[ i ].brush->outputNum;
 524
 525                         /* try to use forced visible side */
 526                         if( mapFogs[ i ].visibleSide >= 0 )
 527                         {
 528                                 bspFogs[ i ].visibleSide = mapFogs[ i ].visibleSide;
 529                                 continue;
 530                         }
 531
 532                         /* find visible side */
 533                         for( j = 0; j < 6; j++ )
 534                         {
 535                                 if( mapFogs[ i ].brush->sides[ j ].visibleHull != NULL )
 536                                 {
 537                                         Sys_Printf( "Fog %d has visible side %d\n", i, j );
 538                                         bspFogs[ i ].visibleSide = j;
 539                                         break;
 540                                 }
 541                         }
 542                 }
 543         }
 544 }
 545
 546
 547
 548 /*
 549 BeginModel()
 550 sets up a new brush model
 551 */
 552
 553 void BeginModel( void )
 554 {
 555         bspModel_t      *mod;
 556         brush_t         *b;
 557         entity_t        *e;
 558         vec3_t          mins, maxs;
 559         vec3_t          lgMins, lgMaxs;         /* ydnar: lightgrid mins/maxs */
 560         parseMesh_t     *p;
 561         int                     i;
 562
 563
 564         /* test limits */
 565         AUTOEXPAND_BY_REALLOC_BSP(Models, 256);
 566
 567         /* get model and entity */
 568         mod = &bspModels[ numBSPModels ];
 569         e = &entities[ mapEntityNum ];
 570
 571         /* ydnar: lightgrid mins/maxs */
 572         ClearBounds( lgMins, lgMaxs );
 573
 574         /* bound the brushes */
 575         ClearBounds( mins, maxs );
 576         for ( b = e->brushes; b; b = b->next )
 577         {
 578                 /* ignore non-real brushes (origin, etc) */
 579                 if( b->numsides == 0 )
 580                         continue;
 581                 AddPointToBounds( b->mins, mins, maxs );
 582                 AddPointToBounds( b->maxs, mins, maxs );
 583
 584                 /* ydnar: lightgrid bounds */
 585                 if( b->compileFlags & C_LIGHTGRID )
 586                 {
 587                         AddPointToBounds( b->mins, lgMins, lgMaxs );
 588                         AddPointToBounds( b->maxs, lgMins, lgMaxs );
 589                 }
 590         }
 591
 592         /* bound patches */
 593         for( p = e->patches; p; p = p->next )
 594         {
 595                 for( i = 0; i < (p->mesh.width * p->mesh.height); i++ )
 596                         AddPointToBounds( p->mesh.verts[i].xyz, mins, maxs );
 597         }
 598
 599         /* ydnar: lightgrid mins/maxs */
 600         if( lgMins[ 0 ] < 99999 )
 601         {
 602                 /* use lightgrid bounds */
 603                 VectorCopy( lgMins, mod->mins );
 604                 VectorCopy( lgMaxs, mod->maxs );
 605         }
 606         else
 607         {
 608                 /* use brush/patch bounds */
 609                 VectorCopy( mins, mod->mins );
 610                 VectorCopy( maxs, mod->maxs );
 611         }
 612
 613         /* note size */
 614         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 ] );
 615         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 ] );
 616
 617         /* set firsts */
 618         mod->firstBSPSurface = numBSPDrawSurfaces;
 619         mod->firstBSPBrush = numBSPBrushes;
 620 }
 621
 622
 623
 624
 625 /*
 626 EndModel()
 627 finish a model's processing
 628 */
 629
 630 void EndModel( entity_t *e, node_t *headnode )
 631 {
 632         bspModel_t      *mod;
 633
 634
 635         /* note it */
 636         Sys_FPrintf( SYS_VRB, "--- EndModel ---\n" );
 637
 638         /* emit the bsp */
 639         mod = &bspModels[ numBSPModels ];
 640         EmitDrawNode_r( headnode );
 641
 642         /* set surfaces and brushes */
 643         mod->numBSPSurfaces = numBSPDrawSurfaces - mod->firstBSPSurface;
 644         mod->firstBSPBrush = e->firstBrush;
 645         mod->numBSPBrushes = e->numBrushes;
 646
 647         /* increment model count */
 648         numBSPModels++;
 649 }
 650
 651
 652