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 *lights_transform;
146 // pointer to ssg range selector for this tile
147 ssgRangeSelector *terra_range;
148 ssgRangeSelector *lights_range;
150 // we create several preset brightness and can choose which one we
151 // want based on lighting conditions.
152 ssgSelector *lights_brightness;
155 * Indicates this tile has been loaded from a file and connected
156 * into the scene graph. Note that this may be set asynchronously
159 volatile bool loaded;
162 * Count of pending models to load for this tile. This tile
163 * cannot be removed until this number reaches zero (i.e. no
164 * pending models to load for this tile.)
166 volatile int pending_models;
168 ssgBranch* obj_load( const std::string& path,
169 ssgVertexArray* lights, bool is_base );
171 ssgLeaf* gen_lights( ssgVertexArray *lights, int inc, float bright );
176 FGTileEntry( const SGBucket& b );
181 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
182 // Schedule tile to be freed/removed
183 void sched_removal();
186 // Clean up the memory used by this tile and delete the arrays
187 // used by ssg as well as the whole ssg branch
190 // Calculate this tile's offset
191 void SetOffset( const Point3D& p)
196 // Return this tile's offset
197 inline Point3D get_offset() const { return offset; }
199 // Update the ssg transform node for this tile so it can be
200 // properly drawn relative to our (0,0,0) point
201 void prep_ssg_node( const Point3D& p, float vis);
204 * Load tile data from a file.
205 * @param base name of directory containing tile data file.
206 * @param is_base is this a base terrain object for which we should generate
207 * random ground light points */
208 void load( const SGPath& base, bool is_base );
211 * Return true if the tile entry is loaded, otherwise return false
212 * indicating that the loading thread is still working on this.
214 inline bool is_loaded() const { return loaded; }
217 * decrement the pending models count
219 inline void dec_pending_models() { pending_models--; }
222 * return the number of remaining pending models for this tile
224 inline int get_pending_models() const { return pending_models; }
227 * Return the "bucket" for this tile
229 inline SGBucket get_tile_bucket() const { return tile_bucket; }
232 * Add terrain mesh and ground lighting to scene graph.
234 void add_ssg_nodes( ssgBranch* terrain, ssgBranch* ground );
237 * disconnect terrain mesh and ground lighting nodes from scene
238 * graph for this tile.
240 void disconnect_ssg_nodes();
244 #endif // _TILEENTRY_HXX