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++
43 #include <simgear/compiler.h>
48 #include <plib/ssg.h> // plib includes
50 #include <simgear/bucket/newbucket.hxx>
51 #include <simgear/math/point3d.hxx>
52 #include <simgear/misc/sg_path.hxx>
62 typedef vector < Point3D > point_list;
63 typedef point_list::iterator point_list_iterator;
64 typedef point_list::const_iterator const_point_list_iterator;
70 * A class to hold deferred model loading info
72 class FGDeferredModel {
79 ssgTransform *obj_trans;
83 inline FGDeferredModel() { }
84 inline FGDeferredModel( const string mp, const string tp,
85 FGTileEntry *t, ssgTransform *ot )
92 inline ~FGDeferredModel() { }
93 inline string get_model_path() const { return model_path; }
94 inline string get_texture_path() const { return texture_path; }
95 inline FGTileEntry *get_tile() const { return tile; }
96 inline ssgTransform *get_obj_trans() const { return obj_trans; }
101 * A class to encapsulate everything we need to know about a scenery tile.
107 typedef vector < sgVec3 * > free_vec3_list;
108 typedef vector < sgVec2 * > free_vec2_list;
109 typedef vector < unsigned short * > free_index_list;
115 // global tile culling data
117 double bounding_radius;
120 // this tile's official location in the world
121 SGBucket tile_bucket;
123 // list of pointers to memory chunks that need to be freed when
124 // tile entry goes away
125 free_vec3_list vec3_ptrs;
126 free_vec2_list vec2_ptrs;
127 free_index_list index_ptrs;
131 // ssg tree structure for this tile is as follows:
133 // - ssgBranch(terrain)
134 // - ssgTransform(tile)
135 // - ssgRangeSelector(tile)
142 // pointer to ssg transform for this tile
143 ssgTransform *terra_transform;
144 ssgTransform *rwy_lights_transform;
145 ssgTransform *gnd_lights_transform;
147 // pointer to ssg range selector for this tile
148 ssgRangeSelector *terra_range;
149 ssgRangeSelector *rwy_lights_range;
150 ssgRangeSelector *gnd_lights_range;
152 // we create several preset brightness and can choose which one we
153 // want based on lighting conditions.
154 ssgSelector *gnd_lights_brightness;
157 // Runway centre coords.
158 Point3D rway_center; // Reqd. for switching as function of distance from runway center
159 //pointers for Runway lights
160 ssgTransform *lightmaps_transform; // branch for runway lights
161 ssgRangeSelector *lightmaps_range; // tried to maintain same structure as Curt's ground
162 ssgSelector *lightmaps_brightness; // selector node for points/ lightmaps
164 ssgSimpleState *lightmap_state; // OpenGL state of the polygons that make up runway lights
165 ssgVertexArray *light_points; // array of runway light coords.
169 * Indicates this tile has been loaded from a file and connected
170 * into the scene graph. Note that this may be set asynchronously
173 volatile bool loaded;
176 * Count of pending models to load for this tile. This tile
177 * cannot be removed until this number reaches zero (i.e. no
178 * pending models to load for this tile.)
180 volatile int pending_models;
182 ssgBranch* obj_load( const std::string& path,
183 ssgVertexArray* lights, bool is_base );
185 ssgLeaf* gen_lights( ssgVertexArray *lights, int inc, float bright );
190 ssgTransform *ols_transform; // transform node for flols simulation
191 ssgSelector *lightmaps_sequence; // selector node for points/ lightmaps
192 ssgBranch* gen_runway_lights(ssgVertexArray *points,ssgVertexArray *normal, ssgVertexArray *dir, int *type);
196 FGTileEntry( const SGBucket& b );
201 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
202 // Schedule tile to be freed/removed
203 void sched_removal();
206 // Clean up the memory used by this tile and delete the arrays
207 // used by ssg as well as the whole ssg branch
210 // Calculate this tile's offset
211 void SetOffset( const Point3D& p)
216 // Return this tile's offset
217 inline Point3D get_offset() const { return offset; }
219 // Update the ssg transform node for this tile so it can be
220 // properly drawn relative to our (0,0,0) point
221 void prep_ssg_node( const Point3D& p, float vis);
224 * Load tile data from a file.
225 * @param base name of directory containing tile data file.
226 * @param is_base is this a base terrain object for which we should generate
227 * random ground light points */
228 void load( const SGPath& base, bool is_base );
231 * Return true if the tile entry is loaded, otherwise return false
232 * indicating that the loading thread is still working on this.
234 inline bool is_loaded() const { return loaded; }
237 * decrement the pending models count
239 inline void dec_pending_models() { pending_models--; }
242 * return the number of remaining pending models for this tile
244 inline int get_pending_models() const { return pending_models; }
247 * Return the "bucket" for this tile
249 inline SGBucket get_tile_bucket() const { return tile_bucket; }
252 * Add terrain mesh and ground lighting to scene graph.
254 void add_ssg_nodes( ssgBranch* terrain, ssgBranch* ground );
257 * disconnect terrain mesh and ground lighting nodes from scene
258 * graph for this tile.
260 void disconnect_ssg_nodes();
264 #endif // _TILEENTRY_HXX