]> git.mxchange.org Git - flightgear.git/blob - src/Scenery/FGTileLoader.hxx
f8d1ba03ba420eae160a98dd9545d66eecd23a98
[flightgear.git] / 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      */
61     void add( FGTileEntry* tile );
62
63 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
64     /**
65      * Remove a tile from memory.
66      * @param tile The tile to be removed from memory.
67      */
68     void remove( FGTileEntry* tile );
69 #endif
70
71     /**
72      * The tile loader thread will only load one tile per call to the
73      * update() method.  This is a way to spread out the work of the
74      * tile loader and slow it down so it is less intrusive.  For
75      * systems built without thead support this is a no-op.
76      */
77     void update();
78
79     /**
80      * Returns whether the load queue is empty (contains no elements).
81      * @return true if load queue is empty otherwise returns false.
82      */
83     // bool empty() const { return tile_load_queue.empty(); }
84
85 private:
86
87 private:
88
89 #ifdef ENABLE_THREADS
90     /**
91      * FIFO queue of tiles to load from data files.
92      */
93     SGBlockingQueue< FGTileEntry * > tile_load_queue;
94     // SGBlockingQueue< FGTileEntry * > tile_free_queue;
95 #else
96     queue< FGTileEntry * > tile_load_queue;
97     // queue< FGTileEntry * > tile_free_queue;
98 #endif
99
100     /**
101      * Base name of directory containing tile data file.
102      */
103     SGPath tile_path;
104
105 #ifdef ENABLE_THREADS
106     /**
107      * Maximum number of threads to create for loading tiles.
108      */
109     enum { MAX_THREADS = 1 };
110
111     /**
112      * This class represents the thread of execution responsible for
113      * loading a tile.
114      */
115     class LoaderThread : public SGThread
116     {
117     public:
118         LoaderThread( FGTileLoader* l ) : loader(l) {}
119         ~LoaderThread() {}
120
121         /**
122          * Reads the tile from disk.
123          */
124         void run();
125
126     private:
127         FGTileLoader* loader;
128
129     private:
130         // not implemented.
131         LoaderThread();
132         LoaderThread( const LoaderThread& );
133         LoaderThread& operator=( const LoaderThread& );
134     };
135
136     friend class LoaderThread;
137
138     /**
139      * Array of loading threads.
140      */
141     LoaderThread* threads[ MAX_THREADS ];
142     
143     /**
144      * Lock and synchronize access to tile queue.
145      */
146     SGMutex mutex;
147     SGCondition frame_cond;
148
149     /**
150      * Thread cleanup handler.
151      */
152     friend void cleanup_handler( void* );
153 #endif // ENABLE_THREADS
154 };
155
156 #endif // FG_TILE_LOADER_HXX