]> git.mxchange.org Git - flightgear.git/blob - src/Scenery/newcache.hxx
Improved tumbling behaviour -- the AI doesn't just freeze now, but
[flightgear.git] / src / Scenery / newcache.hxx
1 // newcache.hxx -- 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 #ifndef _NEWCACHE_HXX
25 #define _NEWCACHE_HXX
26
27
28 #ifndef __cplusplus                                                          
29 # error This library requires C++
30 #endif                                   
31
32
33 #ifdef HAVE_CONFIG_H
34 #  include <config.h>
35 #endif
36
37 #include <map>
38
39 #include <simgear/bucket/newbucket.hxx>
40 #include <simgear/math/point3d.hxx>
41
42 #include "tileentry.hxx"
43
44 SG_USING_STD(map);
45
46 // A class to store and manage a pile of tiles
47 class FGNewCache {
48
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;
52
53     // cache storage space
54     tile_map tile_cache;
55
56     // maximum cache size
57     int max_cache_size;
58
59     // pointers to allow an external linear traversal of cache entries
60     tile_map_iterator current;
61
62     // Free a tile cache entry
63     void entry_free( long cache_index );
64
65 public:
66
67     // Constructor
68     FGNewCache();
69
70     // Destructor
71     ~FGNewCache();
72
73     // Initialize the tile cache subsystem 
74     void init( void );
75
76     // Check if the specified "bucket" exists in the cache
77     bool exists( const SGBucket& b ) const;
78
79 #if 0
80     // Ensure at least one entry is free in the cache
81     bool make_space();
82 #endif
83
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();
87
88     // Clear a cache entry, note that the cache only holds pointers
89     // and this does not free the object which is pointed to.
90     void clear_entry( long cache_entry );
91
92     // Clear all completely loaded tiles (ignores partially loaded tiles)
93     void clear_cache();
94
95     // Fill in a tile cache entry with real data for the specified bucket 
96     // void fill_in( const SGBucket& b );
97
98     // Return a pointer to the specified tile cache entry 
99     inline FGTileEntry *get_tile( const long tile_index ) {
100         tile_map_iterator it = tile_cache.find( tile_index );
101         if ( it != tile_cache.end() ) {
102             it->second->set_timestamp(globals->get_sim_time_sec());
103             return it->second;
104         } else {
105             return NULL;
106         }
107     }
108
109     // Return a pointer to the specified tile cache entry 
110     inline FGTileEntry *get_tile( const SGBucket& b ) {
111         return get_tile( b.gen_index() );
112     }
113
114     // Return the cache size
115     inline size_t get_size() const { return tile_cache.size(); }
116
117     // External linear traversal of cache
118     inline void reset_traversal() { current = tile_cache.begin(); }
119     inline bool at_end() { return current == tile_cache.end(); }
120     inline FGTileEntry *get_current() {
121         // cout << "index = " << current->first << endl;
122         return current->second;
123     }
124     inline void next() { ++current; }
125
126     inline int get_max_cache_size() const { return max_cache_size; }
127     inline void set_max_cache_size( int m ) { max_cache_size = m; }
128
129     /**
130      * Create a new tile and enqueue it for loading.
131      * @param b 
132      * @return success/failure
133      */
134     bool insert_tile( FGTileEntry* e );
135 };
136
137
138 #endif // _NEWCACHE_HXX