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>
46 #include <osg/ref_ptr>
50 #include <osg/MatrixTransform>
61 typedef vector < Point3D > point_list;
62 typedef point_list::iterator point_list_iterator;
63 typedef point_list::const_iterator const_point_list_iterator;
70 * A class to hold deferred model loading info
72 class FGDeferredModel {
79 osg::ref_ptr<osg::MatrixTransform> obj_trans;
86 inline FGDeferredModel() { }
87 inline FGDeferredModel( const string& mp, const string& tp, SGBucket b,
88 FGTileEntry *t, osg::MatrixTransform *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 osg::MatrixTransform *get_obj_trans() const { return obj_trans.get(); }
108 * A class to encapsulate everything we need to know about a scenery tile.
113 // this tile's official location in the world
114 SGBucket tile_bucket;
118 // pointer to ssg transform for this tile
119 osg::ref_ptr<osg::Group> terra_transform;
121 // pointer to ssg range selector for this tile
122 osg::ref_ptr<osg::LOD> terra_range;
125 * Indicates this tile has been loaded from a file and connected
126 * into the scene graph. Note that this may be set asynchronously
129 volatile bool loaded;
132 * Count of pending models to load for this tile. This tile
133 * cannot be removed until this number reaches zero (i.e. no
134 * pending models to load for this tile.)
136 volatile int pending_models;
138 bool obj_load( const string& path,
139 osg::Group* geometry,
145 * this value is used by the tile scheduler/loader to mark which
146 * tiles are in the primary ring (i.e. the current tile or the
147 * surrounding eight.) Other routines then can use this as an
148 * optimization and not do some operation to tiles outside of this
149 * inner ring. (For instance vasi color updating)
154 * this variable tracks the status of the incremental memory
161 GROUND_LIGHTS = 0x08,
172 FGTileEntry( const SGBucket& b );
177 // Clean up the memory used by this tile and delete the arrays
178 // used by ssg as well as the whole ssg branch. This does a
179 // partial clean up and exits so we can spread the load across
180 // multiple frames. Returns false if work remaining to be done,
181 // true if dynamically allocated memory used by this tile is
185 // Update the ssg transform node for this tile so it can be
186 // properly drawn relative to our (0,0,0) point
187 void prep_ssg_node(float vis);
190 * Load tile data from a file.
191 * @param base name of directory containing tile data file.
192 * @param is_base is this a base terrain object for which we should generate
193 * random ground light points */
194 void load( const string_list &base_path, bool is_base );
197 * Return true if the tile entry is loaded, otherwise return false
198 * indicating that the loading thread is still working on this.
200 inline bool is_loaded() const { return loaded; }
203 * decrement the pending models count
205 inline void dec_pending_models() { pending_models--; }
208 * return the number of remaining pending models for this tile
210 inline int get_pending_models() const { return pending_models; }
213 * Return the "bucket" for this tile
215 inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
218 * Add terrain mesh and ground lighting to scene graph.
220 void add_ssg_nodes( osg::Group *terrain_branch);
223 * disconnect terrain mesh and ground lighting nodes from scene
224 * graph for this tile.
226 void disconnect_ssg_nodes();
230 * return the SSG Transform node for the terrain
232 osg::Group *get_terra_transform() const { return terra_transform.get(); }
234 inline double get_timestamp() const { return timestamp; }
235 inline void set_timestamp( double time_ms ) { timestamp = time_ms; }
237 inline bool get_inner_ring() const { return is_inner_ring; }
238 inline void set_inner_ring( bool val ) { is_inner_ring = val; }
242 #endif // _TILEENTRY_HXX