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 - curt@flightgear.org
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., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #ifndef _TILEENTRY_HXX
25 #define _TILEENTRY_HXX
29 # error This library requires C++
36 #include <simgear/compiler.h>
41 #include <plib/ssg.h> // plib includes
43 #include <simgear/bucket/newbucket.hxx>
44 #include <simgear/math/point3d.hxx>
45 #include <simgear/misc/sg_path.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;
63 * A class to hold deferred model loading info
65 class FGDeferredModel {
72 ssgTransform *obj_trans;
76 inline FGDeferredModel() { }
77 inline FGDeferredModel( const string mp, const string tp,
78 FGTileEntry *t, ssgTransform *ot )
85 inline ~FGDeferredModel() { }
86 inline string get_model_path() const { return model_path; }
87 inline string get_texture_path() const { return texture_path; }
88 inline FGTileEntry *get_tile() const { return tile; }
89 inline ssgTransform *get_obj_trans() const { return obj_trans; }
94 * A class to encapsulate everything we need to know about a scenery tile.
100 // global tile culling data
102 double bounding_radius;
105 // this tile's official location in the world
106 SGBucket tile_bucket;
110 // ssg tree structure for this tile is as follows:
112 // - ssgBranch(terrain)
113 // - ssgTransform(tile)
114 // - ssgRangeSelector(tile)
121 // pointer to ssg transform for this tile
122 ssgTransform *terra_transform;
123 ssgTransform *vasi_lights_transform;
124 ssgTransform *rwy_lights_transform;
125 ssgTransform *taxi_lights_transform;
126 ssgTransform *gnd_lights_transform;
128 // pointer to ssg range selector for this tile
129 ssgRangeSelector *terra_range;
130 ssgRangeSelector *gnd_lights_range;
132 // we create several preset brightness and can choose which one we
133 // want based on lighting conditions.
134 ssgSelector *gnd_lights_brightness;
136 // we need to be able to turn runway lights on or off (doing this
137 // via a call back would be nifty, but then the call back needs to
138 // know about the higher level application's global state which is
139 // a problem if we move the code into simgear.)
140 ssgSelector *vasi_lights_selector;
141 ssgSelector *rwy_lights_selector;
142 ssgSelector *taxi_lights_selector;
145 * Indicates this tile has been loaded from a file and connected
146 * into the scene graph. Note that this may be set asynchronously
149 volatile bool loaded;
152 * Count of pending models to load for this tile. This tile
153 * cannot be removed until this number reaches zero (i.e. no
154 * pending models to load for this tile.)
156 volatile int pending_models;
158 bool obj_load( const string& path,
160 ssgBranch* vasi_lights,
161 ssgBranch* rwy_lights,
162 ssgBranch* taxi_lights,
163 ssgVertexArray* gound_lights,
166 ssgLeaf* gen_lights( SGMaterialLib *matlib, ssgVertexArray *lights,
167 int inc, float bright );
172 * this value is used by the tile scheduler/loader to mark which
173 * tiles are in the primary ring (i.e. the current tile or the
174 * surrounding eight.) Other routines then can use this as an
175 * optimization and not do some operation to tiles outside of this
176 * inner ring. (For instance vasi color updating)
181 * this variable tracks the status of the incremental memory
188 GROUND_LIGHTS = 0x08,
199 FGTileEntry( const SGBucket& b );
204 // Clean up the memory used by this tile and delete the arrays
205 // used by ssg as well as the whole ssg branch. This does a
206 // partial clean up and exits so we can spread the load across
207 // multiple frames. Returns false if work remaining to be done,
208 // true if dynamically allocated memory used by this tile is
212 // Calculate this tile's offset
213 void SetOffset( const Point3D& p)
218 // Return this tile's offset
219 inline Point3D get_offset() const { return offset; }
221 // Update the ssg transform node for this tile so it can be
222 // properly drawn relative to our (0,0,0) point
223 void prep_ssg_node( const Point3D& p, sgVec3 up, float vis);
226 * Load tile data from a file.
227 * @param base name of directory containing tile data file.
228 * @param is_base is this a base terrain object for which we should generate
229 * random ground light points */
230 void load( const string_list &base_path, bool is_base );
233 * Return true if the tile entry is loaded, otherwise return false
234 * indicating that the loading thread is still working on this.
236 inline bool is_loaded() const { return loaded; }
239 * decrement the pending models count
241 inline void dec_pending_models() { pending_models--; }
244 * return the number of remaining pending models for this tile
246 inline int get_pending_models() const { return pending_models; }
249 * Return the "bucket" for this tile
251 inline SGBucket get_tile_bucket() const { return tile_bucket; }
254 * Add terrain mesh and ground lighting to scene graph.
256 void add_ssg_nodes( ssgBranch *terrain_branch,
257 ssgBranch *gnd_lights_branch,
258 ssgBranch *vasi_lights_branch,
259 ssgBranch *rwy_lights_branch,
260 ssgBranch *taxi_lights_branch );
263 * disconnect terrain mesh and ground lighting nodes from scene
264 * graph for this tile.
266 void disconnect_ssg_nodes();
270 * return the SSG Transform node for the terrain
272 inline ssgTransform *get_terra_transform() { return terra_transform; }
274 inline double get_timestamp() const { return timestamp; }
275 inline void set_timestamp( double time_ms ) { timestamp = time_ms; }
277 inline bool get_inner_ring() const { return is_inner_ring; }
278 inline void set_inner_ring( bool val ) { is_inner_ring = val; }
282 #endif // _TILEENTRY_HXX