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
  34 #include <plib/ssg.h>
  35
  36 #include <simgear/constants.h>
  37 #include <simgear/debug/logstream.hxx>
  38 #include <simgear/math/point3d.hxx>
  39 #include <simgear/math/polar3d.hxx>
  40 #include <simgear/math/sg_geodesy.hxx>
  41 #include <simgear/math/vector.hxx>
  42
  43 #include <Main/globals.hxx>
  44 #include <Main/viewer.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 "newcache.hxx"
  54 #include "scenery.hxx"
  55 #include "tilemgr.hxx"
  56
  57 #define TEST_LAST_HIT_CACHE
  58
  59 extern ssgRoot *scene;
  60 extern ssgBranch *terrain;
  61 extern ssgBranch *ground;
  62
  63 // the tile manager
  64 FGTileMgr global_tile_mgr;
  65
  66
  67 #ifdef ENABLE_THREADS
  68 SGLockedQueue<FGTileEntry *> FGTileMgr::attach_queue;
  69 SGLockedQueue<FGDeferredModel *> FGTileMgr::model_queue;
  70 #else
  71 queue<FGTileEntry *> FGTileMgr::attach_queue;
  72 queue<FGDeferredModel *> FGTileMgr::model_queue;
  73 #endif // ENABLE_THREADS
  74
  75
  76 // Constructor
  77 FGTileMgr::FGTileMgr():
  78     state( Start ),
  79     vis( 16000 ),
  80     counter_hack(0)
  81 {
  82 }
  83
  84
  85 // Destructor
  86 FGTileMgr::~FGTileMgr() {
  87 }
  88
  89
  90 // Initialize the Tile Manager subsystem
  91 int FGTileMgr::init() {
  92     SG_LOG( SG_TERRAIN, SG_INFO, "Initializing Tile Manager subsystem." );
  93
  94     tile_cache.init();
  95
  96 #if 0
  97
  98     // instead it's just a lot easier to let any pending work flush
  99     // through, rather than trying to arrest the queue and nuke all
 100     // the various work at all the various stages and get everything
 101     // cleaned up properly.
 102
 103     while ( ! attach_queue.empty() ) {
 104         attach_queue.pop();
 105     }
 106
 107     while ( ! model_queue.empty() ) {
 108 #ifdef ENABLE_THREADS
 109         FGDeferredModel* dm = model_queue.pop();
 110 #else
 111         FGDeferredModel* dm = model_queue.front();
 112         model_queue.pop();
 113 #endif
 114         delete dm;
 115     }
 116     loader.reinit();
 117 #endif
 118
 119     hit_list.clear();
 120
 121     state = Inited;
 122
 123     previous_bucket.make_bad();
 124     current_bucket.make_bad();
 125
 126     longitude = latitude = -1000.0;
 127     last_longitude = last_latitude = -1000.0;
 128
 129     return 1;
 130 }
 131
 132
 133 // schedule a tile for loading
 134 void FGTileMgr::sched_tile( const SGBucket& b ) {
 135     // see if tile already exists in the cache
 136     FGTileEntry *t = tile_cache.get_tile( b );
 137
 138     if ( t == NULL ) {
 139         // create a new entry
 140         FGTileEntry *e = new FGTileEntry( b );
 141
 142         // insert the tile into the cache
 143         if ( tile_cache.insert_tile( e ) ) {
 144           // Schedule tile for loading
 145           loader.add( e );
 146         } else {
 147           // insert failed (cache full with no available entries to
 148           // delete.)  Try again later
 149           delete e;
 150         }
 151     }
 152 }
 153
 154
 155 // schedule a needed buckets for loading
 156 void FGTileMgr::schedule_needed() {
 157     // sanity check (unfortunately needed!)
 158     if ( longitude < -180.0 || longitude > 180.0
 159          || latitude < -90.0 || latitude > 90.0 )
 160     {
 161         SG_LOG( SG_TERRAIN, SG_ALERT,
 162                 "Attempting to schedule tiles for bogus latitude and" );
 163         SG_LOG( SG_TERRAIN, SG_ALERT,
 164                 "longitude.  This is a FATAL error.  Exiting!" );
 165         exit(-1);
 166     }
 167
 168    SG_LOG( SG_TERRAIN, SG_INFO,
 169            "scheduling needed tiles for " << longitude << " " << latitude );
 170
 171 #ifndef FG_OLD_WEATHER
 172     if ( WeatherDatabase != NULL ) {
 173         vis = WeatherDatabase->getWeatherVisibility();
 174     } else {
 175         vis = 16000;
 176     }
 177 #else
 178     vis = current_weather.get_visibility();
 179 #endif
 180     // cout << "visibility = " << vis << endl;
 181
 182     double tile_width = current_bucket.get_width_m();
 183     double tile_height = current_bucket.get_height_m();
 184     // cout << "tile width = " << tile_width << "  tile_height = "
 185     //      << tile_height !<< endl;
 186
 187     xrange = (int)(vis / tile_width) + 1;
 188     yrange = (int)(vis / tile_height) + 1;
 189     if ( xrange < 1 ) { xrange = 1; }
 190     if ( yrange < 1 ) { yrange = 1; }
 191     // cout << "xrange = " << xrange << "  yrange = " << yrange << endl;
 192
 193     tile_cache.set_max_cache_size( (2*xrange + 2) * (2*yrange + 2) );
 194
 195     SGBucket b;
 196
 197     // schedule center tile first so it can be loaded first
 198     b = sgBucketOffset( longitude, latitude, 0, 0 );
 199     sched_tile( b );
 200
 201     int x, y;
 202
 203     // schedule next ring of 8 tiles
 204     for ( x = -1; x <= 1; ++x ) {
 205         for ( y = -1; y <= 1; ++y ) {
 206             if ( x != 0 || y != 0 ) {
 207                 b = sgBucketOffset( longitude, latitude, x, y );
 208                 sched_tile( b );
 209             }
 210         }
 211     }
 212
 213     // schedule remaining tiles
 214     for ( x = -xrange; x <= xrange; ++x ) {
 215         for ( y = -yrange; y <= yrange; ++y ) {
 216             if ( x < -1 || x > 1 || y < -1 || y > 1 ) {
 217                 SGBucket b = sgBucketOffset( longitude, latitude, x, y );
 218                 sched_tile( b );
 219             }
 220         }
 221     }
 222 }
 223
 224
 225 void FGTileMgr::initialize_queue()
 226 {
 227     // First time through or we have teleported, initialize the
 228     // system and load all relavant tiles
 229
 230     SG_LOG( SG_TERRAIN, SG_INFO, "Updating Tile list for " << current_bucket );
 231     // cout << "tile cache size = " << tile_cache.get_size() << endl;
 232
 233     // wipe/initialize tile cache
 234     // tile_cache.init();
 235     previous_bucket.make_bad();
 236
 237     // build the local area list and schedule tiles for loading
 238
 239     // start with the center tile and work out in concentric
 240     // "rings"
 241
 242     schedule_needed();
 243
 244     // do we really want to lose this? CLO
 245 #if 0
 246     // Now force a load of the center tile and inner ring so we
 247     // have something to see in our first frame.
 248     int i;
 249     for ( i = 0; i < 9; ++i ) {
 250         if ( load_queue.size() ) {
 251             SG_LOG( SG_TERRAIN, SG_DEBUG,
 252                     "Load queue not empty, loading a tile" );
 253
 254             SGBucket pending = load_queue.front();
 255             load_queue.pop_front();
 256             load_tile( pending );
 257         }
 258     }
 259 #endif
 260 }
 261
 262
 263 // given the current lon/lat (in degrees), fill in the array of local
 264 // chunks.  If the chunk isn't already in the cache, then read it from
 265 // disk.
 266 int FGTileMgr::update( double lon, double lat ) {
 267     // SG_LOG( SG_TERRAIN, SG_DEBUG, "FGTileMgr::update() for "
 268     //         << lon << " " << lat );
 269
 270     longitude = lon;
 271     latitude = lat;
 272     // SG_LOG( SG_TERRAIN, SG_DEBUG, "lon "<< lonlat[LON] <<
 273     //      " lat " << lonlat[LAT] );
 274
 275     current_bucket.set_bucket( longitude, latitude );
 276     // SG_LOG( SG_TERRAIN, SG_DEBUG, "Updating Tile list for " << current_bucket );
 277
 278     if ( tile_cache.exists( current_bucket ) ) {
 279         current_tile = tile_cache.get_tile( current_bucket );
 280         scenery.set_next_center( current_tile->center );
 281     } else {
 282         SG_LOG( SG_TERRAIN, SG_WARN, "Tile not found (Ok if initializing)" );
 283     }
 284
 285     if ( state == Running ) {
 286         SG_LOG( SG_TERRAIN, SG_DEBUG, "State == Running" );
 287         if ( !(current_bucket == previous_bucket) ) {
 288             // We've moved to a new bucket, we need to schedule any
 289             // needed tiles for loading.
 290             schedule_needed();
 291         }
 292     } else if ( state == Start || state == Inited ) {
 293         SG_LOG( SG_TERRAIN, SG_INFO, "State == Start || Inited" );
 294         initialize_queue();
 295         state = Running;
 296
 297         // load the next tile in the load queue (or authorize the next
 298         // load in the case of the threaded tile pager)
 299         loader.update();
 300     }
 301
 302     // load the next model in the load queue.  Currently this must
 303     // happen in the render thread because model loading can trigger
 304     // texture loading which involves use of the opengl api.
 305     if ( !model_queue.empty() ) {
 306         cout << "loading next model ..." << endl;
 307         // load the next tile in the queue
 308 #ifdef ENABLE_THREADS
 309         FGDeferredModel* dm = model_queue.pop();
 310 #else
 311         FGDeferredModel* dm = model_queue.front();
 312         model_queue.pop();
 313 #endif
 314
 315         ssgTexturePath( (char *)(dm->get_texture_path().c_str()) );
 316         ssgEntity *obj_model
 317             = ssgLoad( (char *)(dm->get_model_path().c_str()) );
 318         if ( obj_model != NULL ) {
 319             dm->get_obj_trans()->addKid( obj_model );
 320         }
 321         dm->get_tile()->dec_pending_models();
 322
 323         delete dm;
 324     }
 325
 326     // cout << "current elevation (ssg) == " << scenery.get_cur_elev() << endl;
 327
 328     previous_bucket = current_bucket;
 329     last_longitude = longitude;
 330     last_latitude  = latitude;
 331
 332     // activate loader thread one out of every 5 frames
 333     if ( counter_hack == 0 ) {
 334         // Notify the tile loader that it can load another tile
 335         loader.update();
 336
 337     }
 338     counter_hack = (counter_hack + 1) % 5;
 339
 340     if ( !attach_queue.empty() ) {
 341 #ifdef ENABLE_THREADS
 342         FGTileEntry* e = attach_queue.pop();
 343 #else
 344         FGTileEntry* e = attach_queue.front();
 345         attach_queue.pop();
 346 #endif
 347         e->add_ssg_nodes( terrain, ground );
 348         // cout << "Adding ssg nodes for "
 349     }
 350
 351     sgdVec3 sc;
 352     sgdSetVec3( sc,
 353                 scenery.get_center()[0],
 354                 scenery.get_center()[1],
 355                 scenery.get_center()[2] );
 356
 357 #if 0
 358     if ( scenery.center == Point3D(0.0) ) {
 359         // initializing
 360         cout << "initializing scenery current elevation ... " << endl;
 361         sgdVec3 tmp_abs_view_pos;
 362
 363         Point3D geod_pos = Point3D( longitude * SGD_DEGREES_TO_RADIANS,
 364                                     latitude * SGD_DEGREES_TO_RADIANS,
 365                                     0.0);
 366         Point3D tmp = sgGeodToCart( geod_pos );
 367         scenery.center = tmp;
 368         sgdSetVec3( tmp_abs_view_pos, tmp.x(), tmp.y(), tmp.z() );
 369
 370         // cout << "abs_view_pos = " << tmp_abs_view_pos << endl;
 371         prep_ssg_nodes();
 372
 373         double tmp_elev;
 374         if ( fgCurrentElev(tmp_abs_view_pos, sc, &hit_list,
 375                            &tmp_elev, &scenery.cur_radius, scenery.cur_normal) )
 376         {
 377             scenery.set_cur_elev( tmp_elev );
 378         } else {
 379             scenery.set_cur_elev( 0.0 );
 380         }
 381         cout << "result = " << scenery.get_cur_elev() << endl;
 382     } else {
 383 #endif
 384         // cout << "abs view pos = " << current_view.abs_view_pos
 385         //      << " view pos = " << current_view.view_pos << endl;
 386         double tmp_elev;
 387         double tmp_radius;
 388         sgdVec3 tmp_normal;
 389         if ( fgCurrentElev(globals->get_current_view()->get_abs_view_pos(),
 390                            sc, &hit_list,
 391                            &tmp_elev, &tmp_radius, tmp_normal) )
 392         {
 393             scenery.set_cur_elev( tmp_elev );
 394             scenery.set_cur_radius( tmp_radius );
 395             scenery.set_cur_normal( tmp_normal );
 396         } else {
 397             scenery.set_cur_elev( -9999.0 );
 398         }
 399         // cout << "Current elevation = " << scenery.get_cur_elev() << endl;
 400 #if 0
 401     }
 402 #endif
 403
 404     return 1;
 405 }
 406
 407
 408 void FGTileMgr::prep_ssg_nodes() {
 409     float vis = 0.0;
 410
 411 #ifndef FG_OLD_WEATHER
 412     if ( WeatherDatabase ) {
 413         vis = WeatherDatabase->getWeatherVisibility();
 414     } else {
 415         vis = 16000;
 416     }
 417 #else
 418     vis = current_weather.get_visibility();
 419 #endif
 420     // cout << "visibility = " << vis << endl;
 421
 422     // traverse the potentially viewable tile list and update range
 423     // selector and transform
 424
 425     FGTileEntry *e;
 426     tile_cache.reset_traversal();
 427
 428     while ( ! tile_cache.at_end() ) {
 429         // cout << "processing a tile" << endl;
 430         if ( (e = tile_cache.get_current()) ) {
 431             e->prep_ssg_node( scenery.get_center(), vis);
 432         } else {
 433             cout << "warning ... empty tile in cache" << endl;
 434         }
 435         tile_cache.next();
 436    }
 437 }