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/misc/sg_path.hxx>
40 #include <osg/ref_ptr>
41 #include <osgDB/ReaderWriter>
51 class ModelLoadHelper;
54 * A class to encapsulate everything we need to know about a scenery tile.
59 // this tile's official location in the world
61 std::string tileFileName;
65 // pointer to ssg range selector for this tile
66 osg::ref_ptr<osg::LOD> _node;
67 // Reference to DatabaseRequest object set and used by the
68 // osgDB::DatabasePager.
69 osg::ref_ptr<osg::Referenced> _databaseRequest;
71 static bool obj_load( const std::string& path,
74 const osgDB::ReaderWriter::Options* options);
77 * This value is used by the tile scheduler/loader to load tiles
78 * in a useful sequence. The priority is set to reflect the tiles
79 * distance from the center, so all tiles are loaded in an innermost
80 * to outermost sequence.
83 /** Flag indicating if tile belongs to current view. */
85 /** Time when tile expires. */
88 static ModelLoadHelper *_modelLoader;
93 TileEntry( const SGBucket& b );
94 TileEntry( const TileEntry& t );
99 static void setModelLoadHelper(ModelLoadHelper *m) { _modelLoader=m; }
101 // Update the ssg transform node for this tile so it can be
102 // properly drawn relative to our (0,0,0) point
103 void prep_ssg_node(float vis);
106 * Transition to OSG database pager
108 static osg::Node* loadTileByFileName(const std::string& index_str,
109 const osgDB::ReaderWriter::Options*);
111 * Return true if the tile entry is loaded, otherwise return false
112 * indicating that the loading thread is still working on this.
114 inline bool is_loaded() const
116 return _node->getNumChildren() > 0;
120 * Return the "bucket" for this tile
122 inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
125 * Add terrain mesh and ground lighting to scene graph.
127 void addToSceneGraph( osg::Group *terrain_branch);
130 * disconnect terrain mesh and ground lighting nodes from scene
131 * graph for this tile.
133 void removeFromSceneGraph();
136 * Refresh a tile, reload the node from disk.
141 * return the scenegraph node for the terrain
143 osg::LOD *getNode() const { return _node.get(); }
145 inline double get_time_expired() const { return _time_expired; }
146 inline void update_time_expired( double time_expired ) { if (_time_expired<time_expired) _time_expired = time_expired; }
148 inline void set_priority(float priority) { _priority=priority; }
149 inline float get_priority() const { return _priority; }
150 inline void set_current_view(bool current_view) { _current_view = current_view; }
151 inline bool is_current_view() const { return _current_view; }
154 * Return true if the tile entry is still needed, otherwise return false
155 * indicating that the tile is no longer in active use.
157 inline bool is_expired(double current_time) const { return (_current_view) ? false : (current_time > _time_expired); }
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 std::string& modelPath, bool cacheModel)=0;
175 #endif // _TILEENTRY_HXX