src/Scenery/tilecache.cxx

   1 // tilecache.cxx -- routines to handle scenery tile caching
   2 //
   3 // Written by Curtis Olson, started January 1998.
   4 //
   5 // Copyright (C) 1998 - 2000  Curtis L. Olson  - curt@flightgear.org
   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 <plib/ssg.h>           // plib include
  36
  37 #include <simgear/bucket/newbucket.hxx>
  38 #include <simgear/debug/logstream.hxx>
  39 #include <simgear/misc/fgstream.hxx>
  40 #include <simgear/misc/fgpath.hxx>
  41
  42 #include <Main/options.hxx>
  43 #include <Main/views.hxx>
  44 #include <Objects/obj.hxx>
  45 #include <Scenery/scenery.hxx>  // for scenery.center
  46
  47 #include "tilecache.hxx"
  48 #include "tileentry.hxx"
  49
  50 FG_USING_NAMESPACE(std);
  51
  52 // a cheesy hack (to be fixed later)
  53 extern ssgBranch *terrain;
  54 extern ssgEntity *penguin;
  55
  56
  57 // the tile cache
  58 FGTileCache global_tile_cache;
  59
  60
  61 // Constructor
  62 FGTileCache::FGTileCache( void ) {
  63     tile_cache.clear();
  64 }
  65
  66
  67 // Initialize the tile cache subsystem
  68 void
  69 FGTileCache::init( void )
  70 {
  71     int i;
  72
  73     FG_LOG( FG_TERRAIN, FG_INFO, "Initializing the tile cache." );
  74
  75     // expand cache if needed.  For best results ... i.e. to avoid
  76     // tile load problems and blank areas:
  77     //
  78     //   target_cache_size >= (current.options.tile_diameter + 1) ** 2
  79     //
  80     int side = current_options.get_tile_diameter() + 2;
  81     int target_cache_size = (side*side);
  82     FG_LOG( FG_TERRAIN, FG_DEBUG, "  target cache size = "
  83             << target_cache_size );
  84     FG_LOG( FG_TERRAIN, FG_DEBUG, "  current cache size = "
  85             << tile_cache.size() );
  86     FGTileEntry e;
  87     e.mark_unused();
  88     e.vec3_ptrs.clear();
  89     e.vec2_ptrs.clear();
  90     e.index_ptrs.clear();
  91
  92     FG_LOG( FG_TERRAIN, FG_DEBUG, "  size of tile = "
  93             << sizeof( e ) );
  94     if ( target_cache_size > (int)tile_cache.size() ) {
  95         // FGTileEntry e;
  96         int expansion_amt = target_cache_size - (int)tile_cache.size();
  97         for ( i = 0; i < expansion_amt; ++i ) {
  98             tile_cache.push_back( e );
  99             FG_LOG( FG_TERRAIN, FG_DEBUG, "  expanding cache size = "
 100                     << tile_cache.size() );
 101         }
 102     }
 103     FG_LOG( FG_TERRAIN, FG_DEBUG, "  done expanding cache, size = "
 104             << tile_cache.size() );
 105
 106     for ( i = 0; i < (int)tile_cache.size(); i++ ) {
 107         if ( !tile_cache[i].is_unused() ) {
 108             entry_free(i);
 109         }
 110         tile_cache[i].mark_unused();
 111         tile_cache[i].tile_bucket.make_bad();
 112     }
 113
 114     // and ... just in case we missed something ...
 115     terrain->removeAllKids();
 116
 117     FG_LOG( FG_TERRAIN, FG_DEBUG, "  done with init()"  );
 118 }
 119
 120
 121 // Search for the specified "bucket" in the cache
 122 int
 123 FGTileCache::exists( const FGBucket& p )
 124 {
 125     int i;
 126
 127     for ( i = 0; i < (int)tile_cache.size(); i++ ) {
 128         if ( tile_cache[i].tile_bucket == p ) {
 129             FG_LOG( FG_TERRAIN, FG_DEBUG,
 130                     "TILE EXISTS in cache ... index = " << i );
 131             return( i );
 132         }
 133     }
 134
 135     return( -1 );
 136 }
 137
 138
 139 #if 0
 140 static void print_refs( ssgSelector *sel, ssgTransform *trans,
 141                  ssgRangeSelector *range)
 142 {
 143     cout << "selector -> " << sel->getRef()
 144          << "  transform -> " << trans->getRef()
 145          << "  range -> " << range->getRef() << endl;
 146 }
 147 #endif
 148
 149
 150 // Fill in a tile cache entry with real data for the specified bucket
 151 void
 152 FGTileCache::fill_in( int index, const FGBucket& p )
 153 {
 154     // cout << "FILL IN CACHE ENTRY = " << index << endl;
 155
 156     tile_cache[index].center = Point3D( 0.0 );
 157     if ( tile_cache[index].vec3_ptrs.size() ||
 158          tile_cache[index].vec2_ptrs.size() ||
 159          tile_cache[index].index_ptrs.size() )
 160     {
 161         FG_LOG( FG_TERRAIN, FG_ALERT,
 162                 "Attempting to overwrite existing or"
 163                 << " not properly freed leaf data." );
 164         exit(-1);
 165     }
 166
 167     tile_cache[index].select_ptr = new ssgSelector;
 168     tile_cache[index].transform_ptr = new ssgTransform;
 169     tile_cache[index].range_ptr = new ssgRangeSelector;
 170     tile_cache[index].tile_bucket = p;
 171
 172     FGPath tile_path( current_options.get_fg_scenery() );
 173     tile_path.append( p.gen_base_path() );
 174
 175     // Load the appropriate data file
 176     FGPath tile_base = tile_path;
 177     tile_base.append( p.gen_index_str() );
 178     ssgBranch *new_tile = fgObjLoad( tile_base.str(), &tile_cache[index],
 179                                      true );
 180
 181     if ( new_tile != NULL ) {
 182         tile_cache[index].range_ptr->addKid( new_tile );
 183     }
 184
 185     // load custom objects
 186     cout << "CUSTOM OBJECTS" << endl;
 187
 188     FGPath index_path = tile_path;
 189     index_path.append( p.gen_index_str() );
 190     index_path.concat( ".ind" );
 191
 192     cout << "Looking in " << index_path.str() << endl;
 193
 194     fg_gzifstream in( index_path.str() );
 195
 196     if ( in.is_open() ) {
 197         string token, name;
 198
 199         while ( ! in.eof() ) {
 200             in >> token;
 201             in >> name;
 202 #if defined ( MACOS ) || defined ( _MSC_VER )
 203             in >> ::skipws;
 204 #else
 205             in >> skipws;
 206 #endif
 207             cout << "token = " << token << " name = " << name << endl;
 208
 209             FGPath custom_path = tile_path;
 210             custom_path.append( name );
 211             ssgBranch *custom_obj = fgObjLoad( custom_path.str(),
 212                                                &tile_cache[index], false );
 213             if ( (new_tile != NULL) && (custom_obj != NULL) ) {
 214                 new_tile -> addKid( custom_obj );
 215             }
 216         }
 217     }
 218
 219     tile_cache[index].transform_ptr->addKid( tile_cache[index].range_ptr );
 220
 221     // calculate initial tile offset
 222     tile_cache[index].SetOffset( scenery.center );
 223     sgCoord sgcoord;
 224     sgSetCoord( &sgcoord,
 225                 tile_cache[index].offset.x(),
 226                 tile_cache[index].offset.y(), tile_cache[index].offset.z(),
 227                 0.0, 0.0, 0.0 );
 228     tile_cache[index].transform_ptr->setTransform( &sgcoord );
 229
 230     tile_cache[index].select_ptr->addKid( tile_cache[index].transform_ptr );
 231     terrain->addKid( tile_cache[index].select_ptr );
 232
 233     if ( tile_cache[index].is_scheduled_for_cache() ) {
 234         // cout << "FOUND ONE SCHEDULED FOR CACHE" << endl;
 235         // load, but not needed now so disable
 236         tile_cache[index].mark_loaded();
 237         tile_cache[index].ssg_disable();
 238         tile_cache[index].select_ptr->select(0);
 239     } else {
 240         // cout << "FOUND ONE READY TO LOAD" << endl;
 241         tile_cache[index].mark_loaded();
 242         tile_cache[index].select_ptr->select(1);
 243     }
 244 }
 245
 246
 247 // Free a tile cache entry
 248 void
 249 FGTileCache::entry_free( int cache_index )
 250 {
 251     // cout << "FREEING CACHE ENTRY = " << cache_index << endl;
 252     tile_cache[cache_index].free_tile();
 253 }
 254
 255
 256 // Return index of next available slot in tile cache
 257 int
 258 FGTileCache::next_avail( void )
 259 {
 260     // Point3D delta;
 261     Point3D abs_view_pos;
 262     int i;
 263     // float max, med, min, tmp;
 264     float dist, max_dist;
 265     int max_index;
 266
 267     max_dist = 0.0;
 268     max_index = -1;
 269
 270     for ( i = 0; i < (int)tile_cache.size(); i++ ) {
 271         // only look at freeing NON-scheduled (i.e. ready to load
 272         // cache entries.  This assumes that the cache is always big
 273         // enough for our tile radius!
 274
 275         if ( tile_cache[i].is_unused() ) {
 276             // favor unused cache slots
 277             return(i);
 278         } else if ( tile_cache[i].is_loaded() || tile_cache[i].is_cached() ) {
 279             // calculate approximate distance from view point
 280             abs_view_pos = current_view.get_abs_view_pos();
 281
 282             FG_LOG( FG_TERRAIN, FG_DEBUG,
 283                     "DIST Abs view pos = " << abs_view_pos );
 284             FG_LOG( FG_TERRAIN, FG_DEBUG,
 285                     "    ref point = " << tile_cache[i].center );
 286
 287             /*
 288             delta.setx( fabs(tile_cache[i].center.x() - abs_view_pos.x() ) );
 289             delta.sety( fabs(tile_cache[i].center.y() - abs_view_pos.y() ) );
 290             delta.setz( fabs(tile_cache[i].center.z() - abs_view_pos.z() ) );
 291
 292             max = delta.x(); med = delta.y(); min = delta.z();
 293             if ( max < med ) {
 294                 tmp = max; max = med; med = tmp;
 295             }
 296             if ( max < min ) {
 297                 tmp = max; max = min; min = tmp;
 298             }
 299             dist = max + (med + min) / 4;
 300             */
 301
 302             dist = tile_cache[i].center.distance3D( abs_view_pos );
 303
 304             FG_LOG( FG_TERRAIN, FG_DEBUG, "    distance = " << dist );
 305
 306             if ( dist > max_dist ) {
 307                 max_dist = dist;
 308                 max_index = i;
 309             }
 310         }
 311     }
 312
 313     // If we made it this far, then there were no open cache entries.
 314     // We will instead free the furthest cache entry and return it's
 315     // index.
 316
 317     if ( max_index >=0 ) {
 318         FG_LOG( FG_TERRAIN, FG_DEBUG, "    max_dist = " << max_dist );
 319         FG_LOG( FG_TERRAIN, FG_DEBUG, "    index = " << max_index );
 320         entry_free( max_index );
 321         return( max_index );
 322     } else {
 323         FG_LOG( FG_TERRAIN, FG_ALERT, "WHOOPS!!! Dying in next_avail()" );
 324         exit( -1 );
 325     }
 326
 327     // avoid a potential compiler warning
 328     return -1;
 329 }
 330
 331
 332 // Destructor
 333 FGTileCache::~FGTileCache( void ) {
 334 }
 335
 336