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++
32 #include <simgear/compiler.h>
37 #include <simgear/bucket/newbucket.hxx>
38 #include <simgear/math/point3d.hxx>
39 #include <simgear/misc/sg_path.hxx>
40 #include <simgear/scene/model/placementtrans.hxx>
42 #include <osg/ref_ptr>
43 #include <osgDB/ReaderWriter>
56 class ModelLoadHelper;
59 * A class to encapsulate everything we need to know about a scenery tile.
64 // this tile's official location in the world
66 std::string tileFileName;
68 typedef vector < Point3D > point_list;
69 typedef point_list::iterator point_list_iterator;
70 typedef point_list::const_iterator const_point_list_iterator;
74 // pointer to ssg range selector for this tile
75 osg::ref_ptr<osg::LOD> _node;
76 // Reference to DatabaseRequest object set and used by the
77 // osgDB::DatabasePager.
78 osg::ref_ptr<osg::Referenced> _databaseRequest;
80 static bool obj_load( const std::string& path,
83 const osgDB::ReaderWriter::Options* options);
86 * this value is used by the tile scheduler/loader to mark which
87 * tiles are in the primary ring (i.e. the current tile or the
88 * surrounding eight.) Other routines then can use this as an
89 * optimization and not do some operation to tiles outside of this
90 * inner ring. (For instance vasi color updating)
95 * this variable tracks the status of the incremental memory
102 GROUND_LIGHTS = 0x08,
110 static ModelLoadHelper *_modelLoader;
115 TileEntry( const SGBucket& b );
120 static void setModelLoadHelper(ModelLoadHelper *m) { _modelLoader=m; }
122 // Clean up the memory used by this tile and delete the arrays
123 // used by ssg as well as the whole ssg branch. This does a
124 // partial clean up and exits so we can spread the load across
125 // multiple frames. Returns false if work remaining to be done,
126 // true if dynamically allocated memory used by this tile is
130 // Update the ssg transform node for this tile so it can be
131 // properly drawn relative to our (0,0,0) point
132 void prep_ssg_node(float vis);
135 * Transition to OSG database pager
137 static osg::Node* loadTileByName(const std::string& index_str,
138 const osgDB::ReaderWriter::Options*);
140 * Return true if the tile entry is loaded, otherwise return false
141 * indicating that the loading thread is still working on this.
143 inline bool is_loaded() const
145 return _node->getNumChildren() > 0;
149 * Return the "bucket" for this tile
151 inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
154 * Add terrain mesh and ground lighting to scene graph.
156 void addToSceneGraph( osg::Group *terrain_branch);
159 * disconnect terrain mesh and ground lighting nodes from scene
160 * graph for this tile.
162 void removeFromSceneGraph();
166 * return the scenegraph node for the terrain
168 osg::LOD *getNode() const { return _node.get(); }
170 double get_timestamp() const;
171 void set_timestamp( double time_ms );
173 inline bool get_inner_ring() const { return is_inner_ring; }
174 inline void set_inner_ring( bool val ) { is_inner_ring = val; }
176 // Get the ref_ptr to the DatabaseRequest object, in order to pass
177 // this to the pager.
178 osg::ref_ptr<osg::Referenced>& getDatabaseRequest()
180 return _databaseRequest;
184 class ModelLoadHelper {
186 virtual osg::Node *loadTileModel(const string& modelPath, bool cacheModel)=0;
192 #endif // _TILEENTRY_HXX