src/Scenery/newcache.cxx

   1 // newcache.cxx -- routines to handle scenery tile caching
   2 //
   3 // Written by Curtis Olson, started December 2000.
   4 //
   5 // Copyright (C) 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 <GL/gl.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/sg_path.hxx>
  40
  41 #include <Main/globals.hxx>
  42 #include <Scenery/scenery.hxx>  // for scenery.center
  43
  44 #include "newcache.hxx"
  45 #include "tileentry.hxx"
  46
  47
  48 SG_USING_NAMESPACE(std);
  49
  50
  51 // Constructor
  52 FGNewCache::FGNewCache( void ) {
  53     tile_cache.clear();
  54 }
  55
  56
  57 // Destructor
  58 FGNewCache::~FGNewCache( void ) {
  59 }
  60
  61
  62 // Free a tile cache entry
  63 void FGNewCache::entry_free( long cache_index ) {
  64     SG_LOG( SG_TERRAIN, SG_DEBUG, "FREEING CACHE ENTRY = " << cache_index );
  65     FGTileEntry *e = tile_cache[cache_index];
  66     e->free_tile();
  67     delete e;
  68     tile_cache.erase( cache_index );
  69 }
  70
  71
  72 // Initialize the tile cache subsystem
  73 void FGNewCache::init( void ) {
  74     // This is a hack that should really get cleaned up at some point
  75     extern ssgBranch *terrain;
  76
  77     SG_LOG( SG_TERRAIN, SG_INFO, "Initializing the tile cache." );
  78
  79     // expand cache if needed.  For best results ... i.e. to avoid
  80     // tile load problems and blank areas:
  81     max_cache_size = 50;        // a random number to start with
  82     SG_LOG( SG_TERRAIN, SG_INFO, "  max cache size = "
  83             << max_cache_size );
  84     SG_LOG( SG_TERRAIN, SG_INFO, "  current cache size = "
  85             << tile_cache.size() );
  86
  87     tile_map_iterator current = tile_cache.begin();
  88     tile_map_iterator end = tile_cache.end();
  89
  90     for ( ; current != end; ++current ) {
  91         long index = current->first;
  92         SG_LOG( SG_TERRAIN, SG_DEBUG, "clearing " << index );
  93         FGTileEntry *e = current->second;
  94         e->tile_bucket.make_bad();
  95         entry_free(index);
  96     }
  97
  98     // and ... just in case we missed something ...
  99     terrain->removeAllKids();
 100
 101     SG_LOG( SG_TERRAIN, SG_INFO, "  done with init()"  );
 102 }
 103
 104
 105 // Search for the specified "bucket" in the cache
 106 bool FGNewCache::exists( const SGBucket& b ) const {
 107     long tile_index = b.gen_index();
 108     const_tile_map_iterator it = tile_cache.find( tile_index );
 109
 110     return ( it != tile_cache.end() );
 111 }
 112
 113
 114 // depricated for threading
 115 #if 0
 116 // Fill in a tile cache entry with real data for the specified bucket
 117 void FGNewCache::fill_in( const SGBucket& b ) {
 118     SG_LOG( SG_TERRAIN, SG_DEBUG, "FILL IN CACHE ENTRY = " << b.gen_index() );
 119
 120     // clear out a distant entry in the cache if needed.
 121     make_space();
 122
 123     // create the entry
 124     FGTileEntry *e = new FGTileEntry( b );
 125
 126     // register it in the cache
 127     long tile_index = b.gen_index();
 128     tile_cache[tile_index] = e;
 129
 130     SGPath tile_path;
 131     if ( globals->get_fg_scenery() != (string)"" ) {
 132         tile_path.set( globals->get_fg_scenery() );
 133     } else {
 134         tile_path.set( globals->get_fg_root() );
 135         tile_path.append( "Scenery" );
 136     }
 137
 138     // Load the appropriate data file
 139     e->load( tile_path, true );
 140 }
 141 #endif
 142
 143
 144 // Ensure at least one entry is free in the cache
 145 void FGNewCache::make_space() {
 146     SG_LOG( SG_TERRAIN, SG_DEBUG, "Make space in cache" );
 147     SG_LOG( SG_TERRAIN, SG_DEBUG, "cache entries = " << tile_cache.size() );
 148     SG_LOG( SG_TERRAIN, SG_DEBUG, "max size = " << max_cache_size );
 149
 150     if ( (int)tile_cache.size() < max_cache_size ) {
 151         // space in the cache, return
 152         return;
 153     }
 154
 155     while ( (int)tile_cache.size() >= max_cache_size ) {
 156         sgdVec3 abs_view_pos;
 157         float dist;
 158         float max_dist = 0.0;
 159         int max_index = -1;
 160
 161         // we need to free the furthest entry
 162         tile_map_iterator current = tile_cache.begin();
 163         tile_map_iterator end = tile_cache.end();
 164
 165         for ( ; current != end; ++current ) {
 166             long index = current->first;
 167             FGTileEntry *e = current->second;
 168
 169             if ( e->is_loaded() ) {
 170                 // calculate approximate distance from view point
 171                 sgdCopyVec3( abs_view_pos,
 172                              globals->get_current_view()->get_abs_view_pos() );
 173
 174                 SG_LOG( SG_TERRAIN, SG_DEBUG, "DIST Abs view pos = "
 175                         << abs_view_pos[0] << ","
 176                         << abs_view_pos[1] << ","
 177                         << abs_view_pos[2] );
 178                 SG_LOG( SG_TERRAIN, SG_DEBUG,
 179                         "    ref point = " << e->center );
 180
 181                 sgdVec3 center;
 182                 sgdSetVec3( center,
 183                             e->center.x(), e->center.y(), e->center.z() );
 184                 dist = sgdDistanceVec3( center, abs_view_pos );
 185
 186                 SG_LOG( SG_TERRAIN, SG_DEBUG, "    distance = " << dist );
 187
 188                 if ( dist > max_dist ) {
 189                     max_dist = dist;
 190                     max_index = index;
 191                 }
 192             }
 193         }
 194
 195         // If we made it this far, then there were no open cache entries.
 196         // We will instead free the furthest cache entry and return it's
 197         // index.
 198
 199         if ( max_index >= 0 ) {
 200             SG_LOG( SG_TERRAIN, SG_DEBUG, "    max_dist = " << max_dist );
 201             SG_LOG( SG_TERRAIN, SG_DEBUG, "    index = " << max_index );
 202             entry_free( max_index );
 203         } else {
 204             SG_LOG( SG_TERRAIN, SG_ALERT, "WHOOPS!!! Dying in next_avail()" );
 205             exit( -1 );
 206         }
 207     }
 208 }
 209
 210
 211 /**
 212  * Create a new tile and schedule it for loading.
 213  */
 214 void
 215 FGNewCache::insert_tile( FGTileEntry *e )
 216 {
 217     // clear out a distant entry in the cache if needed.
 218     make_space();
 219
 220     // register it in the cache
 221     long tile_index = e->get_tile_bucket().gen_index();
 222     tile_cache[tile_index] = e;
 223
 224 }