src/Scenery/FGTileLoader.hxx

   1 // FGTileLoader - Queue scenery tiles for loading.
   2 //
   3 // Written by Bernie Bright, started March 2001.
   4 //
   5 // Copyright (C) 2001  Bernard Bright - bbright@bigpond.net.au
   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 FG_TILE_LOADER_HXX
  25 #define FG_TILE_LOADER_HXX
  26
  27 #include <simgear/bucket/newbucket.hxx>
  28 #include <simgear/misc/sg_path.hxx>
  29
  30 #ifdef ENABLE_THREADS
  31 #  include <simgear/threads/SGThread.hxx>
  32 #  include <simgear/threads/SGQueue.hxx>
  33 #else
  34 #  include <queue>
  35 #endif
  36
  37 // Forward reference.
  38 class FGTileEntry;
  39
  40 /**
  41  * Queues tiles for loading, possibly by a separate thread.
  42  */
  43 class FGTileLoader
  44 {
  45 public:
  46
  47     /**
  48      * Constructor.
  49      */
  50     FGTileLoader();
  51
  52     /**
  53      * Destructor.
  54      */
  55     ~FGTileLoader();
  56
  57     /**
  58      * Add a tile to the end of the load queue.
  59      * @param tile The tile to be loaded from disk.
  60      * @param vis Current visibilty (in feet?) (see FGTileMgr::vis).
  61      */
  62     void add( FGTileEntry* tile );
  63
  64     /**
  65      * The tile loader thread will only load one tile per call to the
  66      * update() method.  This is a way to spread out the work of the
  67      * tile loader and slow it down so it is less intrusive.  For
  68      * systems built without thead support this is a no-op.
  69      */
  70     void update();
  71
  72     /**
  73      * Returns whether the load queue is empty (contains no elements).
  74      * @return true if load queue is empty otherwise returns false.
  75      */
  76     // bool empty() const { return tile_load_queue.empty(); }
  77
  78 private:
  79
  80 private:
  81
  82 #ifdef ENABLE_THREADS
  83     /**
  84      * FIFO queue of tiles to load from data files.
  85      */
  86     SGBlockingQueue< FGTileEntry* > tile_load_queue;
  87 #else
  88     queue< FGTileEntry* > tile_load_queue;
  89 #endif
  90
  91     /**
  92      * Base name of directory containing tile data file.
  93      */
  94     SGPath tile_path;
  95
  96 #ifdef ENABLE_THREADS
  97     /**
  98      * Maximum number of threads to create for loading tiles.
  99      */
 100     enum { MAX_THREADS = 1 };
 101
 102     /**
 103      * This class represents the thread of execution responsible for
 104      * loading a tile.
 105      */
 106     class LoaderThread : public SGThread
 107     {
 108     public:
 109         LoaderThread( FGTileLoader* l ) : loader(l) {}
 110         ~LoaderThread() {}
 111
 112         /**
 113          * Reads the tile from disk.
 114          */
 115         void run();
 116
 117     private:
 118         FGTileLoader* loader;
 119
 120     private:
 121         // not implemented.
 122         LoaderThread();
 123         LoaderThread( const LoaderThread& );
 124         LoaderThread& operator=( const LoaderThread& );
 125     };
 126
 127     friend class LoaderThread;
 128
 129     /**
 130      * Array of loading threads.
 131      */
 132     LoaderThread* threads[ MAX_THREADS ];
 133
 134     /**
 135      * Lock and synchronize access to tile queue.
 136      */
 137     SGMutex mutex;
 138     SGCondition frame_cond;
 139
 140     /**
 141      * Thread cleanup handler.
 142      */
 143     friend void cleanup_handler( void* );
 144 #endif // ENABLE_THREADS
 145 };
 146
 147 #endif // FG_TILE_LOADER_HXX