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 #include <simgear/scene/model/location.hxx>
  29
  30 #include <simgear/bucket/newbucket.hxx>
  31 #include <simgear/scene/tgdb/TileEntry.hxx>
  32 #include <simgear/scene/tgdb/TileCache.hxx>
  33
  34 class SGReaderWriterBTGOptions;
  35
  36 namespace osg
  37 {
  38 class Node;
  39 }
  40
  41 class FGTileMgr : public simgear::ModelLoadHelper {
  42
  43 private:
  44
  45     // Tile loading state
  46     enum load_state {
  47         Start = 0,
  48         Inited = 1,
  49         Running = 2
  50     };
  51
  52     load_state state;
  53
  54     // initialize the cache
  55     void initialize_queue();
  56
  57     // schedule a tile for loading
  58     void sched_tile( const SGBucket& b, const bool is_inner_ring );
  59
  60     // schedule a needed buckets for loading
  61     void schedule_needed(double visibility_meters, const SGBucket& curr_bucket);
  62
  63     SGBucket previous_bucket;
  64     SGBucket current_bucket;
  65     SGBucket pending;
  66     osg::ref_ptr<SGReaderWriterBTGOptions> _options;
  67
  68     // x and y distance of tiles to load/draw
  69     float vis;
  70     int xrange, yrange;
  71
  72     // current longitude latitude
  73     double longitude;
  74     double latitude;
  75     double altitude_m;
  76
  77     /**
  78      * tile cache
  79      */
  80     simgear::TileCache tile_cache;
  81
  82 public:
  83     FGTileMgr();
  84
  85     ~FGTileMgr();
  86
  87     // Initialize the Tile Manager
  88     int init();
  89
  90     // Update the various queues maintained by the tilemagr (private
  91     // internal function, do not call directly.)
  92     void update_queues();
  93
  94     // given the current lon/lat (in degrees), fill in the array of
  95     // local chunks.  If the chunk isn't already in the cache, then
  96     // read it from disk.
  97     int update( double visibility_meters );
  98     int update( SGLocation *location, double visibility_meters);
  99
 100     // Prepare the ssg nodes corresponding to each tile.  For each
 101     // tile, set the ssg transform and update it's range selector
 102     // based on current visibilty void prep_ssg_nodes( float
 103     // visibility_meters );
 104     void prep_ssg_nodes(float visibility_meters );
 105
 106     const SGBucket& get_current_bucket () const { return current_bucket; }
 107
 108     /// Returns true if scenery is avaliable for the given lat, lon position
 109     /// within a range of range_m.
 110     /// lat and lon are expected to be in degrees.
 111     bool scenery_available(double lat, double lon, double range_m);
 112
 113     // Load a model for a tile
 114     osg::Node* loadTileModel(const string& modelPath, bool cacheModel);
 115
 116     // Returns true if all the tiles in the tile cache have been loaded
 117     bool isSceneryLoaded();
 118 };
 119
 120
 121 #endif // _TILEMGR_HXX