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