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