src/Scenery/tilemgr.hxx

   1 // tilemgr.hxx -- routines to handle dynamic management of scenery tiles
   2 //
   3 // Written by Curtis Olson, started January 1998.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - http://www.flightgear.org/~curt
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _TILEMGR_HXX
  25 #define _TILEMGR_HXX
  26
  27 #include <simgear/compiler.h>
  28
  29 #include <simgear/structure/subsystem_mgr.hxx>
  30 #include <simgear/bucket/newbucket.hxx>
  31 #include "SceneryPager.hxx"
  32 #include "tilecache.hxx"
  33
  34 namespace osg
  35 {
  36 class Node;
  37 }
  38
  39 namespace simgear
  40 {
  41 class SGTerraSync;
  42 class SGReaderWriterOptions;
  43 }
  44
  45 class FGTileMgr : public SGSubsystem {
  46
  47 private:
  48
  49     // Tile loading state
  50     enum load_state {
  51         Start = 0,
  52         Inited = 1,
  53         Running = 2
  54     };
  55
  56     load_state state, last_state;
  57
  58     // schedule a tile for loading, returns true when tile is already loaded
  59     bool sched_tile( const SGBucket& b, double priority,bool current_view, double request_time);
  60
  61     // schedule a needed buckets for loading
  62     void schedule_needed(const SGBucket& curr_bucket, double rangeM);
  63
  64     bool isTileDirSyncing(const std::string& tileFileName) const;
  65
  66     SGBucket previous_bucket;
  67     SGBucket current_bucket;
  68     SGBucket pending;
  69     osg::ref_ptr<simgear::SGReaderWriterOptions> _options;
  70
  71     double scheduled_visibility;
  72
  73     /**
  74      * tile cache
  75      */
  76     TileCache tile_cache;
  77     simgear::SGTerraSync* _terra_sync;
  78
  79     class TileManagerListener;
  80     friend class TileManagerListener;
  81     TileManagerListener* _listener;
  82
  83     // update various queues internal queues
  84     void update_queues(bool& isDownloadingScenery);
  85
  86     // schedule tiles for the viewer bucket
  87     void schedule_tiles_at(const SGGeod& location, double rangeM);
  88
  89     SGPropertyNode_ptr _visibilityMeters;
  90     SGPropertyNode_ptr _maxTileRangeM, _disableNasalHooks;
  91     SGPropertyNode_ptr _scenery_loaded, _scenery_override;
  92
  93     osg::ref_ptr<flightgear::SceneryPager> _pager;
  94
  95     /// is caching of expired tiles enabled or not?
  96     bool _enableCache;
  97 public:
  98     FGTileMgr();
  99     ~FGTileMgr();
 100
 101     // Initialize the Tile Manager
 102     virtual void init();
 103     virtual void reinit();
 104     virtual void shutdown();
 105
 106     virtual void update(double dt);
 107
 108     const SGBucket& get_current_bucket () const { return current_bucket; }
 109
 110     // Returns true if scenery is available for the given lat, lon position
 111     // within a range of range_m.
 112     // lat and lon are expected to be in degrees.
 113     bool schedule_scenery(const SGGeod& position, double range_m, double duration=0.0);
 114
 115     // Returns true if tiles around current view position have been loaded
 116     bool isSceneryLoaded();
 117
 118     // notify the tile manahger the material library was reloaded,
 119     // so it can pass this through to its options object
 120     void materialLibChanged();
 121
 122     static const char* subsystemName() { return "tile-manager"; }
 123 };
 124
 125
 126 #endif // _TILEMGR_HXX