1 // tileentry.hxx -- routines to handle an individual scenery tile
3 // Written by Curtis Olson, started May 1998.
5 // Copyright (C) 1998 - 2001 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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.
24 #ifndef _TILEENTRY_HXX
25 #define _TILEENTRY_HXX
29 # error This library requires C++
36 #include <simgear/compiler.h>
41 #include <simgear/bucket/newbucket.hxx>
42 #include <simgear/math/point3d.hxx>
43 #include <simgear/misc/sg_path.hxx>
44 #include <simgear/scene/model/placementtrans.hxx>
45 #include <simgear/structure/ssgSharedPtr.hxx>
55 typedef vector < Point3D > point_list;
56 typedef point_list::iterator point_list_iterator;
57 typedef point_list::const_iterator const_point_list_iterator;
64 class ssgRangeSelector;
70 * A class to hold deferred model loading info
72 class FGDeferredModel {
79 ssgSharedPtr<ssgTransform> obj_trans;
86 inline FGDeferredModel() { }
87 inline FGDeferredModel( const string& mp, const string& tp, SGBucket b,
88 FGTileEntry *t, ssgTransform *ot, bool co )
97 inline ~FGDeferredModel() { }
98 inline const string& get_model_path() const { return model_path; }
99 inline const string& get_texture_path() const { return texture_path; }
100 inline const SGBucket& get_bucket() const { return bucket; }
101 inline const bool get_cache_state() const { return cache_obj; }
102 inline FGTileEntry *get_tile() const { return tile; }
103 inline ssgTransform *get_obj_trans() const { return obj_trans; }
108 * A class to encapsulate everything we need to know about a scenery tile.
114 // global tile culling data
116 double bounding_radius;
118 // this tile's official location in the world
119 SGBucket tile_bucket;
123 // ssg tree structure for this tile is as follows:
125 // - ssgBranch(terrain)
126 // - ssgTransform(tile)
127 // - ssgRangeSelector(tile)
134 // pointer to ssg transform for this tile
135 ssgSharedPtr<ssgPlacementTransform> terra_transform;
136 ssgSharedPtr<ssgPlacementTransform> vasi_lights_transform;
137 ssgSharedPtr<ssgPlacementTransform> rwy_lights_transform;
138 ssgSharedPtr<ssgPlacementTransform> taxi_lights_transform;
139 ssgSharedPtr<ssgPlacementTransform> gnd_lights_transform;
141 // pointer to ssg range selector for this tile
142 ssgSharedPtr<ssgRangeSelector> terra_range;
143 ssgSharedPtr<ssgRangeSelector> gnd_lights_range;
145 // we create several preset brightness and can choose which one we
146 // want based on lighting conditions.
147 ssgSharedPtr<ssgSelector> gnd_lights_brightness;
149 // we need to be able to turn runway lights on or off (doing this
150 // via a call back would be nifty, but then the call back needs to
151 // know about the higher level application's global state which is
152 // a problem if we move the code into simgear.)
153 ssgSharedPtr<ssgSelector> vasi_lights_selector;
154 ssgSharedPtr<ssgSelector> rwy_lights_selector;
155 ssgSharedPtr<ssgSelector> taxi_lights_selector;
158 * Indicates this tile has been loaded from a file and connected
159 * into the scene graph. Note that this may be set asynchronously
162 volatile bool loaded;
165 * Count of pending models to load for this tile. This tile
166 * cannot be removed until this number reaches zero (i.e. no
167 * pending models to load for this tile.)
169 volatile int pending_models;
171 bool obj_load( const string& path,
173 ssgBranch* vasi_lights,
174 ssgBranch* rwy_lights,
175 ssgBranch* taxi_lights,
176 ssgVertexArray* gound_lights,
179 ssgLeaf* gen_lights( SGMaterialLib *matlib, ssgVertexArray *lights,
180 int inc, float bright );
185 * this value is used by the tile scheduler/loader to mark which
186 * tiles are in the primary ring (i.e. the current tile or the
187 * surrounding eight.) Other routines then can use this as an
188 * optimization and not do some operation to tiles outside of this
189 * inner ring. (For instance vasi color updating)
194 * this variable tracks the status of the incremental memory
201 GROUND_LIGHTS = 0x08,
212 FGTileEntry( const SGBucket& b );
217 // Clean up the memory used by this tile and delete the arrays
218 // used by ssg as well as the whole ssg branch. This does a
219 // partial clean up and exits so we can spread the load across
220 // multiple frames. Returns false if work remaining to be done,
221 // true if dynamically allocated memory used by this tile is
225 // Update the ssg transform node for this tile so it can be
226 // properly drawn relative to our (0,0,0) point
227 void prep_ssg_node( const Point3D& p, sgVec3 up, float vis);
230 * Load tile data from a file.
231 * @param base name of directory containing tile data file.
232 * @param is_base is this a base terrain object for which we should generate
233 * random ground light points */
234 void load( const string_list &base_path, bool is_base );
237 * Return true if the tile entry is loaded, otherwise return false
238 * indicating that the loading thread is still working on this.
240 inline bool is_loaded() const { return loaded; }
243 * decrement the pending models count
245 inline void dec_pending_models() { pending_models--; }
248 * return the number of remaining pending models for this tile
250 inline int get_pending_models() const { return pending_models; }
253 * Return the "bucket" for this tile
255 inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
258 * Apply ssgLeaf::makeDList to all leaf of a branch
260 void makeDList( ssgBranch *b );
263 * Add terrain mesh and ground lighting to scene graph.
265 void add_ssg_nodes( ssgBranch *terrain_branch,
266 ssgBranch *gnd_lights_branch,
267 ssgBranch *vasi_lights_branch,
268 ssgBranch *rwy_lights_branch,
269 ssgBranch *taxi_lights_branch );
272 * disconnect terrain mesh and ground lighting nodes from scene
273 * graph for this tile.
275 void disconnect_ssg_nodes();
279 * return the SSG Transform node for the terrain
281 inline ssgPlacementTransform *get_terra_transform() const { return terra_transform; }
283 inline double get_timestamp() const { return timestamp; }
284 inline void set_timestamp( double time_ms ) { timestamp = time_ms; }
286 inline bool get_inner_ring() const { return is_inner_ring; }
287 inline void set_inner_ring( bool val ) { is_inner_ring = val; }
291 #endif // _TILEENTRY_HXX