1 // newcache.hxx -- routines to handle scenery tile caching
3 // Written by Curtis Olson, started December 2000.
5 // Copyright (C) 2000 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
29 # error This library requires C++
39 #include <simgear/bucket/newbucket.hxx>
40 #include <simgear/math/point3d.hxx>
42 #include "tileentry.hxx"
46 // A class to store and manage a pile of tiles
49 typedef map < long, FGTileEntry * > tile_map;
50 typedef tile_map::iterator tile_map_iterator;
51 typedef tile_map::const_iterator const_tile_map_iterator;
53 // cache storage space
59 // pointers to allow an external linear traversal of cache entries
60 tile_map_iterator current;
62 // Free a tile cache entry
63 void entry_free( long cache_index );
73 // Initialize the tile cache subsystem
76 // Check if the specified "bucket" exists in the cache
77 bool exists( const SGBucket& b ) const;
80 // Ensure at least one entry is free in the cache
84 // Return the index of the oldest tile in the cache, return -1 if
85 // nothing available to be removed.
86 long get_oldest_tile();
88 // Clear the inner ring flag for all tiles in the cache so that
89 // the external tile scheduler can flag the inner ring correctly.
90 void clear_inner_ring_flags();
92 // Clear a cache entry, note that the cache only holds pointers
93 // and this does not free the object which is pointed to.
94 void clear_entry( long cache_entry );
96 // Clear all completely loaded tiles (ignores partially loaded tiles)
99 // Return a pointer to the specified tile cache entry
100 inline FGTileEntry *get_tile( const long tile_index ) const {
101 const_tile_map_iterator it = tile_cache.find( tile_index );
102 if ( it != tile_cache.end() ) {
103 it->second->set_timestamp(globals->get_sim_time_sec());
110 // Return a pointer to the specified tile cache entry
111 inline FGTileEntry *get_tile( const SGBucket& b ) const {
112 return get_tile( b.gen_index() );
115 // Return the cache size
116 inline size_t get_size() const { return tile_cache.size(); }
118 // External linear traversal of cache
119 inline void reset_traversal() { current = tile_cache.begin(); }
120 inline bool at_end() { return current == tile_cache.end(); }
121 inline FGTileEntry *get_current() const {
122 // cout << "index = " << current->first << endl;
123 return current->second;
125 inline void next() { ++current; }
127 inline int get_max_cache_size() const { return max_cache_size; }
128 inline void set_max_cache_size( int m ) { max_cache_size = m; }
131 * Create a new tile and enqueue it for loading.
133 * @return success/failure
135 bool insert_tile( FGTileEntry* e );
139 #endif // _NEWCACHE_HXX