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