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