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 <queue>
  37
  38 #include <simgear/bucket/newbucket.hxx>
  39 #if defined(ENABLE_THREADS)
  40 #  include <simgear/threads/SGQueue.hxx>
  41 #endif // ENABLE_THREADS
  42
  43 #include "FGTileLoader.hxx"
  44 #include "newcache.hxx"
  45
  46 #if defined(USE_MEM) || defined(WIN32)
  47 #  define FG_MEM_COPY(to,from,n)        memcpy(to, from, n)
  48 #else
  49 #  define FG_MEM_COPY(to,from,n)        bcopy(from, to, n)
  50 #endif
  51
  52 SG_USING_STD( queue );
  53
  54
  55 // forward declaration
  56 class FGTileEntry;
  57 class FGDeferredModel;
  58
  59 class osg::Node;
  60
  61 class FGTileMgr {
  62
  63 private:
  64
  65     // Tile loading state
  66     enum load_state {
  67         Start = 0,
  68         Inited = 1,
  69         Running = 2
  70     };
  71
  72     load_state state;
  73
  74     // initialize the cache
  75     void initialize_queue();
  76
  77     // schedule a tile for loading
  78     void sched_tile( const SGBucket& b, const bool is_inner_ring );
  79
  80     // schedule a needed buckets for loading
  81     void schedule_needed(double visibility_meters, const SGBucket& curr_bucket);
  82
  83     SGBucket previous_bucket;
  84     SGBucket current_bucket;
  85     SGBucket pending;
  86
  87     FGTileEntry *current_tile;
  88
  89     // x and y distance of tiles to load/draw
  90     float vis;
  91     int xrange, yrange;
  92
  93     // current longitude latitude
  94     double longitude;
  95     double latitude;
  96     double altitude_m;
  97
  98     /**
  99      * tile cache
 100      */
 101     FGNewCache tile_cache;
 102
 103     /**
 104      * Queue tiles for loading.
 105      */
 106     FGTileLoader loader;
 107
 108     /**
 109      * Work queues.
 110      *
 111      * attach_queue is the tiles that have been loaded [by the pager]
 112      * that can be attached to the scene graph by the render thread.
 113      *
 114      * model_queue is the set of models that need to be loaded by the
 115      * primary render thread.
 116      */
 117 #if defined(ENABLE_THREADS)
 118     static SGLockedQueue<FGTileEntry *> attach_queue;
 119     static SGLockedQueue<FGDeferredModel *> model_queue;
 120 #else
 121     static queue<FGTileEntry *> attach_queue;
 122     static queue<FGDeferredModel *> model_queue;
 123 #endif // ENABLE_THREADS
 124     static queue<FGTileEntry *> delete_queue;
 125
 126 public:
 127
 128     /**
 129      * Add a loaded tile to the 'attach to the scene graph' queue.
 130      */
 131     static void ready_to_attach( FGTileEntry *t ) { attach_queue.push( t ); }
 132
 133     /**
 134      * Add a pending model to the 'deferred model load' queue
 135      */
 136     static void model_ready( FGDeferredModel *dm ) { model_queue.push( dm ); }
 137
 138 public:
 139
 140     // Constructor
 141     FGTileMgr();
 142
 143     // Destructor
 144     ~FGTileMgr();
 145
 146     // Initialize the Tile Manager subsystem
 147     int init();
 148
 149     // Update the various queues maintained by the tilemagr (private
 150     // internal function, do not call directly.)
 151     void update_queues();
 152
 153     // get state of all the scenery loading queues
 154     bool all_queues_empty();
 155
 156     // given the current lon/lat (in degrees), fill in the array of
 157     // local chunks.  If the chunk isn't already in the cache, then
 158     // read it from disk.
 159     int update( double visibility_meters );
 160     int update( SGLocation *location, double visibility_meters);
 161
 162     // Prepare the ssg nodes corresponding to each tile.  For each
 163     // tile, set the ssg transform and update it's range selector
 164     // based on current visibilty void prep_ssg_nodes( float
 165     // visibility_meters );
 166     void prep_ssg_nodes(float visibility_meters );
 167
 168     // Set flag with event manager so that non-moving view refreshes
 169     // tiles...
 170     void refresh_view_timestamps();
 171
 172     const SGBucket& get_current_bucket () const { return current_bucket; }
 173
 174     /// Returns true if scenery is avaliable for the given lat, lon position
 175     /// within a range of range_m.
 176     /// lat and lon are expected to be in degrees.
 177     bool scenery_available(double lat, double lon, double range_m);
 178
 179     // Load a model for a tile
 180     static osg::Node* loadTileModel(const string& modelPath, bool cacheModel);
 181 };
 182
 183
 184 #endif // _TILEMGR_HXX