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