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