1 // tilemgr.cxx -- routines to handle dynamic management of scenery tiles
3 // Written by Curtis Olson, started January 1998.
5 // Copyright (C) 1997 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.
31 #include <boost/lexical_cast.hpp>
33 #include <osgViewer/Viewer>
34 #include <osgDB/Registry>
36 #include <simgear/constants.h>
37 #include <simgear/debug/logstream.hxx>
38 #include <simgear/structure/exception.hxx>
39 #include <simgear/scene/model/modellib.hxx>
40 #include <simgear/scene/util/SGReaderWriterOptions.hxx>
41 #include <simgear/scene/tsync/terrasync.hxx>
42 #include <simgear/misc/strutils.hxx>
43 #include <simgear/scene/material/matlib.hxx>
45 #include <Main/globals.hxx>
46 #include <Main/fg_props.hxx>
47 #include <Viewer/renderer.hxx>
48 #include <Viewer/splash.hxx>
49 #include <Scripting/NasalSys.hxx>
50 #include <Scripting/NasalModelData.hxx>
52 #include "scenery.hxx"
53 #include "SceneryPager.hxx"
54 #include "tilemgr.hxx"
56 using flightgear::SceneryPager;
58 class FGTileMgr::TileManagerListener : public SGPropertyChangeListener
61 TileManagerListener(FGTileMgr* manager) :
63 _useVBOsProp(fgGetNode("/sim/rendering/use-vbos", true)),
64 _enableCacheProp(fgGetNode("/sim/tile-cache/enable", true)),
65 _pagedLODMaximumProp(fgGetNode("/sim/rendering/max-paged-lod", true))
67 _useVBOsProp->addChangeListener(this, true);
69 _enableCacheProp->addChangeListener(this, true);
70 if (_enableCacheProp->getType() == simgear::props::NONE) {
71 _enableCacheProp->setBoolValue(true);
74 if (_pagedLODMaximumProp->getType() == simgear::props::NONE) {
75 // not set, use OSG default / environment value variable
76 osg::ref_ptr<osgViewer::Viewer> viewer(globals->get_renderer()->getViewer());
77 int current = viewer->getDatabasePager()->getTargetMaximumNumberOfPageLOD();
78 _pagedLODMaximumProp->setIntValue(current);
80 _pagedLODMaximumProp->addChangeListener(this, true);
83 ~TileManagerListener()
85 _useVBOsProp->removeChangeListener(this);
86 _enableCacheProp->removeChangeListener(this);
87 _pagedLODMaximumProp->removeChangeListener(this);
90 virtual void valueChanged(SGPropertyNode* prop)
92 if (prop == _useVBOsProp) {
93 bool useVBOs = prop->getBoolValue();
94 _manager->_options->setPluginStringData("SimGear::USE_VBOS",
95 useVBOs ? "ON" : "OFF");
96 } else if (prop == _enableCacheProp) {
97 _manager->_enableCache = prop->getBoolValue();
98 } else if (prop == _pagedLODMaximumProp) {
99 int v = prop->getIntValue();
100 osg::ref_ptr<osgViewer::Viewer> viewer(globals->get_renderer()->getViewer());
101 viewer->getDatabasePager()->setTargetMaximumNumberOfPageLOD(v);
107 SGPropertyNode_ptr _useVBOsProp,
109 _pagedLODMaximumProp;
112 FGTileMgr::FGTileMgr():
114 last_state( Running ),
115 scheduled_visibility(100.0),
118 _visibilityMeters(fgGetNode("/environment/visibility-m", true)),
119 _maxTileRangeM(fgGetNode("/sim/rendering/static-lod/bare", true)),
120 _disableNasalHooks(fgGetNode("/sim/temp/disable-scenery-nasal", true)),
121 _scenery_loaded(fgGetNode("/sim/sceneryloaded", true)),
122 _scenery_override(fgGetNode("/sim/sceneryloaded-override", true)),
123 _pager(FGScenery::getPagerSingleton()),
129 FGTileMgr::~FGTileMgr()
134 // Initialize the Tile Manager subsystem
135 void FGTileMgr::init()
140 void FGTileMgr::shutdown()
145 FGScenery* scenery = globals->get_scenery();
146 if (scenery && scenery->get_terrain_branch()) {
147 osg::Group* group = scenery->get_terrain_branch();
148 group->removeChildren(0, group->getNumChildren());
151 osgDB::Registry::instance()->clearObjectCache();
152 state = Start; // need to init again
155 void FGTileMgr::reinit()
157 SG_LOG( SG_TERRAIN, SG_INFO, "Initializing Tile Manager subsystem." );
158 _terra_sync = static_cast<simgear::SGTerraSync*> (globals->get_subsystem("terrasync"));
160 // drops the previous options reference
161 _options = new simgear::SGReaderWriterOptions;
162 _listener = new TileManagerListener(this);
164 materialLibChanged();
165 _options->setPropertyNode(globals->get_props());
167 osgDB::FilePathList &fp = _options->getDatabasePathList();
168 const PathList &sc = globals->get_fg_scenery();
170 PathList::const_iterator it;
171 for (it = sc.begin(); it != sc.end(); ++it) {
172 fp.push_back(it->local8BitStr());
174 _options->setPluginStringData("SimGear::FG_ROOT", globals->get_fg_root().local8BitStr());
177 _options->setPluginStringData("SimGear::TERRASYNC_ROOT", fgGetString("/sim/terrasync/scenery-dir"));
180 if (!_disableNasalHooks->getBoolValue())
181 _options->setModelData(new FGNasalModelDataProxy);
183 _options->setPluginStringData("SimGear::BARE_LOD_RANGE", fgGetString("/sim/rendering/static-lod/bare", boost::lexical_cast<string>(SG_OBJECT_RANGE_BARE)));
184 _options->setPluginStringData("SimGear::ROUGH_LOD_RANGE", fgGetString("/sim/rendering/static-lod/rough", boost::lexical_cast<string>(SG_OBJECT_RANGE_ROUGH)));
185 _options->setPluginStringData("SimGear::ROUGH_LOD_DETAILED", fgGetString("/sim/rendering/static-lod/detailed", boost::lexical_cast<string>(SG_OBJECT_RANGE_DETAILED)));
186 _options->setPluginStringData("SimGear::RENDER_BUILDING_MESH", fgGetBool("/sim/rendering/building-mesh", false) ? "true" : "false");
190 // protect against multiple scenery reloads and properly reset flags,
191 // otherwise aircraft fall through the ground while reloading scenery
192 if (_scenery_loaded->getBoolValue() == false) {
193 SG_LOG( SG_TERRAIN, SG_INFO, "/sim/sceneryloaded already false, avoiding duplicate re-init of tile manager" );
198 _scenery_loaded->setBoolValue(false);
199 fgSetDouble("/sim/startup/splash-alpha", 1.0);
201 materialLibChanged();
203 // remove all old scenery nodes from scenegraph and clear cache
204 osg::Group* group = globals->get_scenery()->get_terrain_branch();
205 group->removeChildren(0, group->getNumChildren());
208 // clear OSG cache, except on initial start-up
211 osgDB::Registry::instance()->clearObjectCache();
216 previous_bucket.make_bad();
217 current_bucket.make_bad();
218 scheduled_visibility = 100.0;
220 // force an update now
224 void FGTileMgr::materialLibChanged()
226 _options->setMaterialLib(globals->get_matlib());
229 /* schedule a tile for loading, keep request for given amount of time.
230 * Returns true if tile is already loaded. */
231 bool FGTileMgr::sched_tile( const SGBucket& b, double priority, bool current_view, double duration)
233 // see if tile already exists in the cache
234 TileEntry *t = tile_cache.get_tile( b );
237 // create a new entry
238 t = new TileEntry( b );
239 SG_LOG( SG_TERRAIN, SG_INFO, "sched_tile: new tile entry for:" << b );
242 // insert the tile into the cache, update will generate load request
243 if ( tile_cache.insert_tile( t ) )
245 // Attach to scene graph
247 t->addToSceneGraph(globals->get_scenery()->get_terrain_branch());
250 // insert failed (cache full with no available entries to
251 // delete.) Try again later
256 SG_LOG( SG_TERRAIN, SG_DEBUG, " New tile cache size " << (int)tile_cache.get_size() );
259 // update tile's properties
260 tile_cache.request_tile(t,priority,current_view,duration);
262 return t->is_loaded();
265 /* schedule needed buckets for the current view position for loading,
266 * keep request for given amount of time */
267 void FGTileMgr::schedule_needed(const SGBucket& curr_bucket, double vis)
269 // sanity check (unfortunately needed!)
270 if (!curr_bucket.isValid() )
272 SG_LOG( SG_TERRAIN, SG_ALERT,
273 "Attempting to schedule tiles for invalid bucket" );
277 double tile_width = curr_bucket.get_width_m();
278 double tile_height = curr_bucket.get_height_m();
279 SG_LOG( SG_TERRAIN, SG_INFO,
280 "scheduling needed tiles for " << curr_bucket
281 << ", tile-width-m:" << tile_width << ", tile-height-m:" << tile_height);
284 // cout << "tile width = " << tile_width << " tile_height = "
285 // << tile_height << endl;
287 double tileRangeM = std::min(vis,_maxTileRangeM->getDoubleValue());
288 int xrange = (int)(tileRangeM / tile_width) + 1;
289 int yrange = (int)(tileRangeM / tile_height) + 1;
290 if ( xrange < 1 ) { xrange = 1; }
291 if ( yrange < 1 ) { yrange = 1; }
293 // make the cache twice as large to avoid losing terrain when switching
294 // between aircraft and tower views
295 tile_cache.set_max_cache_size( (2*xrange + 2) * (2*yrange + 2) * 2 );
296 // cout << "xrange = " << xrange << " yrange = " << yrange << endl;
297 // cout << "max cache size = " << tile_cache.get_max_cache_size()
298 // << " current cache size = " << tile_cache.get_size() << endl;
300 // clear flags of all tiles belonging to the previous view set
301 tile_cache.clear_current_view();
303 // update timestamps, so all tiles scheduled now are *newer* than any tile previously loaded
304 osg::FrameStamp* framestamp
305 = globals->get_renderer()->getViewer()->getFrameStamp();
306 tile_cache.set_current_time(framestamp->getReferenceTime());
312 /* schedule all tiles, use distance-based loading priority,
313 * so tiles are loaded in innermost-to-outermost sequence. */
314 for ( x = -xrange; x <= xrange; ++x )
316 for ( y = -yrange; y <= yrange; ++y )
318 SGBucket b = curr_bucket.sibling(x, y);
323 float priority = (-1.0) * (x*x+y*y);
324 sched_tile( b, priority, true, 0.0 );
327 _terra_sync->scheduleTile(b);
334 * Update the various queues maintained by the tilemgr (private
335 * internal function, do not call directly.)
337 void FGTileMgr::update_queues(bool& isDownloadingScenery)
339 osg::FrameStamp* framestamp
340 = globals->get_renderer()->getViewer()->getFrameStamp();
341 double current_time = framestamp->getReferenceTime();
342 double vis = _visibilityMeters->getDoubleValue();
347 tile_cache.set_current_time( current_time );
348 tile_cache.reset_traversal();
350 while ( ! tile_cache.at_end() )
352 e = tile_cache.get_current();
355 // Prepare the ssg nodes corresponding to each tile.
356 // Set the ssg transform and update it's range selector
357 // based on current visibilty
358 e->prep_ssg_node(vis);
360 if (!e->is_loaded()) {
361 bool nonExpiredOrCurrent = !e->is_expired(current_time) || e->is_current_view();
362 bool downloading = isTileDirSyncing(e->tileFileName);
363 isDownloadingScenery |= downloading;
364 if ( !downloading && nonExpiredOrCurrent) {
365 // schedule tile for loading with osg pager
366 _pager->queueRequest(e->tileFileName,
370 e->getDatabaseRequest(),
374 } // of tile not loaded case
376 SG_LOG(SG_TERRAIN, SG_ALERT, "Warning: empty tile in cache!");
382 int drop_count = sz - tile_cache.get_max_cache_size();
383 bool dropTiles = false;
385 dropTiles = ( drop_count > 0 ) && ((loading==0)||(drop_count > 10));
388 drop_count = sz; // no limit on tiles to drop
393 long drop_index = _enableCache ? tile_cache.get_drop_tile() :
394 tile_cache.get_first_expired_tile();
395 while ( drop_index > -1 )
397 // schedule tile for deletion with osg pager
398 TileEntry* old = tile_cache.get_tile(drop_index);
399 SG_LOG(SG_TERRAIN, SG_DEBUG, "Dropping:" << old->get_tile_bucket());
401 tile_cache.clear_entry(drop_index);
403 osg::ref_ptr<osg::Object> subgraph = old->getNode();
404 old->removeFromSceneGraph();
406 // zeros out subgraph ref_ptr, so subgraph is owned by
407 // the pager and will be deleted in the pager thread.
408 _pager->queueDeleteRequest(subgraph);
411 drop_index = tile_cache.get_first_expired_tile();
412 // limit tiles dropped to drop_count
413 else if (--drop_count > 0)
414 drop_index = tile_cache.get_drop_tile();
418 } // of dropping tiles loop
421 // given the current lon/lat (in degrees), fill in the array of local
422 // chunks. If the chunk isn't already in the cache, then read it from
424 void FGTileMgr::update(double)
426 double vis = _visibilityMeters->getDoubleValue();
427 schedule_tiles_at(globals->get_view_position(), vis);
429 bool waitingOnTerrasync = false;
430 update_queues(waitingOnTerrasync);
432 // scenery loading check, triggers after each sim (tile manager) reinit
433 if (!_scenery_loaded->getBoolValue())
435 bool fdmInited = fgGetBool("sim/fdm-initialized");
436 bool positionFinalized = fgGetBool("sim/position-finalized");
437 bool sceneryOverride = _scenery_override->getBoolValue();
440 // we are done if final position is set and the scenery & FDM are done.
441 // scenery-override can ignore the last two, but not position finalization.
442 if (positionFinalized && (sceneryOverride || (isSceneryLoaded() && fdmInited)))
444 _scenery_loaded->setBoolValue(true);
445 fgSplashProgress("");
449 if (!positionFinalized) {
450 fgSplashProgress("finalize-position");
451 } else if (waitingOnTerrasync) {
452 fgSplashProgress("downloading-scenery");
454 fgSplashProgress("loading-scenery");
457 // be nice to loader threads while waiting for initial scenery, reduce to 20fps
458 SGTimeStamp::sleepForMSec(50);
463 // schedule tiles for the viewer bucket
464 // (FDM/AI/groundcache/... should use "schedule_scenery" instead)
465 void FGTileMgr::schedule_tiles_at(const SGGeod& location, double range_m)
467 // SG_LOG( SG_TERRAIN, SG_DEBUG, "FGTileMgr::update() for "
468 // << longitude << " " << latitude );
470 current_bucket = SGBucket( location );
472 // schedule more tiles when visibility increased considerably
473 // TODO Calculate tile size - instead of using fixed value (5000m)
474 if (range_m - scheduled_visibility > 5000.0)
475 previous_bucket.make_bad();
477 // SG_LOG( SG_TERRAIN, SG_DEBUG, "Updating tile list for "
478 // << current_bucket );
479 fgSetInt( "/environment/current-tile-id", current_bucket.gen_index() );
481 // do tile load scheduling.
482 // Note that we need keep track of both viewer buckets and fdm buckets.
483 if ( state == Running ) {
484 if (last_state != state)
486 SG_LOG( SG_TERRAIN, SG_DEBUG, "State == Running" );
488 if (current_bucket != previous_bucket) {
489 // We've moved to a new bucket, we need to schedule any
490 // needed tiles for loading.
491 SG_LOG( SG_TERRAIN, SG_INFO, "FGTileMgr: at " << location << ", scheduling needed for:" << current_bucket
492 << ", visibility=" << range_m);
493 scheduled_visibility = range_m;
494 schedule_needed(current_bucket, range_m);
498 previous_bucket = current_bucket;
499 } else if ( state == Start || state == Inited ) {
500 SG_LOG( SG_TERRAIN, SG_DEBUG, "State == Start || Inited" );
501 // do not update bucket yet (position not valid in initial loop)
503 previous_bucket.make_bad();
508 /** Schedules scenery for given position. Load request remains valid for given duration
509 * (duration=0.0 => nothing is loaded).
510 * Used for FDM/AI/groundcache/... requests. Viewer uses "schedule_tiles_at" instead.
511 * Returns true when all tiles for the given position are already loaded, false otherwise.
513 bool FGTileMgr::schedule_scenery(const SGGeod& position, double range_m, double duration)
515 // sanity check (unfortunately needed!)
516 if (!position.isValid())
518 const float priority = 0.0;
519 bool available = true;
521 SGBucket bucket(position);
522 available = sched_tile( bucket, priority, false, duration );
524 if ((!available)&&(duration==0.0)) {
525 SG_LOG( SG_TERRAIN, SG_DEBUG, "schedule_scenery: Scheduling tile at bucket:" << bucket << " return false" );
529 SGVec3d cartPos = SGVec3d::fromGeod(position);
531 // Traverse all tiles required to be there for the given visibility.
532 double tile_width = bucket.get_width_m();
533 double tile_height = bucket.get_height_m();
534 double tile_r = 0.5*sqrt(tile_width*tile_width + tile_height*tile_height);
535 double max_dist = tile_r + range_m;
536 double max_dist2 = max_dist*max_dist;
538 int xrange = (int)fabs(range_m / tile_width) + 1;
539 int yrange = (int)fabs(range_m / tile_height) + 1;
541 for ( int x = -xrange; x <= xrange; ++x )
543 for ( int y = -yrange; y <= yrange; ++y )
545 // We have already checked for the center tile.
546 if ( x != 0 || y != 0 )
548 SGBucket b = bucket.sibling(x, y );
553 double distance2 = distSqr(cartPos, SGVec3d::fromGeod(b.get_center()));
554 // Do not ask if it is just the next tile but way out of range.
555 if (distance2 <= max_dist2)
557 available &= sched_tile( b, priority, false, duration );
558 if ((!available)&&(duration==0.0))
568 // Returns true if tiles around current view position have been loaded
569 bool FGTileMgr::isSceneryLoaded()
571 double range_m = 100.0;
572 if (scheduled_visibility < range_m)
573 range_m = scheduled_visibility;
575 return schedule_scenery(globals->get_view_position(), range_m, 0.0);
578 bool FGTileMgr::isTileDirSyncing(const std::string& tileFileName) const
584 std::string nameWithoutExtension = tileFileName.substr(0, tileFileName.size() - 4);
585 long int bucketIndex = simgear::strutils::to_int(nameWithoutExtension);
586 SGBucket bucket(bucketIndex);
588 return _terra_sync->isTileDirPending(bucket.gen_base_path());