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 mark which
78 * tiles are in the primary ring (i.e. the current tile or the
79 * surrounding eight.) Other routines then can use this as an
80 * optimization and not do some operation to tiles outside of this
81 * inner ring. (For instance vasi color updating)
87 static ModelLoadHelper *_modelLoader;
92 TileEntry( const SGBucket& b );
97 static void setModelLoadHelper(ModelLoadHelper *m) { _modelLoader=m; }
99 // Update the ssg transform node for this tile so it can be
100 // properly drawn relative to our (0,0,0) point
101 void prep_ssg_node(float vis);
104 * Transition to OSG database pager
106 static osg::Node* loadTileByFileName(const std::string& index_str,
107 const osgDB::ReaderWriter::Options*);
109 * Return true if the tile entry is loaded, otherwise return false
110 * indicating that the loading thread is still working on this.
112 inline bool is_loaded() const
114 return _node->getNumChildren() > 0;
118 * Return the "bucket" for this tile
120 inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
123 * Add terrain mesh and ground lighting to scene graph.
125 void addToSceneGraph( osg::Group *terrain_branch);
128 * disconnect terrain mesh and ground lighting nodes from scene
129 * graph for this tile.
131 void removeFromSceneGraph();
135 * return the scenegraph node for the terrain
137 osg::LOD *getNode() const { return _node.get(); }
139 double get_timestamp() const;
140 void set_timestamp( double time_ms );
142 inline bool get_inner_ring() const { return is_inner_ring; }
143 inline void set_inner_ring( bool val ) { is_inner_ring = val; }
144 inline void set_cache_lock( bool val ) { is_cache_locked = val; }
145 inline bool get_cache_lock() const { return is_cache_locked; }
147 // Get the ref_ptr to the DatabaseRequest object, in order to pass
148 // this to the pager.
149 osg::ref_ptr<osg::Referenced>& getDatabaseRequest()
151 return _databaseRequest;
155 class ModelLoadHelper {
157 virtual osg::Node *loadTileModel(const std::string& modelPath, bool cacheModel)=0;
163 #endif // _TILEENTRY_HXX