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