1 // tileentry.cxx -- routines to handle a 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.
22 # include <simgear_config.h>
25 #include <simgear/compiler.h>
33 #include <osg/Geometry>
36 #include <osg/MatrixTransform>
38 #include <osg/NodeCallback>
41 #include <osgDB/FileNameUtils>
42 #include <osgDB/ReaderWriter>
43 #include <osgDB/ReadFile>
44 #include <osgDB/Registry>
46 #include <simgear/bucket/newbucket.hxx>
47 #include <simgear/debug/logstream.hxx>
48 #include <simgear/math/sg_geodesy.hxx>
49 #include <simgear/math/sg_random.h>
50 #include <simgear/math/SGMath.hxx>
51 #include <simgear/misc/sgstream.hxx>
52 #include <simgear/scene/material/mat.hxx>
53 #include <simgear/scene/material/matlib.hxx>
54 #include <simgear/scene/model/ModelRegistry.hxx>
55 #include <simgear/scene/tgdb/apt_signs.hxx>
56 #include <simgear/scene/tgdb/obj.hxx>
57 #include <simgear/scene/tgdb/SGReaderWriterBTGOptions.hxx>
59 #include "ReaderWriterSTG.hxx"
60 #include "TileEntry.hxx"
63 using namespace simgear;
65 ModelLoadHelper *TileEntry::_modelLoader=0;
68 osgDB::RegisterReaderWriterProxy<ReaderWriterSTG> g_readerWriterSTGProxy;
69 ModelRegistryCallbackProxy<LoadOnlyCallback> g_stgCallbackProxy("stg");
74 // Update the timestamp on a tile whenever it is in view.
76 class TileCullCallback : public osg::NodeCallback
79 TileCullCallback() : _timeStamp(0) {}
80 TileCullCallback(const TileCullCallback& tc, const osg::CopyOp& copyOp) :
81 NodeCallback(tc, copyOp), _timeStamp(tc._timeStamp)
85 virtual void operator()(osg::Node* node, osg::NodeVisitor* nv);
86 double getTimeStamp() const { return _timeStamp; }
87 void setTimeStamp(double timeStamp) { _timeStamp = timeStamp; }
93 void TileCullCallback::operator()(osg::Node* node, osg::NodeVisitor* nv)
95 if (nv->getFrameStamp())
96 _timeStamp = nv->getFrameStamp()->getReferenceTime();
100 double TileEntry::get_timestamp() const
103 return (dynamic_cast<TileCullCallback*>(_node->getCullCallback()))
109 void TileEntry::set_timestamp(double time_ms)
113 = dynamic_cast<TileCullCallback*>(_node->getCullCallback());
115 cb->setTimeStamp(time_ms);
120 TileEntry::TileEntry ( const SGBucket& b )
122 _node( new osg::LOD ),
123 is_inner_ring(false),
124 tileFileName(b.gen_index_str())
126 _node->setCullCallback(new TileCullCallback);
127 tileFileName += ".stg";
128 _node->setName(tileFileName);
129 // Give a default LOD range so that traversals that traverse
130 // active children (like the groundcache lookup) will work before
131 // tile manager has had a chance to update this node.
132 _node->setRange(0, 0.0, 10000.0);
137 TileEntry::~TileEntry ()
141 static void WorldCoordinate(osg::Matrix& obj_pos, double lat,
142 double lon, double elev, double hdg)
144 SGGeod geod = SGGeod::fromDegM(lon, lat, elev);
145 obj_pos = geod.makeZUpFrame();
146 // hdg is not a compass heading, but a counter-clockwise rotation
148 obj_pos.preMult(osg::Matrix::rotate(hdg * SGD_DEGREES_TO_RADIANS,
153 // Clean up the memory used by this tile and delete the arrays used by
154 // ssg as well as the whole ssg branch
155 bool TileEntry::free_tile() {
156 SG_LOG( SG_TERRAIN, SG_DEBUG,
157 "FREEING TILE = (" << tile_bucket << ")" );
159 _node->removeChildren(0, _node->getNumChildren());
166 // Update the ssg transform node for this tile so it can be
167 // properly drawn relative to our (0,0,0) point
168 void TileEntry::prep_ssg_node(float vis) {
171 // visibility can change from frame to frame so we update the
172 // range selector cutoff's each time.
173 float bounding_radius = _node->getChild(0)->getBound().radius();
174 _node->setRange( 0, 0, vis + bounding_radius );
177 bool TileEntry::obj_load(const string& path, osg::Group *geometry, bool is_base,
178 const osgDB::ReaderWriter::Options* options)
180 osg::Node* node = osgDB::readNodeFile(path, options);
182 geometry->addChild(node);
197 // storage class for deferred object processing in TileEntry::load()
199 Object(object_type t, const string& token, const SGPath& p,
205 in >> lon >> lat >> elev >> hdg;
209 SG_LOG(SG_TERRAIN, SG_INFO, " " << token << " " << name);
211 SG_LOG(SG_TERRAIN, SG_INFO, " " << token << " " << name << " lon=" <<
212 lon << " lat=" << lat << " elev=" << elev << " hdg=" << hdg);
217 double lon, lat, elev, hdg;
220 // Work in progress... load the tile based entirely by name cuz that's
221 // what we'll want to do with the database pager.
224 TileEntry::loadTileByFileName(const string& fileName,
225 const osgDB::ReaderWriter::Options* options)
227 std::string index_str = osgDB::getNameLessExtension(fileName);
228 index_str = osgDB::getSimpleFileName(index_str);
232 std::istringstream idxStream(index_str);
233 idxStream >> tileIndex;
235 SGBucket tile_bucket(tileIndex);
236 const string basePath = tile_bucket.gen_base_path();
238 bool found_tile_base = false;
241 vector<const Object*> objects;
243 SG_LOG( SG_TERRAIN, SG_INFO, "Loading tile " << index_str );
245 osgDB::FilePathList path_list=options->getDatabasePathList();
246 // Make sure we find the original filename here...
247 std::string filePath = osgDB::getFilePath(fileName);
248 if (!filePath.empty())
249 path_list.push_front(filePath);
251 // scan and parse all files and store information
252 for (unsigned int i = 0; i < path_list.size(); i++) {
253 // If we found a terrain tile in Terrain/, we have to process the
254 // Objects/ dir in the same group, too, before we can stop scanning.
255 // FGGlobals::set_fg_scenery() inserts an empty string to path_list
258 if (path_list[i].empty()) {
265 bool has_base = false;
267 SGPath tile_path = path_list[i];
268 tile_path.append(basePath);
270 SGPath basename = tile_path;
271 basename.append( index_str );
273 SG_LOG( SG_TERRAIN, SG_INFO, " Trying " << basename.str() );
276 // Check for master .stg (scene terra gear) file
277 SGPath stg_name = basename;
278 stg_name.concat( ".stg" );
280 sg_gzifstream in( stg_name.str() );
284 while ( ! in.eof() ) {
288 if ( token.empty() || token[0] == '#' ) {
292 // Load only once (first found)
293 if ( token == "OBJECT_BASE" ) {
295 in >> name >> ::skipws;
296 SG_LOG( SG_TERRAIN, SG_INFO, " " << token << " " << name );
298 if (!found_tile_base) {
299 found_tile_base = true;
302 object_base = tile_path;
303 object_base.append(name);
306 SG_LOG(SG_TERRAIN, SG_INFO, " (skipped)");
308 // Load only if base is not in another file
309 } else if ( token == "OBJECT" ) {
310 if (!found_tile_base || has_base)
311 objects.push_back(new Object(OBJECT, token, tile_path, in));
314 in >> name >> ::skipeol;
315 SG_LOG(SG_TERRAIN, SG_INFO, " " << token << " "
316 << name << " (skipped)");
320 } else if ( token == "OBJECT_STATIC" ) {
321 objects.push_back(new Object(OBJECT_STATIC, token, tile_path, in));
323 } else if ( token == "OBJECT_SHARED" ) {
324 objects.push_back(new Object(OBJECT_SHARED, token, tile_path, in));
326 } else if ( token == "OBJECT_SIGN" ) {
327 objects.push_back(new Object(OBJECT_SIGN, token, tile_path, in));
329 } else if ( token == "OBJECT_RUNWAY_SIGN" ) {
330 objects.push_back(new Object(OBJECT_RUNWAY_SIGN, token, tile_path, in));
333 SG_LOG( SG_TERRAIN, SG_DEBUG,
334 "Unknown token '" << token << "' in " << stg_name.str() );
340 const SGReaderWriterBTGOptions* btgOpt;
341 btgOpt = dynamic_cast<const SGReaderWriterBTGOptions *>(options);
342 osg::ref_ptr<SGReaderWriterBTGOptions> opt;
344 opt = new SGReaderWriterBTGOptions(*btgOpt);
346 opt = new SGReaderWriterBTGOptions;
348 // obj_load() will generate ground lighting for us ...
349 osg::Group* new_tile = new osg::Group;
351 if (found_tile_base) {
352 // load tile if found ...
353 opt->setCalcLights(true);
354 obj_load( object_base.str(), new_tile, true, opt);
357 // ... or generate an ocean tile on the fly
358 SG_LOG(SG_TERRAIN, SG_INFO, " Generating ocean tile");
359 if ( !SGGenTile( path_list[0], tile_bucket,
360 opt->getMatlib(), new_tile ) ) {
361 SG_LOG( SG_TERRAIN, SG_ALERT,
362 "Warning: failed to generate ocean tile!" );
367 // now that we have a valid center, process all the objects
368 for (unsigned int j = 0; j < objects.size(); j++) {
369 const Object *obj = objects[j];
371 if (obj->type == OBJECT) {
372 SGPath custom_path = obj->path;
373 custom_path.append( obj->name );
374 opt->setCalcLights(true);
375 obj_load( custom_path.str(), new_tile, false, opt);
377 } else if (obj->type == OBJECT_SHARED || obj->type == OBJECT_STATIC) {
378 // object loading is deferred to main render thread,
379 // but lets figure out the paths right now.
381 if ( obj->type == OBJECT_STATIC ) {
382 custom_path = obj->path;
384 // custom_path = globals->get_fg_root();
386 custom_path.append( obj->name );
389 WorldCoordinate( obj_pos, obj->lat, obj->lon, obj->elev, obj->hdg );
391 osg::MatrixTransform *obj_trans = new osg::MatrixTransform;
392 obj_trans->setMatrix( obj_pos );
394 // wire as much of the scene graph together as we can
395 new_tile->addChild( obj_trans );
397 osg::Node* model = 0;
399 model = _modelLoader->loadTileModel(custom_path.str(),
400 obj->type == OBJECT_SHARED);
402 obj_trans->addChild(model);
403 } else if (obj->type == OBJECT_SIGN || obj->type == OBJECT_RUNWAY_SIGN) {
404 // load the object itself
405 SGPath custom_path = obj->path;
406 custom_path.append( obj->name );
409 WorldCoordinate( obj_pos, obj->lat, obj->lon, obj->elev, obj->hdg );
411 osg::MatrixTransform *obj_trans = new osg::MatrixTransform;
412 obj_trans->setMatrix( obj_pos );
414 osg::Node *custom_obj = 0;
415 if (obj->type == OBJECT_SIGN)
416 custom_obj = SGMakeSign(opt->getMatlib(), custom_path.str(), obj->name);
418 custom_obj = SGMakeRunwaySign(opt->getMatlib(), custom_path.str(), obj->name);
420 // wire the pieces together
421 if ( custom_obj != NULL ) {
422 obj_trans -> addChild( custom_obj );
424 new_tile->addChild( obj_trans );
433 TileEntry::addToSceneGraph(osg::Group *terrain_branch)
435 terrain_branch->addChild( _node.get() );
437 SG_LOG( SG_TERRAIN, SG_DEBUG,
438 "connected a tile into scene graph. _node = "
440 SG_LOG( SG_TERRAIN, SG_DEBUG, "num parents now = "
441 << _node->getNumParents() );
446 TileEntry::removeFromSceneGraph()
448 SG_LOG( SG_TERRAIN, SG_DEBUG, "disconnecting TileEntry nodes" );
451 SG_LOG( SG_TERRAIN, SG_DEBUG, "removing a not-fully loaded tile!" );
453 SG_LOG( SG_TERRAIN, SG_DEBUG, "removing a fully loaded tile! _node = " << _node.get() );
456 // find the nodes branch parent
457 if ( _node->getNumParents() > 0 ) {
458 // find the first parent (should only be one)
459 osg::Group *parent = _node->getParent( 0 ) ;
461 parent->removeChild( _node.get() );