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>
32 #include <osg/MatrixTransform>
34 #include <osg/NodeCallback>
36 #include <osgDB/FileNameUtils>
37 #include <osgDB/ReaderWriter>
38 #include <osgDB/ReadFile>
39 #include <osgDB/Registry>
41 #include <simgear/bucket/newbucket.hxx>
42 #include <simgear/debug/logstream.hxx>
43 #include <simgear/math/sg_geodesy.hxx>
44 #include <simgear/math/sg_random.h>
45 #include <simgear/math/SGMath.hxx>
46 #include <simgear/misc/sgstream.hxx>
47 #include <simgear/scene/material/mat.hxx>
48 #include <simgear/scene/material/matlib.hxx>
49 #include <simgear/scene/model/ModelRegistry.hxx>
50 #include <simgear/scene/tgdb/apt_signs.hxx>
51 #include <simgear/scene/tgdb/obj.hxx>
52 #include <simgear/scene/tgdb/SGReaderWriterBTGOptions.hxx>
54 #include "ReaderWriterSTG.hxx"
55 #include "TileEntry.hxx"
58 using namespace simgear;
60 ModelLoadHelper *TileEntry::_modelLoader=0;
63 osgDB::RegisterReaderWriterProxy<ReaderWriterSTG> g_readerWriterSTGProxy;
64 ModelRegistryCallbackProxy<LoadOnlyCallback> g_stgCallbackProxy("stg");
67 #ifdef USE_CULLCALLBACK_TS
70 // Update the timestamp on a tile whenever it is in view.
72 class TileCullCallback : public osg::NodeCallback
75 TileCullCallback() : _timeStamp(0) {}
76 TileCullCallback(const TileCullCallback& tc, const osg::CopyOp& copyOp) :
77 NodeCallback(tc, copyOp), _timeStamp(tc._timeStamp)
81 virtual void operator()(osg::Node* node, osg::NodeVisitor* nv);
82 double getTimeStamp() const { return _timeStamp; }
83 void setTimeStamp(double timeStamp) { _timeStamp = timeStamp; }
89 void TileCullCallback::operator()(osg::Node* node, osg::NodeVisitor* nv)
91 if (nv->getFrameStamp())
92 _timeStamp = nv->getFrameStamp()->getReferenceTime();
97 double TileEntry::get_timestamp() const
99 #ifdef USE_CULLCALLBACK_TS
101 return (dynamic_cast<TileCullCallback*>(_node->getCullCallback()))
110 void TileEntry::set_timestamp(double time_ms)
112 #ifdef USE_CULLCALLBACK_TS
115 = dynamic_cast<TileCullCallback*>(_node->getCullCallback());
117 cb->setTimeStamp(time_ms);
125 TileEntry::TileEntry ( const SGBucket& b )
127 tileFileName(b.gen_index_str()),
128 _node( new osg::LOD ),
130 ,is_cache_locked(false)
131 #ifndef USE_CULLCALLBACK_TS
135 #ifdef USE_CULLCALLBACK_TS
136 _node->setCullCallback(new TileCullCallback);
138 tileFileName += ".stg";
139 _node->setName(tileFileName);
140 // Give a default LOD range so that traversals that traverse
141 // active children (like the groundcache lookup) will work before
142 // tile manager has had a chance to update this node.
143 _node->setRange(0, 0.0, 10000.0);
148 TileEntry::~TileEntry ()
152 static void WorldCoordinate(osg::Matrix& obj_pos, double lat,
153 double lon, double elev, double hdg)
155 SGGeod geod = SGGeod::fromDegM(lon, lat, elev);
156 obj_pos = geod.makeZUpFrame();
157 // hdg is not a compass heading, but a counter-clockwise rotation
159 obj_pos.preMult(osg::Matrix::rotate(hdg * SGD_DEGREES_TO_RADIANS,
164 // Update the ssg transform node for this tile so it can be
165 // properly drawn relative to our (0,0,0) point
166 void TileEntry::prep_ssg_node(float vis) {
169 // visibility can change from frame to frame so we update the
170 // range selector cutoff's each time.
171 float bounding_radius = _node->getChild(0)->getBound().radius();
172 _node->setRange( 0, 0, vis + bounding_radius );
175 bool TileEntry::obj_load(const string& path, osg::Group *geometry, bool is_base,
176 const osgDB::ReaderWriter::Options* options)
178 osg::Node* node = osgDB::readNodeFile(path, options);
180 geometry->addChild(node);
195 // storage class for deferred object processing in TileEntry::load()
197 Object(object_type t, const string& token, const SGPath& p,
203 in >> lon >> lat >> elev >> hdg;
207 SG_LOG(SG_TERRAIN, SG_BULK, " " << token << " " << name);
209 SG_LOG(SG_TERRAIN, SG_BULK, " " << token << " " << name << " lon=" <<
210 lon << " lat=" << lat << " elev=" << elev << " hdg=" << hdg);
215 double lon, lat, elev, hdg;
218 // Work in progress... load the tile based entirely by name cuz that's
219 // what we'll want to do with the database pager.
222 TileEntry::loadTileByFileName(const string& fileName,
223 const osgDB::ReaderWriter::Options* options)
225 std::string index_str = osgDB::getNameLessExtension(fileName);
226 index_str = osgDB::getSimpleFileName(index_str);
230 std::istringstream idxStream(index_str);
231 idxStream >> tileIndex;
233 SGBucket tile_bucket(tileIndex);
234 const string basePath = tile_bucket.gen_base_path();
236 bool found_tile_base = false;
239 vector<const Object*> objects;
241 SG_LOG( SG_TERRAIN, SG_INFO, "Loading tile " << index_str );
243 osgDB::FilePathList path_list=options->getDatabasePathList();
244 // Make sure we find the original filename here...
245 std::string filePath = osgDB::getFilePath(fileName);
246 if (!filePath.empty())
247 path_list.push_front(filePath);
249 // scan and parse all files and store information
250 for (unsigned int i = 0; i < path_list.size(); i++) {
251 // If we found a terrain tile in Terrain/, we have to process the
252 // Objects/ dir in the same group, too, before we can stop scanning.
253 // FGGlobals::set_fg_scenery() inserts an empty string to path_list
256 if (path_list[i].empty()) {
263 bool has_base = false;
265 SGPath tile_path = path_list[i];
266 tile_path.append(basePath);
268 SGPath basename = tile_path;
269 basename.append( index_str );
271 SG_LOG( SG_TERRAIN, SG_DEBUG, " Trying " << basename.str() );
274 // Check for master .stg (scene terra gear) file
275 SGPath stg_name = basename;
276 stg_name.concat( ".stg" );
278 sg_gzifstream in( stg_name.str() );
282 while ( ! in.eof() ) {
286 if ( token.empty() || token[0] == '#' ) {
290 // Load only once (first found)
291 if ( token == "OBJECT_BASE" ) {
293 in >> name >> ::skipws;
294 SG_LOG( SG_TERRAIN, SG_BULK, " " << token << " " << name );
296 if (!found_tile_base) {
297 found_tile_base = true;
300 object_base = tile_path;
301 object_base.append(name);
304 SG_LOG(SG_TERRAIN, SG_BULK, " (skipped)");
306 // Load only if base is not in another file
307 } else if ( token == "OBJECT" ) {
308 if (!found_tile_base || has_base)
309 objects.push_back(new Object(OBJECT, token, tile_path, in));
312 in >> name >> ::skipeol;
313 SG_LOG(SG_TERRAIN, SG_BULK, " " << token << " "
314 << name << " (skipped)");
318 } else if ( token == "OBJECT_STATIC" ) {
319 objects.push_back(new Object(OBJECT_STATIC, token, tile_path, in));
321 } else if ( token == "OBJECT_SHARED" ) {
322 objects.push_back(new Object(OBJECT_SHARED, token, tile_path, in));
324 } else if ( token == "OBJECT_SIGN" ) {
325 objects.push_back(new Object(OBJECT_SIGN, token, tile_path, in));
327 } else if ( token == "OBJECT_RUNWAY_SIGN" ) {
328 objects.push_back(new Object(OBJECT_RUNWAY_SIGN, token, tile_path, in));
331 SG_LOG( SG_TERRAIN, SG_DEBUG,
332 "Unknown token '" << token << "' in " << stg_name.str() );
338 const SGReaderWriterBTGOptions* btgOpt;
339 btgOpt = dynamic_cast<const SGReaderWriterBTGOptions *>(options);
340 osg::ref_ptr<SGReaderWriterBTGOptions> opt;
342 opt = new SGReaderWriterBTGOptions(*btgOpt);
344 opt = new SGReaderWriterBTGOptions;
346 // obj_load() will generate ground lighting for us ...
347 osg::Group* new_tile = new osg::Group;
349 if (found_tile_base) {
350 // load tile if found ...
351 opt->setCalcLights(true);
352 obj_load( object_base.str(), new_tile, true, opt.get());
355 // ... or generate an ocean tile on the fly
356 SG_LOG(SG_TERRAIN, SG_INFO, " Generating ocean tile");
357 if ( !SGGenTile( path_list[0], tile_bucket,
358 opt->getMatlib(), new_tile ) ) {
359 SG_LOG( SG_TERRAIN, SG_ALERT,
360 "Warning: failed to generate ocean tile!" );
365 // now that we have a valid center, process all the objects
366 for (unsigned int j = 0; j < objects.size(); j++) {
367 const Object *obj = objects[j];
369 if (obj->type == OBJECT) {
370 SGPath custom_path = obj->path;
371 custom_path.append( obj->name );
372 opt->setCalcLights(true);
373 obj_load( custom_path.str(), new_tile, false, opt.get());
375 } else if (obj->type == OBJECT_SHARED || obj->type == OBJECT_STATIC) {
376 // object loading is deferred to main render thread,
377 // but lets figure out the paths right now.
379 if ( obj->type == OBJECT_STATIC ) {
380 custom_path = obj->path;
382 // custom_path = globals->get_fg_root();
384 custom_path.append( obj->name );
387 WorldCoordinate( obj_pos, obj->lat, obj->lon, obj->elev, obj->hdg );
389 osg::MatrixTransform *obj_trans = new osg::MatrixTransform;
390 obj_trans->setDataVariance(osg::Object::STATIC);
391 obj_trans->setMatrix( obj_pos );
393 // wire as much of the scene graph together as we can
394 new_tile->addChild( obj_trans );
396 osg::Node* model = 0;
398 model = _modelLoader->loadTileModel(custom_path.str(),
399 obj->type == OBJECT_SHARED);
401 obj_trans->addChild(model);
402 } else if (obj->type == OBJECT_SIGN || obj->type == OBJECT_RUNWAY_SIGN) {
403 // load the object itself
404 SGPath custom_path = obj->path;
405 custom_path.append( obj->name );
408 WorldCoordinate( obj_pos, obj->lat, obj->lon, obj->elev, obj->hdg );
410 osg::MatrixTransform *obj_trans = new osg::MatrixTransform;
411 obj_trans->setDataVariance(osg::Object::STATIC);
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() );