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 <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 SGSubsystem, 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     // schedule a tile for loading
  55     void sched_tile( const SGBucket& b, const bool is_inner_ring, const bool is_cache_locked );
  56
  57     // schedule a needed buckets for loading
  58     void schedule_needed(const SGBucket& curr_bucket, double rangeM);
  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
  73     /**
  74      * tile cache
  75      */
  76     simgear::TileCache tile_cache;
  77
  78     // Update the various queues maintained by the tilemagr (private
  79     // internal function, do not call directly.)
  80     void update_queues();
  81
  82     // Prepare the ssg nodes corresponding to each tile.  For each
  83     // tile, set the ssg transform and update it's range selector
  84     // based on current visibilty void prep_ssg_nodes( float
  85     // visibility_meters );
  86     void prep_ssg_nodes();
  87
  88     SGPropertyNode* _visibilityMeters;
  89
  90 public:
  91     FGTileMgr();
  92
  93     ~FGTileMgr();
  94
  95     // Initialize the Tile Manager
  96     virtual void init();
  97     virtual void reinit();
  98
  99     virtual void update(double dt);
 100
 101     int schedule_tiles_at(const SGGeod& location, double rangeM);
 102
 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