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