simgear/scene/tgdb/TileEntry.cxx

   1 // tileentry.cxx -- routines to handle a scenery tile
   2 //
   3 // Written by Curtis Olson, started May 1998.
   4 //
   5 // Copyright (C) 1998 - 2001  Curtis L. Olson  - http://www.flightgear.org/~curt
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include <simgear_config.h>
  23 #endif
  24
  25 #include <simgear/compiler.h>
  26
  27 #include <string>
  28 #include <sstream>
  29 #include <istream>
  30
  31 #include <osg/LOD>
  32 #include <osg/MatrixTransform>
  33 #include <osg/Math>
  34 #include <osg/NodeCallback>
  35
  36 #include <osgDB/FileNameUtils>
  37 #include <osgDB/ReaderWriter>
  38 #include <osgDB/ReadFile>
  39 #include <osgDB/Registry>
  40
  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>
  53
  54 #include "ReaderWriterSTG.hxx"
  55 #include "TileEntry.hxx"
  56
  57 using std::string;
  58 using namespace simgear;
  59
  60 ModelLoadHelper *TileEntry::_modelLoader=0;
  61
  62 namespace {
  63 osgDB::RegisterReaderWriterProxy<ReaderWriterSTG> g_readerWriterSTGProxy;
  64 ModelRegistryCallbackProxy<LoadOnlyCallback> g_stgCallbackProxy("stg");
  65 }
  66
  67 namespace
  68 {
  69 // Update the timestamp on a tile whenever it is in view.
  70
  71 class TileCullCallback : public osg::NodeCallback
  72 {
  73 public:
  74     TileCullCallback() : _timeStamp(0) {}
  75     TileCullCallback(const TileCullCallback& tc, const osg::CopyOp& copyOp) :
  76         NodeCallback(tc, copyOp), _timeStamp(tc._timeStamp)
  77     {
  78     }
  79
  80     virtual void operator()(osg::Node* node, osg::NodeVisitor* nv);
  81     double getTimeStamp() const { return _timeStamp; }
  82     void setTimeStamp(double timeStamp) { _timeStamp = timeStamp; }
  83 protected:
  84     double _timeStamp;
  85 };
  86 }
  87
  88 void TileCullCallback::operator()(osg::Node* node, osg::NodeVisitor* nv)
  89 {
  90     if (nv->getFrameStamp())
  91         _timeStamp = nv->getFrameStamp()->getReferenceTime();
  92     traverse(node, nv);
  93 }
  94
  95 double TileEntry::get_timestamp() const
  96 {
  97     if (_node.valid()) {
  98         return (dynamic_cast<TileCullCallback*>(_node->getCullCallback()))
  99             ->getTimeStamp();
 100     } else
 101         return DBL_MAX;
 102 }
 103
 104 void TileEntry::set_timestamp(double time_ms)
 105 {
 106     if (_node.valid()) {
 107         TileCullCallback* cb
 108             = dynamic_cast<TileCullCallback*>(_node->getCullCallback());
 109         if (cb)
 110             cb->setTimeStamp(time_ms);
 111     }
 112 }
 113
 114 // Constructor
 115 TileEntry::TileEntry ( const SGBucket& b )
 116     : tile_bucket( b ),
 117       _node( new osg::LOD ),
 118       is_inner_ring(false),
 119       tileFileName(b.gen_index_str())
 120 {
 121     _node->setCullCallback(new TileCullCallback);
 122     tileFileName += ".stg";
 123     _node->setName(tileFileName);
 124     // Give a default LOD range so that traversals that traverse
 125     // active children (like the groundcache lookup) will work before
 126     // tile manager has had a chance to update this node.
 127     _node->setRange(0, 0.0, 10000.0);
 128 }
 129
 130
 131 // Destructor
 132 TileEntry::~TileEntry ()
 133 {
 134 }
 135
 136 static void WorldCoordinate(osg::Matrix& obj_pos, double lat,
 137                             double lon, double elev, double hdg)
 138 {
 139     SGGeod geod = SGGeod::fromDegM(lon, lat, elev);
 140     obj_pos = geod.makeZUpFrame();
 141     // hdg is not a compass heading, but a counter-clockwise rotation
 142     // around the Z axis
 143     obj_pos.preMult(osg::Matrix::rotate(hdg * SGD_DEGREES_TO_RADIANS,
 144                                         0.0, 0.0, 1.0));
 145 }
 146
 147
 148 // Update the ssg transform node for this tile so it can be
 149 // properly drawn relative to our (0,0,0) point
 150 void TileEntry::prep_ssg_node(float vis) {
 151     if (!is_loaded())
 152         return;
 153     // visibility can change from frame to frame so we update the
 154     // range selector cutoff's each time.
 155     float bounding_radius = _node->getChild(0)->getBound().radius();
 156     _node->setRange( 0, 0, vis + bounding_radius );
 157 }
 158
 159 bool TileEntry::obj_load(const string& path, osg::Group *geometry, bool is_base,
 160                          const osgDB::ReaderWriter::Options* options)
 161 {
 162     osg::Node* node = osgDB::readNodeFile(path, options);
 163     if (node)
 164       geometry->addChild(node);
 165
 166     return node != 0;
 167 }
 168
 169
 170 typedef enum {
 171     OBJECT,
 172     OBJECT_SHARED,
 173     OBJECT_STATIC,
 174     OBJECT_SIGN,
 175     OBJECT_RUNWAY_SIGN
 176 } object_type;
 177
 178
 179 // storage class for deferred object processing in TileEntry::load()
 180 struct Object {
 181     Object(object_type t, const string& token, const SGPath& p,
 182            std::istream& in)
 183         : type(t), path(p)
 184     {
 185         in >> name;
 186         if (type != OBJECT)
 187             in >> lon >> lat >> elev >> hdg;
 188         in >> ::skipeol;
 189
 190         if (type == OBJECT)
 191             SG_LOG(SG_TERRAIN, SG_INFO, "    " << token << "  " << name);
 192         else
 193             SG_LOG(SG_TERRAIN, SG_INFO, "    " << token << "  " << name << "  lon=" <<
 194                     lon << "  lat=" << lat << "  elev=" << elev << "  hdg=" << hdg);
 195     }
 196     object_type type;
 197     string name;
 198     SGPath path;
 199     double lon, lat, elev, hdg;
 200 };
 201
 202 // Work in progress... load the tile based entirely by name cuz that's
 203 // what we'll want to do with the database pager.
 204
 205 osg::Node*
 206 TileEntry::loadTileByFileName(const string& fileName,
 207                               const osgDB::ReaderWriter::Options* options)
 208 {
 209     std::string index_str = osgDB::getNameLessExtension(fileName);
 210     index_str = osgDB::getSimpleFileName(index_str);
 211
 212     long tileIndex;
 213     {
 214         std::istringstream idxStream(index_str);
 215         idxStream >> tileIndex;
 216     }
 217     SGBucket tile_bucket(tileIndex);
 218     const string basePath = tile_bucket.gen_base_path();
 219
 220     bool found_tile_base = false;
 221
 222     SGPath object_base;
 223     vector<const Object*> objects;
 224
 225     SG_LOG( SG_TERRAIN, SG_INFO, "Loading tile " << index_str );
 226
 227     osgDB::FilePathList path_list=options->getDatabasePathList();
 228     // Make sure we find the original filename here...
 229     std::string filePath = osgDB::getFilePath(fileName);
 230     if (!filePath.empty())
 231         path_list.push_front(filePath);
 232
 233     // scan and parse all files and store information
 234     for (unsigned int i = 0; i < path_list.size(); i++) {
 235         // If we found a terrain tile in Terrain/, we have to process the
 236         // Objects/ dir in the same group, too, before we can stop scanning.
 237         // FGGlobals::set_fg_scenery() inserts an empty string to path_list
 238         // as marker.
 239
 240         if (path_list[i].empty()) {
 241             if (found_tile_base)
 242                 break;
 243             else
 244                 continue;
 245         }
 246
 247         bool has_base = false;
 248
 249         SGPath tile_path = path_list[i];
 250         tile_path.append(basePath);
 251
 252         SGPath basename = tile_path;
 253         basename.append( index_str );
 254
 255         SG_LOG( SG_TERRAIN, SG_INFO, "  Trying " << basename.str() );
 256
 257
 258         // Check for master .stg (scene terra gear) file
 259         SGPath stg_name = basename;
 260         stg_name.concat( ".stg" );
 261
 262         sg_gzifstream in( stg_name.str() );
 263         if ( !in.is_open() )
 264             continue;
 265
 266         while ( ! in.eof() ) {
 267             string token;
 268             in >> token;
 269
 270             if ( token.empty() || token[0] == '#' ) {
 271                in >> ::skipeol;
 272                continue;
 273             }
 274                             // Load only once (first found)
 275             if ( token == "OBJECT_BASE" ) {
 276                 string name;
 277                 in >> name >> ::skipws;
 278                 SG_LOG( SG_TERRAIN, SG_INFO, "    " << token << " " << name );
 279
 280                 if (!found_tile_base) {
 281                     found_tile_base = true;
 282                     has_base = true;
 283
 284                     object_base = tile_path;
 285                     object_base.append(name);
 286
 287                 } else
 288                     SG_LOG(SG_TERRAIN, SG_INFO, "    (skipped)");
 289
 290                             // Load only if base is not in another file
 291             } else if ( token == "OBJECT" ) {
 292                 if (!found_tile_base || has_base)
 293                     objects.push_back(new Object(OBJECT, token, tile_path, in));
 294                 else {
 295                     string name;
 296                     in >> name >> ::skipeol;
 297                     SG_LOG(SG_TERRAIN, SG_INFO, "    " << token << "  "
 298                             << name << "  (skipped)");
 299                 }
 300
 301                             // Always OK to load
 302             } else if ( token == "OBJECT_STATIC" ) {
 303                 objects.push_back(new Object(OBJECT_STATIC, token, tile_path, in));
 304
 305             } else if ( token == "OBJECT_SHARED" ) {
 306                 objects.push_back(new Object(OBJECT_SHARED, token, tile_path, in));
 307
 308             } else if ( token == "OBJECT_SIGN" ) {
 309                 objects.push_back(new Object(OBJECT_SIGN, token, tile_path, in));
 310
 311             } else if ( token == "OBJECT_RUNWAY_SIGN" ) {
 312                 objects.push_back(new Object(OBJECT_RUNWAY_SIGN, token, tile_path, in));
 313
 314             } else {
 315                 SG_LOG( SG_TERRAIN, SG_DEBUG,
 316                         "Unknown token '" << token << "' in " << stg_name.str() );
 317                 in >> ::skipws;
 318             }
 319         }
 320     }
 321
 322     const SGReaderWriterBTGOptions* btgOpt;
 323     btgOpt = dynamic_cast<const SGReaderWriterBTGOptions *>(options);
 324     osg::ref_ptr<SGReaderWriterBTGOptions> opt;
 325     if (btgOpt)
 326         opt = new SGReaderWriterBTGOptions(*btgOpt);
 327     else
 328         opt = new SGReaderWriterBTGOptions;
 329
 330     // obj_load() will generate ground lighting for us ...
 331     osg::Group* new_tile = new osg::Group;
 332
 333     if (found_tile_base) {
 334         // load tile if found ...
 335         opt->setCalcLights(true);
 336         obj_load( object_base.str(), new_tile, true, opt);
 337
 338     } else {
 339         // ... or generate an ocean tile on the fly
 340         SG_LOG(SG_TERRAIN, SG_INFO, "  Generating ocean tile");
 341         if ( !SGGenTile( path_list[0], tile_bucket,
 342                         opt->getMatlib(), new_tile ) ) {
 343             SG_LOG( SG_TERRAIN, SG_ALERT,
 344                     "Warning: failed to generate ocean tile!" );
 345         }
 346     }
 347
 348
 349     // now that we have a valid center, process all the objects
 350     for (unsigned int j = 0; j < objects.size(); j++) {
 351         const Object *obj = objects[j];
 352
 353         if (obj->type == OBJECT) {
 354             SGPath custom_path = obj->path;
 355             custom_path.append( obj->name );
 356             opt->setCalcLights(true);
 357             obj_load( custom_path.str(), new_tile, false, opt);
 358
 359         } else if (obj->type == OBJECT_SHARED || obj->type == OBJECT_STATIC) {
 360             // object loading is deferred to main render thread,
 361             // but lets figure out the paths right now.
 362             SGPath custom_path;
 363             if ( obj->type == OBJECT_STATIC ) {
 364                 custom_path = obj->path;
 365             } else {
 366                 // custom_path = globals->get_fg_root();
 367             }
 368             custom_path.append( obj->name );
 369
 370             osg::Matrix obj_pos;
 371             WorldCoordinate( obj_pos, obj->lat, obj->lon, obj->elev, obj->hdg );
 372
 373             osg::MatrixTransform *obj_trans = new osg::MatrixTransform;
 374             obj_trans->setDataVariance(osg::Object::STATIC);
 375             obj_trans->setMatrix( obj_pos );
 376
 377             // wire as much of the scene graph together as we can
 378             new_tile->addChild( obj_trans );
 379
 380             osg::Node* model = 0;
 381             if(_modelLoader)
 382                 model = _modelLoader->loadTileModel(custom_path.str(),
 383                                                     obj->type == OBJECT_SHARED);
 384             if (model)
 385                 obj_trans->addChild(model);
 386         } else if (obj->type == OBJECT_SIGN || obj->type == OBJECT_RUNWAY_SIGN) {
 387             // load the object itself
 388             SGPath custom_path = obj->path;
 389             custom_path.append( obj->name );
 390
 391             osg::Matrix obj_pos;
 392             WorldCoordinate( obj_pos, obj->lat, obj->lon, obj->elev, obj->hdg );
 393
 394             osg::MatrixTransform *obj_trans = new osg::MatrixTransform;
 395             obj_trans->setDataVariance(osg::Object::STATIC);
 396             obj_trans->setMatrix( obj_pos );
 397
 398             osg::Node *custom_obj = 0;
 399             if (obj->type == OBJECT_SIGN)
 400                 custom_obj = SGMakeSign(opt->getMatlib(), custom_path.str(), obj->name);
 401             else
 402                 custom_obj = SGMakeRunwaySign(opt->getMatlib(), custom_path.str(), obj->name);
 403
 404             // wire the pieces together
 405             if ( custom_obj != NULL ) {
 406                 obj_trans -> addChild( custom_obj );
 407             }
 408             new_tile->addChild( obj_trans );
 409
 410         }
 411         delete obj;
 412     }
 413     return new_tile;
 414 }
 415
 416 void
 417 TileEntry::addToSceneGraph(osg::Group *terrain_branch)
 418 {
 419     terrain_branch->addChild( _node.get() );
 420
 421     SG_LOG( SG_TERRAIN, SG_DEBUG,
 422             "connected a tile into scene graph.  _node = "
 423             << _node.get() );
 424     SG_LOG( SG_TERRAIN, SG_DEBUG, "num parents now = "
 425             << _node->getNumParents() );
 426 }
 427
 428
 429 void
 430 TileEntry::removeFromSceneGraph()
 431 {
 432     SG_LOG( SG_TERRAIN, SG_DEBUG, "disconnecting TileEntry nodes" );
 433
 434     if (! is_loaded()) {
 435         SG_LOG( SG_TERRAIN, SG_DEBUG, "removing a not-fully loaded tile!" );
 436     } else {
 437         SG_LOG( SG_TERRAIN, SG_DEBUG, "removing a fully loaded tile!  _node = " << _node.get() );
 438     }
 439
 440     // find the nodes branch parent
 441     if ( _node->getNumParents() > 0 ) {
 442         // find the first parent (should only be one)
 443         osg::Group *parent = _node->getParent( 0 ) ;
 444         if( parent ) {
 445             parent->removeChild( _node.get() );
 446         }
 447     }
 448 }
 449