1 // newcache.hxx -- routines to handle scenery tile caching
3 // Written by Curtis Olson, started December 2000.
5 // Copyright (C) 2000 Curtis L. Olson - curt@flightgear.org
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., 675 Mass Ave, Cambridge, MA 02139, USA.
29 # error This library requires C++
45 #include <simgear/bucket/newbucket.hxx>
46 #include <simgear/math/point3d.hxx>
48 #include "tileentry.hxx"
52 // A class to store and manage a pile of tiles
55 typedef map < long, FGTileEntry * > tile_map;
56 typedef tile_map::iterator tile_map_iterator;
57 typedef tile_map::const_iterator const_tile_map_iterator;
59 // cache storage space
65 // pointers to allow an external linear traversal of cache entries
66 tile_map_iterator current;
68 // Free a tile cache entry
69 void entry_free( long cache_index );
79 // Initialize the tile cache subsystem
82 // Check if the specified "bucket" exists in the cache
83 bool exists( const SGBucket& b ) const;
85 // Ensure at least one entry is free in the cache
88 // Clear all completely loaded tiles (ignores partially loaded tiles)
91 // Fill in a tile cache entry with real data for the specified bucket
92 // void fill_in( const SGBucket& b );
94 // Return a pointer to the specified tile cache entry
95 inline FGTileEntry *get_tile( const long tile_index ) {
96 tile_map_iterator it = tile_cache.find( tile_index );
97 if ( it != tile_cache.end() ) {
104 // Return a pointer to the specified tile cache entry
105 inline FGTileEntry *get_tile( const SGBucket& b ) {
106 return get_tile( b.gen_index() );
109 // Return the cache size
110 inline size_t get_size() const { return tile_cache.size(); }
112 // External linear traversal of cache
113 inline void reset_traversal() { current = tile_cache.begin(); }
114 inline bool at_end() { return current == tile_cache.end(); }
115 inline FGTileEntry *get_current() {
116 // cout << "index = " << current->first << endl;
117 return current->second;
119 inline void next() { ++current; }
121 inline int get_max_cache_size() const { return max_cache_size; }
122 inline void set_max_cache_size( int m ) { max_cache_size = m; }
125 * Create a new tile and enqueue it for loading.
127 * @return success/failure
129 bool insert_tile( FGTileEntry* e );
133 #endif // _NEWCACHE_HXX