src/Scenery/tilemgr.cxx

   1 // tilemgr.cxx -- routines to handle dynamic management of scenery tiles
   2 //
   3 // Written by Curtis Olson, started January 1998.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #ifdef HAVE_WINDOWS_H
  29 #  include <windows.h>
  30 #endif
  31
  32 #include <GL/glut.h>
  33 #include <simgear/xgl/xgl.h>
  34
  35 #include <simgear/constants.h>
  36 #include <simgear/debug/logstream.hxx>
  37 #include <simgear/math/fg_geodesy.hxx>
  38 #include <simgear/math/point3d.hxx>
  39 #include <simgear/math/polar3d.hxx>
  40 #include <simgear/math/vector.hxx>
  41
  42 // #include <Aircraft/aircraft.hxx>
  43 #include <Main/options.hxx>
  44 #include <Main/views.hxx>
  45 #include <Objects/obj.hxx>
  46
  47 #ifndef FG_OLD_WEATHER
  48 #  include <WeatherCM/FGLocalWeatherDatabase.h>
  49 #else
  50 #  include <Weather/weather.hxx>
  51 #endif
  52
  53 #include "scenery.hxx"
  54 #include "tilecache.hxx"
  55 #include "tilemgr.hxx"
  56
  57 #define TEST_LAST_HIT_CACHE
  58
  59 extern ssgRoot *scene;
  60 extern ssgBranch *terrain;
  61
  62 // the tile manager
  63 FGTileMgr global_tile_mgr;
  64
  65
  66 // a temporary hack until we get everything rewritten with sgdVec3
  67 static inline Point3D operator + (const Point3D& a, const sgdVec3 b)
  68 {
  69     return Point3D(a.x()+b[0], a.y()+b[1], a.z()+b[2]);
  70 }
  71
  72
  73 // Constructor
  74 FGTileMgr::FGTileMgr ( void ):
  75     state( Start )
  76 {
  77 }
  78
  79
  80 // Destructor
  81 FGTileMgr::~FGTileMgr ( void ) {
  82 }
  83
  84
  85 // Initialize the Tile Manager subsystem
  86 int FGTileMgr::init( void ) {
  87     FG_LOG( FG_TERRAIN, FG_INFO, "Initializing Tile Manager subsystem." );
  88
  89     if ( state != Start ) {
  90         FG_LOG( FG_TERRAIN, FG_INFO,
  91                 "... Reinitializing." );
  92         destroy_queue();
  93     } else {
  94         FG_LOG( FG_TERRAIN, FG_INFO,
  95                 "... First time through." );
  96     }
  97
  98     global_tile_cache.init();
  99     hit_list.clear();
 100
 101     state = Inited;
 102
 103     tile_diameter = current_options.get_tile_diameter();
 104     FG_LOG( FG_TERRAIN, FG_INFO, "Tile Diameter = " << tile_diameter);
 105
 106     previous_bucket.make_bad();
 107     current_bucket.make_bad();
 108
 109     scroll_direction = SCROLL_INIT;
 110     tile_index = -9999;
 111
 112     longitude = latitude = -1000.0;
 113     last_longitude = last_latitude = -1000.0;
 114
 115     return 1;
 116 }
 117
 118
 119 // schedule a tile for loading
 120 int FGTileMgr::sched_tile( const FGBucket& b ) {
 121     // see if tile already exists in the cache
 122     int cache_index = global_tile_cache.exists( b );
 123
 124     if ( cache_index >= 0 ) {
 125         // tile exists in cache, reenable it.
 126         // cout << "REENABLING DISABLED TILE" << endl;
 127         FGTileEntry *t = global_tile_cache.get_tile( cache_index );
 128         t->select_ptr->select( 1 );
 129         t->mark_loaded();
 130     } else {
 131         // find the next available cache entry and mark it as
 132         // scheduled
 133         cache_index = global_tile_cache.next_avail();
 134         FGTileEntry *t = global_tile_cache.get_tile( cache_index );
 135         t->mark_scheduled_for_use();
 136
 137         // register a load request
 138         FGLoadRec request;
 139         request.b = b;
 140         request.cache_index = cache_index;
 141         load_queue.push_back( request );
 142     }
 143
 144     return cache_index;
 145 }
 146
 147
 148 // load a tile
 149 void FGTileMgr::load_tile( const FGBucket& b, int cache_index) {
 150
 151     FG_LOG( FG_TERRAIN, FG_DEBUG, "Loading tile " << b );
 152     global_tile_cache.fill_in(cache_index, b);
 153     FG_LOG( FG_TERRAIN, FG_DEBUG, "Loaded for cache index: " << cache_index );
 154 }
 155
 156
 157 // Determine scenery altitude via ssg.  Normally this just happens
 158 // when we render the scene, but we'd also like to be able to do this
 159 // explicitely.  lat & lon are in radians.  view_pos in current world
 160 // coordinate translated near (0,0,0) (in meters.)  Returns result in
 161 // meters.
 162
 163 bool
 164 FGTileMgr::current_elev_ssg( const Point3D& abs_view_pos,
 165                              const Point3D& view_pos )
 166 {
 167     sgdVec3 orig, dir;
 168
 169     sgdSetVec3(orig, view_pos.x(), view_pos.y(), view_pos.z() );
 170     sgdSetVec3(dir, abs_view_pos.x(), abs_view_pos.y(), abs_view_pos.z() );
 171
 172     hit_list.Intersect( terrain, orig, dir );
 173
 174     int this_hit=0;
 175     Point3D geoc;
 176     double result = -9999;
 177
 178     int hitcount = hit_list.num_hits();
 179     for ( int i = 0; i < hitcount; ++i ) {
 180         geoc = fgCartToPolar3d( scenery.center + hit_list.get_point(i) );
 181         double lat_geod, alt, sea_level_r;
 182         fgGeocToGeod(geoc.lat(), geoc.radius(), &lat_geod,
 183                      &alt, &sea_level_r);
 184         if ( alt > result && alt < 10000 ) {
 185             result = alt;
 186             this_hit = i;
 187         }
 188     }
 189
 190     if ( result > -9000 ) {
 191         scenery.cur_elev = result;
 192         scenery.cur_radius = geoc.radius();
 193         sgVec3 tmp;
 194         sgSetVec3(tmp, hit_list.get_normal(this_hit));
 195         current_view.CurrentNormalInLocalPlane(tmp, tmp);
 196         sgdSetVec3( scenery.cur_normal, tmp );
 197         // cout << "NED: " << tmp[0] << " " << tmp[1] << " " << tmp[2] << endl;
 198         return true;
 199     } else {
 200         FG_LOG( FG_TERRAIN, FG_INFO, "no terrain intersection" );
 201         scenery.cur_elev = 0.0;
 202         float *up = current_view.local_up;
 203         sgdSetVec3(scenery.cur_normal, up[0], up[1], up[2]);
 204         return false;
 205     }
 206 }
 207
 208
 209 FGBucket FGTileMgr::BucketOffset( int dx, int dy )
 210 {
 211     double clat, clon, span;
 212     if( scroll_direction == SCROLL_INIT ) {
 213         // use current latitude and longitude
 214         // walk dy units in the lat direction
 215         clat = current_bucket.get_center_lat() + dy * FG_BUCKET_SPAN;
 216
 217         // find the lon span for the new latitude
 218         span = bucket_span( clat );
 219
 220         // walk dx units in the lon direction
 221         clon = longitude + dx * span;
 222     } else      {
 223         // use previous latitude and longitude
 224         // walk dy units in the lat direction
 225         clat = previous_bucket.get_center_lat() + dy * FG_BUCKET_SPAN;
 226
 227         // find the lon span for the new latitude
 228         span = bucket_span( clat );
 229
 230         // walk dx units in the lon direction
 231         clon = last_longitude + dx * span;
 232     }
 233
 234     while ( clon < -180.0 ) clon += 360.0;
 235     while ( clon >= 180.0 ) clon -= 360.0;
 236     pending.set_bucket( clon, clat );
 237
 238     FG_LOG( FG_TERRAIN, FG_DEBUG, "    fgBucketOffset " << pending );
 239     return pending;
 240 }
 241
 242
 243 // schedule a tile row(column) for loading
 244 void FGTileMgr::scroll( void )
 245 {
 246     FG_LOG( FG_TERRAIN, FG_DEBUG, "schedule_row: Scrolling" );
 247
 248     int i, dw, dh;
 249
 250     switch( scroll_direction ) {
 251     case SCROLL_NORTH:
 252         FG_LOG( FG_TERRAIN, FG_DEBUG,
 253                 "  (North) Loading " << tile_diameter << " tiles" );
 254         dw = tile_diameter / 2;
 255         dh = dw + 1;
 256         for ( i = 0; i < tile_diameter; i++ ) {
 257             sched_tile( BucketOffset( i - dw, dh ) );
 258         }
 259         break;
 260     case SCROLL_EAST:
 261         FG_LOG( FG_TERRAIN, FG_DEBUG,
 262                 "  (East) Loading " << tile_diameter << " tiles" );
 263         dh = tile_diameter / 2;
 264         dw = dh + 1;
 265         for ( i = 0; i < tile_diameter; i++ ) {
 266             sched_tile( BucketOffset( dw, i - dh ) );
 267         }
 268         break;
 269     case SCROLL_SOUTH:
 270         FG_LOG( FG_TERRAIN, FG_DEBUG,
 271                 "  (South) Loading " << tile_diameter << " tiles" );
 272         dw = tile_diameter / 2;
 273         dh = -dw - 1;
 274         for ( i = 0; i < tile_diameter; i++ ) {
 275             sched_tile( BucketOffset( i - dw, dh ) );
 276         }
 277         break;
 278     case SCROLL_WEST:
 279         FG_LOG( FG_TERRAIN, FG_DEBUG,
 280                 "  (West) Loading " << tile_diameter << " tiles" );
 281         dh = tile_diameter / 2;
 282         dw = -dh - 1;
 283         for ( i = 0; i < tile_diameter; i++ ) {
 284             sched_tile( BucketOffset( dw, i - dh ) );
 285         }
 286         break;
 287     default:
 288         FG_LOG( FG_TERRAIN, FG_WARN, "UNKNOWN SCROLL DIRECTION in schedule_row" );
 289         ;
 290     }
 291     FG_LOG( FG_TERRAIN, FG_DEBUG, "\tschedule_row returns" );
 292 }
 293
 294
 295 void FGTileMgr::initialize_queue()
 296 {
 297     // First time through or we have teleported, initialize the
 298     // system and load all relavant tiles
 299
 300     FG_LOG( FG_TERRAIN, FG_INFO, "Updating Tile list for " << current_bucket );
 301     FG_LOG( FG_TERRAIN, FG_INFO, "  Updating Tile list for " << current_bucket );
 302     FG_LOG( FG_TERRAIN, FG_INFO, "  Loading "
 303             << tile_diameter * tile_diameter << " tiles" );
 304
 305     int i;
 306     scroll_direction = SCROLL_INIT;
 307
 308     // wipe/initialize tile cache
 309     global_tile_cache.init();
 310     previous_bucket.make_bad();
 311
 312     // build the local area list and schedule tiles for loading
 313
 314     // start with the center tile and work out in concentric
 315     // "rings"
 316
 317     sched_tile( current_bucket );
 318
 319     for ( i = 3; i <= tile_diameter; i = i + 2 ) {
 320         int j;
 321         int span = i / 2;
 322
 323         // bottom row
 324         for ( j = -span; j <= span; ++j ) {
 325             sched_tile( BucketOffset( j, -span ) );
 326         }
 327
 328         // top row
 329         for ( j = -span; j <= span; ++j ) {
 330             sched_tile( BucketOffset( j, span ) );
 331         }
 332
 333         // middle rows
 334         for ( j = -span + 1; j <= span - 1; ++j ) {
 335             sched_tile( BucketOffset( -span, j ) );
 336             sched_tile( BucketOffset( span, j ) );
 337         }
 338
 339     }
 340
 341     // Now force a load of the center tile and inner ring so we
 342     // have something to see in our first frame.
 343     for ( i = 0; i < 9; ++i ) {
 344         if ( load_queue.size() ) {
 345             FG_LOG( FG_TERRAIN, FG_DEBUG,
 346                     "Load queue not empty, loading a tile" );
 347
 348             FGLoadRec pending = load_queue.front();
 349             load_queue.pop_front();
 350             load_tile( pending.b, pending.cache_index );
 351         }
 352     }
 353 }
 354
 355
 356 // forced emptying of the queue
 357 // This is necessay to keep bookeeping straight for the
 358 // tile_cache   -- which actually handles all the
 359 // (de)allocations
 360 void FGTileMgr::destroy_queue() {
 361     while( load_queue.size() ) {
 362         FG_LOG( FG_TERRAIN, FG_INFO,
 363                 "Load queue not empty, popping a tile" );
 364         FGLoadRec pending = load_queue.front();
 365         load_queue.pop_front();
 366         FGTileEntry *t = global_tile_cache.get_tile( pending.cache_index );
 367         // just t->mark_unused() should be enough
 368         // but a little paranoia doesn't hurt us here
 369         if(t->is_scheduled_for_use())
 370             t->mark_unused();
 371         else
 372             load_tile( pending.b, pending.cache_index );
 373     }
 374 }
 375
 376
 377 // given the current lon/lat (in degrees), fill in the array of local
 378 // chunks.  If the chunk isn't already in the cache, then read it from
 379 // disk.
 380 int FGTileMgr::update( double lon, double lat ) {
 381     // FG_LOG( FG_TERRAIN, FG_DEBUG, "FGTileMgr::update()" );
 382
 383     // FGInterface *f = current_aircraft.fdm_state;
 384
 385     // lonlat for this update
 386     // longitude = f->get_Longitude() * RAD_TO_DEG;
 387     // latitude = f->get_Latitude() * RAD_TO_DEG;
 388     longitude = lon;
 389     latitude = lat;
 390     // FG_LOG( FG_TERRAIN, FG_DEBUG, "lon "<< lonlat[LON] <<
 391     //      " lat " << lonlat[LAT] );
 392
 393     current_bucket.set_bucket( longitude, latitude );
 394     // FG_LOG( FG_TERRAIN, FG_DEBUG, "Updating Tile list for " << current_bucket );
 395
 396     tile_index = global_tile_cache.exists(current_bucket);
 397     // FG_LOG( FG_TERRAIN, FG_DEBUG, "tile index " << tile_index );
 398
 399     if ( tile_index >= 0 ) {
 400         current_tile = global_tile_cache.get_tile(tile_index);
 401         scenery.next_center = current_tile->center;
 402     } else {
 403         FG_LOG( FG_TERRAIN, FG_WARN, "Tile not found (Ok if initializing)" );
 404     }
 405
 406     if ( state == Running ) {
 407         if( current_bucket == previous_bucket) {
 408             FG_LOG( FG_TERRAIN, FG_DEBUG, "Same bucket as last time" );
 409             scroll_direction = SCROLL_NONE;
 410         } else {
 411             // We've moved to a new bucket, we need to scroll our
 412             // structures, and load in the new tiles
 413             // CURRENTLY THIS ASSUMES WE CAN ONLY MOVE TO ADJACENT TILES.
 414             // AT ULTRA HIGH SPEEDS THIS ASSUMPTION MAY NOT BE VALID IF
 415             // THE AIRCRAFT CAN SKIP A TILE IN A SINGLE ITERATION.
 416
 417             if ( (current_bucket.get_lon() > previous_bucket.get_lon()) ||
 418                  ( (current_bucket.get_lon() == previous_bucket.get_lon()) &&
 419                    (current_bucket.get_x() > previous_bucket.get_x()) ) )
 420                 {
 421                     scroll_direction = SCROLL_EAST;
 422                 }
 423             else if ( (current_bucket.get_lon() < previous_bucket.get_lon()) ||
 424                       ( (current_bucket.get_lon() == previous_bucket.get_lon()) &&
 425                         (current_bucket.get_x() < previous_bucket.get_x()) ) )
 426                 {
 427                     scroll_direction = SCROLL_WEST;
 428                 }
 429
 430             if ( (current_bucket.get_lat() > previous_bucket.get_lat()) ||
 431                  ( (current_bucket.get_lat() == previous_bucket.get_lat()) &&
 432                    (current_bucket.get_y() > previous_bucket.get_y()) ) )
 433                 {
 434                     scroll_direction = SCROLL_NORTH;
 435                 }
 436             else if ( (current_bucket.get_lat() < previous_bucket.get_lat()) ||
 437                       ( (current_bucket.get_lat() == previous_bucket.get_lat()) &&
 438                         (current_bucket.get_y() < previous_bucket.get_y()) ) )
 439                 {
 440                     scroll_direction = SCROLL_SOUTH;
 441                 }
 442
 443             scroll();
 444         }
 445
 446     } else if ( state == Start || state == Inited ) {
 447         initialize_queue();
 448         state = Running;
 449     }
 450
 451     if ( load_queue.size() ) {
 452         FG_LOG( FG_TERRAIN, FG_DEBUG, "Load queue not empty, loading a tile" );
 453
 454         FGLoadRec pending = load_queue.front();
 455         load_queue.pop_front();
 456         load_tile( pending.b, pending.cache_index );
 457     }
 458
 459     if ( scenery.center == Point3D(0.0) ) {
 460         // initializing
 461         // cout << "initializing ... " << endl;
 462         Point3D geod_pos = Point3D( longitude * DEG_TO_RAD,
 463                                     latitude * DEG_TO_RAD,
 464                                     0.0);
 465         Point3D tmp_abs_view_pos = fgGeodToCart( geod_pos );
 466         scenery.center = tmp_abs_view_pos;
 467         // cout << "abs_view_pos = " << tmp_abs_view_pos << endl;
 468         prep_ssg_nodes();
 469         current_elev_ssg( tmp_abs_view_pos,
 470                           Point3D( 0.0 ) );
 471     } else {
 472         // cout << "abs view pos = " << current_view.abs_view_pos
 473         //      << " view pos = " << current_view.view_pos << endl;
 474         current_elev_ssg( current_view.abs_view_pos,
 475                           current_view.view_pos );
 476     }
 477
 478     // cout << "current elevation (ssg) == " << scenery.cur_elev << endl;
 479
 480     previous_bucket = current_bucket;
 481     last_longitude = longitude;
 482     last_latitude  = latitude;
 483
 484     return 1;
 485 }
 486
 487 // Prepare the ssg nodes ... for each tile, set it's proper
 488 // transform and update it's range selector based on current
 489 // visibilty
 490 void FGTileMgr::prep_ssg_node( int idx ) {
 491 }
 492
 493 void FGTileMgr::prep_ssg_nodes( void ) {
 494     FGTileEntry *t;
 495     float ranges[2];
 496     ranges[0] = 0.0f;
 497     double vis = 0.0;
 498
 499 #ifndef FG_OLD_WEATHER
 500     if ( WeatherDatabase != NULL ) {
 501         vis = WeatherDatabase->getWeatherVisibility();
 502     } else {
 503         vis = 16000;
 504     }
 505 #else
 506     vis = current_weather.get_visibility();
 507 #endif
 508     // cout << "visibility = " << vis << endl;
 509
 510     // traverse the potentially viewable tile list and update range
 511     // selector and transform
 512     for ( int i = 0; i < (int)global_tile_cache.get_size(); i++ ) {
 513         t = global_tile_cache.get_tile( i );
 514
 515         if ( t->is_loaded() ) {
 516             // set range selector (LOD trick) to be distance to center
 517             // of tile + bounding radius
 518
 519             ranges[1] = vis + t->bounding_radius;
 520             t->range_ptr->setRanges( ranges, 2 );
 521
 522             // calculate tile offset
 523             t->SetOffset( scenery.center );
 524
 525             // calculate ssg transform
 526             sgCoord sgcoord;
 527             sgSetCoord( &sgcoord,
 528                         t->offset.x(), t->offset.y(), t->offset.z(),
 529                         0.0, 0.0, 0.0 );
 530             t->transform_ptr->setTransform( &sgcoord );
 531         }
 532     }
 533 }