1 // tilecache.cxx -- routines to handle scenery tile caching
3 // Written by Curtis Olson, started January 1998.
5 // Copyright (C) 1998, 1999 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.
33 #include <simgear/xgl/xgl.h>
35 #include <plib/ssg.h> // plib include
37 #include <simgear/bucket/newbucket.hxx>
38 #include <simgear/debug/logstream.hxx>
39 #include <simgear/misc/fgstream.hxx>
40 #include <simgear/misc/fgpath.hxx>
42 #include <Airports/genapt.hxx>
43 #include <Clouds/cloudobj.hxx>
44 #include <Main/options.hxx>
45 #include <Main/views.hxx>
46 #include <Objects/obj.hxx>
47 #include <Scenery/scenery.hxx> // for scenery.center
49 #include "tilecache.hxx"
50 #include "tileentry.hxx"
53 // a cheesy hack (to be fixed later)
54 extern ssgBranch *terrain;
55 extern ssgEntity *penguin;
59 FGTileCache global_tile_cache;
63 FGTileCache::FGTileCache( void ) {
68 // Initialize the tile cache subsystem
70 FGTileCache::init( void )
74 FG_LOG( FG_TERRAIN, FG_INFO, "Initializing the tile cache." );
76 // expand cache if needed. For best results ... i.e. to avoid
77 // tile load problems and blank areas:
79 // target_cache_size >= (current.options.tile_diameter + 1) ** 2
81 int side = current_options.get_tile_diameter() + 2;
82 int target_cache_size = (side*side);
83 FG_LOG( FG_TERRAIN, FG_DEBUG, " target cache size = "
84 << target_cache_size );
85 FG_LOG( FG_TERRAIN, FG_DEBUG, " current cache size = "
86 << tile_cache.size() );
93 FG_LOG( FG_TERRAIN, FG_DEBUG, " size of tile = "
95 if ( target_cache_size > (int)tile_cache.size() ) {
97 int expansion_amt = target_cache_size - (int)tile_cache.size();
98 for ( i = 0; i < expansion_amt; ++i ) {
99 tile_cache.push_back( e );
100 FG_LOG( FG_TERRAIN, FG_DEBUG, " expanding cache size = "
101 << tile_cache.size() );
104 FG_LOG( FG_TERRAIN, FG_DEBUG, " done expanding cache, size = "
105 << tile_cache.size() );
107 for ( i = 0; i < (int)tile_cache.size(); i++ ) {
108 if ( !tile_cache[i].is_unused() ) {
111 tile_cache[i].mark_unused();
112 tile_cache[i].tile_bucket.make_bad();
115 // and ... just in case we missed something ...
116 terrain->removeAllKids();
118 FG_LOG( FG_TERRAIN, FG_DEBUG, " done with init()" );
122 // Search for the specified "bucket" in the cache
124 FGTileCache::exists( const FGBucket& p )
128 for ( i = 0; i < (int)tile_cache.size(); i++ ) {
129 if ( tile_cache[i].tile_bucket == p ) {
130 FG_LOG( FG_TERRAIN, FG_DEBUG,
131 "TILE EXISTS in cache ... index = " << i );
141 static void print_refs( ssgSelector *sel, ssgTransform *trans,
142 ssgRangeSelector *range)
144 cout << "selector -> " << sel->getRef()
145 << " transform -> " << trans->getRef()
146 << " range -> " << range->getRef() << endl;
151 // Fill in a tile cache entry with real data for the specified bucket
153 FGTileCache::fill_in( int index, const FGBucket& p )
155 // cout << "FILL IN CACHE ENTRY = " << index << endl;
157 tile_cache[index].center = Point3D( 0.0 );
158 if ( tile_cache[index].vec3_ptrs.size() ||
159 tile_cache[index].vec2_ptrs.size() ||
160 tile_cache[index].index_ptrs.size() )
162 FG_LOG( FG_TERRAIN, FG_ALERT,
163 "Attempting to overwrite existing or"
164 << " not properly freed leaf data." );
168 tile_cache[index].select_ptr = new ssgSelector;
169 tile_cache[index].transform_ptr = new ssgTransform;
170 tile_cache[index].range_ptr = new ssgRangeSelector;
171 tile_cache[index].tile_bucket = p;
173 FGPath tile_path( current_options.get_fg_root() );
174 tile_path.append( "Scenery" );
175 tile_path.append( p.gen_base_path() );
177 // Load the appropriate data file and build tile fragment list
178 FGPath tile_base = tile_path;
179 tile_base.append( p.gen_index_str() );
180 ssgBranch *new_tile = fgObjLoad( tile_base.str(), &tile_cache[index],
183 if ( new_tile != NULL ) {
184 tile_cache[index].range_ptr->addKid( new_tile );
187 // load custom objects
188 cout << "CUSTOM OBJECTS" << endl;
190 FGPath index_path = tile_path;
191 index_path.append( p.gen_index_str() );
192 index_path.concat( ".ind" );
194 cout << "Looking in " << index_path.str() << endl;
196 fg_gzifstream in( index_path.str() );
198 if ( in.is_open() ) {
201 while ( ! in.eof() ) {
209 cout << "token = " << token << " name = " << name << endl;
211 FGPath custom_path = tile_path;
212 custom_path.append( name );
213 ssgBranch *custom_obj = fgObjLoad( custom_path.str(),
214 &tile_cache[index], false );
215 if ( (new_tile != NULL) && (custom_obj != NULL) ) {
216 new_tile -> addKid( custom_obj );
221 // generate cloud layer
222 if ( current_options.get_clouds() ) {
223 ssgLeaf *cloud_layer = fgGenCloudLayer( &tile_cache[index],
224 current_options.get_clouds_asl() );
225 cloud_layer->clrTraversalMaskBits( SSGTRAV_HOT );
226 new_tile -> addKid( cloud_layer );
229 tile_cache[index].transform_ptr->addKid( tile_cache[index].range_ptr );
231 // calculate initial tile offset
232 tile_cache[index].SetOffset( scenery.center );
234 sgSetCoord( &sgcoord,
235 tile_cache[index].offset.x(),
236 tile_cache[index].offset.y(), tile_cache[index].offset.z(),
238 tile_cache[index].transform_ptr->setTransform( &sgcoord );
240 tile_cache[index].select_ptr->addKid( tile_cache[index].transform_ptr );
241 terrain->addKid( tile_cache[index].select_ptr );
243 if ( tile_cache[index].is_scheduled_for_cache() ) {
244 // cout << "FOUND ONE SCHEDULED FOR CACHE" << endl;
245 // load, but not needed now so disable
246 tile_cache[index].mark_loaded();
247 tile_cache[index].ssg_disable();
248 tile_cache[index].select_ptr->select(0);
250 // cout << "FOUND ONE READY TO LOAD" << endl;
251 tile_cache[index].mark_loaded();
252 tile_cache[index].select_ptr->select(1);
257 // Free a tile cache entry
259 FGTileCache::entry_free( int cache_index )
261 // cout << "FREEING CACHE ENTRY = " << cache_index << endl;
262 tile_cache[cache_index].free_tile();
266 // Return index of next available slot in tile cache
268 FGTileCache::next_avail( void )
271 Point3D abs_view_pos;
273 // float max, med, min, tmp;
274 float dist, max_dist;
280 for ( i = 0; i < (int)tile_cache.size(); i++ ) {
281 // only look at freeing NON-scheduled (i.e. ready to load
282 // cache entries. This assumes that the cache is always big
283 // enough for our tile radius!
285 if ( tile_cache[i].is_unused() ) {
286 // favor unused cache slots
288 } else if ( tile_cache[i].is_loaded() || tile_cache[i].is_cached() ) {
289 // calculate approximate distance from view point
290 abs_view_pos = current_view.get_abs_view_pos();
292 FG_LOG( FG_TERRAIN, FG_DEBUG,
293 "DIST Abs view pos = " << abs_view_pos );
294 FG_LOG( FG_TERRAIN, FG_DEBUG,
295 " ref point = " << tile_cache[i].center );
298 delta.setx( fabs(tile_cache[i].center.x() - abs_view_pos.x() ) );
299 delta.sety( fabs(tile_cache[i].center.y() - abs_view_pos.y() ) );
300 delta.setz( fabs(tile_cache[i].center.z() - abs_view_pos.z() ) );
302 max = delta.x(); med = delta.y(); min = delta.z();
304 tmp = max; max = med; med = tmp;
307 tmp = max; max = min; min = tmp;
309 dist = max + (med + min) / 4;
312 dist = tile_cache[i].center.distance3D( abs_view_pos );
314 FG_LOG( FG_TERRAIN, FG_DEBUG, " distance = " << dist );
316 if ( dist > max_dist ) {
323 // If we made it this far, then there were no open cache entries.
324 // We will instead free the furthest cache entry and return it's
327 if ( max_index >=0 ) {
328 FG_LOG( FG_TERRAIN, FG_DEBUG, " max_dist = " << max_dist );
329 FG_LOG( FG_TERRAIN, FG_DEBUG, " index = " << max_index );
330 entry_free( max_index );
333 FG_LOG( FG_TERRAIN, FG_ALERT, "WHOOPS!!! Dying in next_avail()" );
340 FGTileCache::~FGTileCache( void ) {