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>
41 #include <osg/ref_ptr>
42 #include <osgDB/ReaderWriter>
55 class ModelLoadHelper;
58 * A class to encapsulate everything we need to know about a scenery tile.
63 // this tile's official location in the world
65 std::string tileFileName;
67 typedef vector < Point3D > point_list;
68 typedef point_list::iterator point_list_iterator;
69 typedef point_list::const_iterator const_point_list_iterator;
73 // pointer to ssg range selector for this tile
74 osg::ref_ptr<osg::LOD> _node;
75 // Reference to DatabaseRequest object set and used by the
76 // osgDB::DatabasePager.
77 osg::ref_ptr<osg::Referenced> _databaseRequest;
79 static bool obj_load( const std::string& path,
82 const osgDB::ReaderWriter::Options* options);
85 * this value is used by the tile scheduler/loader to mark which
86 * tiles are in the primary ring (i.e. the current tile or the
87 * surrounding eight.) Other routines then can use this as an
88 * optimization and not do some operation to tiles outside of this
89 * inner ring. (For instance vasi color updating)
93 static ModelLoadHelper *_modelLoader;
98 TileEntry( const SGBucket& b );
103 static void setModelLoadHelper(ModelLoadHelper *m) { _modelLoader=m; }
105 // Clean up the memory used by this tile and delete the arrays
106 // used by ssg as well as the whole ssg branch. This does a
107 // partial clean up and exits so we can spread the load across
108 // multiple frames. Returns false if work remaining to be done,
109 // true if dynamically allocated memory used by this tile is
113 // Update the ssg transform node for this tile so it can be
114 // properly drawn relative to our (0,0,0) point
115 void prep_ssg_node(float vis);
118 * Transition to OSG database pager
120 static osg::Node* loadTileByFileName(const std::string& index_str,
121 const osgDB::ReaderWriter::Options*);
123 * Return true if the tile entry is loaded, otherwise return false
124 * indicating that the loading thread is still working on this.
126 inline bool is_loaded() const
128 return _node->getNumChildren() > 0;
132 * Return the "bucket" for this tile
134 inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
137 * Add terrain mesh and ground lighting to scene graph.
139 void addToSceneGraph( osg::Group *terrain_branch);
142 * disconnect terrain mesh and ground lighting nodes from scene
143 * graph for this tile.
145 void removeFromSceneGraph();
149 * return the scenegraph node for the terrain
151 osg::LOD *getNode() const { return _node.get(); }
153 double get_timestamp() const;
154 void set_timestamp( double time_ms );
156 inline bool get_inner_ring() const { return is_inner_ring; }
157 inline void set_inner_ring( bool val ) { is_inner_ring = val; }
159 // Get the ref_ptr to the DatabaseRequest object, in order to pass
160 // this to the pager.
161 osg::ref_ptr<osg::Referenced>& getDatabaseRequest()
163 return _databaseRequest;
167 class ModelLoadHelper {
169 virtual osg::Node *loadTileModel(const string& modelPath, bool cacheModel)=0;
175 #endif // _TILEENTRY_HXX