simgear/scene/tgdb/ReaderWriterSTG.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
  22 #ifdef HAVE_CONFIG_H
  23 #  include <simgear_config.h>
  24 #endif
  25
  26 #include "ReaderWriterSTG.hxx"
  27
  28 #include <osg/LOD>
  29 #include <osg/MatrixTransform>
  30 #include <osg/PagedLOD>
  31 #include <osg/ProxyNode>
  32 #include <osgUtil/LineSegmentIntersector>
  33 #include <osgUtil/IntersectionVisitor>
  34
  35 #include <osgDB/FileNameUtils>
  36 #include <osgDB/FileUtils>
  37 #include <osgDB/Registry>
  38 #include <osgDB/ReaderWriter>
  39 #include <osgDB/ReadFile>
  40
  41 #include <simgear/math/SGGeometry.hxx>
  42 #include <simgear/bucket/newbucket.hxx>
  43 #include <simgear/debug/logstream.hxx>
  44 #include <simgear/misc/sgstream.hxx>
  45 #include <simgear/scene/util/OptionsReadFileCallback.hxx>
  46 #include <simgear/scene/util/OsgMath.hxx>
  47 #include <simgear/scene/util/RenderConstants.hxx>
  48 #include <simgear/scene/util/SGReaderWriterOptions.hxx>
  49 #include <simgear/scene/tgdb/apt_signs.hxx>
  50 #include <simgear/scene/tgdb/obj.hxx>
  51
  52 #include "SGOceanTile.hxx"
  53
  54 namespace simgear {
  55
  56 /// Ok, this is a hack - we do not exactly know if it's an airport or not.
  57 /// This feature might also vanish again later. This is currently to
  58 /// support testing an external ai component that just loads the the airports
  59 /// and supports ground queries on only these areas.
  60 static bool isAirportBtg(const std::string& name)
  61 {
  62     if (name.size() < 8)
  63         return false;
  64     if (name.substr(4, 8) != ".btg")
  65         return false;
  66     for (unsigned i = 0; i < 4; ++i) {
  67         if (name[i] < 'A' || 'Z' < name[i])
  68             continue;
  69         return true;
  70     }
  71     return false;
  72 }
  73
  74 static SGBucket bucketIndexFromFileName(const std::string& fileName)
  75 {
  76   // Extract the bucket from the filename
  77   std::istringstream ss(osgDB::getNameLessExtension(fileName));
  78   long index;
  79   ss >> index;
  80   if (ss.fail())
  81     return SGBucket();
  82
  83   return SGBucket(index);
  84 }
  85
  86 struct ReaderWriterSTG::_ModelBin {
  87     struct _Object {
  88         std::string _errorLocation;
  89         std::string _token;
  90         std::string _name;
  91         osg::ref_ptr<SGReaderWriterOptions> _options;
  92     };
  93     struct _ObjectStatic {
  94         _ObjectStatic() : _agl(false), _proxy(false), _lon(0), _lat(0), _elev(0), _hdg(0), _pitch(0), _roll(0) { }
  95         std::string _errorLocation;
  96         std::string _token;
  97         std::string _name;
  98         bool _agl;
  99         bool _proxy;
 100         double _lon, _lat, _elev;
 101         double _hdg, _pitch, _roll;
 102         osg::ref_ptr<SGReaderWriterOptions> _options;
 103     };
 104     struct _Sign {
 105         _Sign() : _agl(false), _lon(0), _lat(0), _elev(0), _hdg(0), _size(-1) { }
 106         std::string _errorLocation;
 107         std::string _token;
 108         std::string _name;
 109         bool _agl;
 110         double _lon, _lat, _elev;
 111         double _hdg;
 112         int _size;
 113     };
 114
 115     class DelayLoadReadFileCallback : public OptionsReadFileCallback {
 116     public:
 117         virtual osgDB::ReaderWriter::ReadResult
 118         readNode(const std::string&, const osgDB::Options*)
 119         {
 120             osg::ref_ptr<osg::Group> group = new osg::Group;
 121             group->setDataVariance(osg::Object::STATIC);
 122
 123             for (std::list<_ObjectStatic>::iterator i = _objectStaticList.begin(); i != _objectStaticList.end(); ++i) {
 124                 osg::ref_ptr<osg::Node> node;
 125                 if (i->_proxy)  {
 126                     osg::ref_ptr<osg::ProxyNode> proxy = new osg::ProxyNode;
 127                     proxy->setLoadingExternalReferenceMode(osg::ProxyNode::DEFER_LOADING_TO_DATABASE_PAGER);
 128                     proxy->setFileName(0, i->_name);
 129                     proxy->setDatabaseOptions(i->_options.get());
 130                     node = proxy;
 131                 } else {
 132                     node = osgDB::readRefNodeFile(i->_name, i->_options.get());
 133                     if (!node.valid()) {
 134                         SG_LOG(SG_TERRAIN, SG_ALERT, i->_errorLocation << ": Failed to load "
 135                                << i->_token << " '" << i->_name << "'");
 136                         continue;
 137                     }
 138                 }
 139                 if (SGPath(i->_name).lower_extension() == "ac")
 140                     node->setNodeMask(~simgear::MODELLIGHT_BIT);
 141
 142                 osg::Matrix matrix;
 143                 matrix = makeZUpFrame(SGGeod::fromDegM(i->_lon, i->_lat, i->_elev));
 144                 matrix.preMultRotate(osg::Quat(SGMiscd::deg2rad(i->_hdg), osg::Vec3(0, 0, 1)));
 145                 matrix.preMultRotate(osg::Quat(SGMiscd::deg2rad(i->_pitch), osg::Vec3(0, 1, 0)));
 146                 matrix.preMultRotate(osg::Quat(SGMiscd::deg2rad(i->_roll), osg::Vec3(1, 0, 0)));
 147
 148                 osg::MatrixTransform* matrixTransform;
 149                 matrixTransform = new osg::MatrixTransform(matrix);
 150                 matrixTransform->setDataVariance(osg::Object::STATIC);
 151                 matrixTransform->addChild(node.get());
 152                 group->addChild(matrixTransform);
 153             }
 154
 155             simgear::AirportSignBuilder signBuilder(_options->getMaterialLib(), _bucket.get_center());
 156             for (std::list<_Sign>::iterator i = _signList.begin(); i != _signList.end(); ++i)
 157                 signBuilder.addSign(SGGeod::fromDegM(i->_lon, i->_lat, i->_elev), i->_hdg, i->_name, i->_size);
 158             if (signBuilder.getSignsGroup())
 159                 group->addChild(signBuilder.getSignsGroup());
 160
 161             return group.release();
 162         }
 163
 164         std::list<_ObjectStatic> _objectStaticList;
 165         std::list<_Sign> _signList;
 166
 167         /// The original options to use for this bunch of models
 168         osg::ref_ptr<SGReaderWriterOptions> _options;
 169         SGBucket _bucket;
 170     };
 171
 172     _ModelBin() :
 173         _foundBase(false)
 174     { }
 175
 176     SGReaderWriterOptions* sharedOptions(const std::string& filePath, const osgDB::Options* options)
 177     {
 178         osg::ref_ptr<SGReaderWriterOptions> sharedOptions;
 179         sharedOptions = SGReaderWriterOptions::copyOrCreate(options);
 180         sharedOptions->getDatabasePathList().clear();
 181
 182         SGPath path = filePath;
 183         path.append(".."); path.append(".."); path.append("..");
 184         sharedOptions->getDatabasePathList().push_back(path.str());
 185         std::string fg_root = options->getPluginStringData("SimGear::FG_ROOT");
 186         sharedOptions->getDatabasePathList().push_back(fg_root);
 187
 188         // TODO how should we handle this for OBJECT_SHARED?
 189         sharedOptions->setModelData
 190         (
 191             sharedOptions->getModelData()
 192           ? sharedOptions->getModelData()->clone()
 193           : 0
 194         );
 195
 196         return sharedOptions.release();
 197     }
 198     SGReaderWriterOptions* staticOptions(const std::string& filePath, const osgDB::Options* options)
 199     {
 200         osg::ref_ptr<SGReaderWriterOptions> staticOptions;
 201         staticOptions = SGReaderWriterOptions::copyOrCreate(options);
 202         staticOptions->getDatabasePathList().clear();
 203
 204         staticOptions->getDatabasePathList().push_back(filePath);
 205         staticOptions->setObjectCacheHint(osgDB::Options::CACHE_NONE);
 206
 207         // Every model needs its own SGModelData to ensure load/unload is
 208         // working properly
 209         staticOptions->setModelData
 210         (
 211             staticOptions->getModelData()
 212           ? staticOptions->getModelData()->clone()
 213           : 0
 214         );
 215
 216         return staticOptions.release();
 217     }
 218
 219     double elevation(osg::Group& group, const SGGeod& geod)
 220     {
 221         SGVec3d start = SGVec3d::fromGeod(SGGeod::fromGeodM(geod, 10000));
 222         SGVec3d end = SGVec3d::fromGeod(SGGeod::fromGeodM(geod, -1000));
 223
 224         osg::ref_ptr<osgUtil::LineSegmentIntersector> intersector;
 225         intersector = new osgUtil::LineSegmentIntersector(toOsg(start), toOsg(end));
 226         osgUtil::IntersectionVisitor visitor(intersector.get());
 227         group.accept(visitor);
 228
 229         if (!intersector->containsIntersections())
 230             return 0;
 231
 232         SGVec3d cart = toSG(intersector->getFirstIntersection().getWorldIntersectPoint());
 233         return SGGeod::fromCart(cart).getElevationM();
 234     }
 235
 236     bool read(const std::string& absoluteFileName, const osgDB::Options* options)
 237     {
 238         if (absoluteFileName.empty())
 239             return false;
 240
 241         sg_gzifstream stream(absoluteFileName);
 242         if (!stream.is_open())
 243             return false;
 244
 245         SG_LOG(SG_TERRAIN, SG_INFO, "Loading stg file " << absoluteFileName);
 246
 247         std::string filePath = osgDB::getFilePath(absoluteFileName);
 248
 249         // do only load airport btg files.
 250         bool onlyAirports = options->getPluginStringData("SimGear::FG_ONLY_AIRPORTS") == "ON";
 251         // do only load terrain btg files
 252         bool onlyTerrain = options->getPluginStringData("SimGear::FG_ONLY_TERRAIN") == "ON";
 253
 254         while (!stream.eof()) {
 255             // read a line
 256             std::string line;
 257             std::getline(stream, line);
 258
 259             // strip comments
 260             std::string::size_type hash_pos = line.find('#');
 261             if (hash_pos != std::string::npos)
 262                 line.resize(hash_pos);
 263
 264             // and process further
 265             std::stringstream in(line);
 266
 267             std::string token;
 268             in >> token;
 269
 270             // No comment
 271             if (token.empty())
 272                 continue;
 273
 274             // Then there is always a name
 275             std::string name;
 276             in >> name;
 277
 278             SGPath path = filePath;
 279             path.append(name);
 280
 281             if (token == "OBJECT_BASE") {
 282                 // Load only once (first found)
 283                 SG_LOG( SG_TERRAIN, SG_BULK, "    " << token << " " << name );
 284                 _foundBase = true;
 285                 if (!onlyAirports || isAirportBtg(name)) {
 286                     _Object obj;
 287                     obj._errorLocation = absoluteFileName;
 288                     obj._token = token;
 289                     obj._name = path.str();
 290                     obj._options = staticOptions(filePath, options);
 291                     _objectList.push_back(obj);
 292                 }
 293
 294             } else if (token == "OBJECT") {
 295                 if (!onlyAirports || isAirportBtg(name)) {
 296                     _Object obj;
 297                     obj._errorLocation = absoluteFileName;
 298                     obj._token = token;
 299                     obj._name = path.str();
 300                     obj._options = staticOptions(filePath, options);
 301                     _objectList.push_back(obj);
 302                 }
 303
 304             } else {
 305                 // Always OK to load
 306                 if (token == "OBJECT_STATIC" || token == "OBJECT_STATIC_AGL") {
 307                     if (!onlyTerrain) {
 308                         osg::ref_ptr<SGReaderWriterOptions> opt;
 309                         opt = staticOptions(filePath, options);
 310                         if (SGPath(name).lower_extension() == "ac")
 311                             opt->setInstantiateEffects(true);
 312                         else
 313                             opt->setInstantiateEffects(false);
 314                         _ObjectStatic obj;
 315                         obj._errorLocation = absoluteFileName;
 316                         obj._token = token;
 317                         obj._name = name;
 318                         obj._agl = (token == "OBJECT_STATIC_AGL");
 319                         obj._proxy = true;
 320                         in >> obj._lon >> obj._lat >> obj._elev >> obj._hdg >> obj._pitch >> obj._roll;
 321                         obj._options = opt;
 322                         _objectStaticList.push_back(obj);
 323                     }
 324
 325                 } else if (token == "OBJECT_SHARED" || token == "OBJECT_SHARED_AGL") {
 326                     if (!onlyTerrain) {
 327                         osg::ref_ptr<SGReaderWriterOptions> opt;
 328                         opt = sharedOptions(filePath, options);
 329                         if (SGPath(name).lower_extension() == "ac")
 330                             opt->setInstantiateEffects(true);
 331                         else
 332                             opt->setInstantiateEffects(false);
 333                         _ObjectStatic obj;
 334                         obj._errorLocation = absoluteFileName;
 335                         obj._token = token;
 336                         obj._name = name;
 337                         obj._agl = (token == "OBJECT_SHARED_AGL");
 338                         obj._proxy = false;
 339                         in >> obj._lon >> obj._lat >> obj._elev >> obj._hdg >> obj._pitch >> obj._roll;
 340                         obj._options = opt;
 341                         _objectStaticList.push_back(obj);
 342                     }
 343
 344                 } else if (token == "OBJECT_SIGN" || token == "OBJECT_SIGN_AGL") {
 345                     if (!onlyTerrain) {
 346                         _Sign sign;
 347                         sign._token = token;
 348                         sign._name = name;
 349                         sign._agl = (token == "OBJECT_SIGN_AGL");
 350                         in >> sign._lon >> sign._lat >> sign._elev >> sign._hdg >> sign._size;
 351                         _signList.push_back(sign);
 352                     }
 353
 354                 } else {
 355                     SG_LOG( SG_TERRAIN, SG_ALERT, absoluteFileName
 356                             << ": Unknown token '" << token << "'" );
 357                 }
 358             }
 359         }
 360
 361         return true;
 362     }
 363
 364     osg::Node* load(const SGBucket& bucket, const osgDB::Options* opt)
 365     {
 366         osg::ref_ptr<SGReaderWriterOptions> options;
 367         options = SGReaderWriterOptions::copyOrCreate(opt);
 368
 369         osg::ref_ptr<osg::Group> terrainGroup = new osg::Group;
 370         terrainGroup->setDataVariance(osg::Object::STATIC);
 371
 372         if (_foundBase) {
 373             for (std::list<_Object>::iterator i = _objectList.begin(); i != _objectList.end(); ++i) {
 374                 osg::ref_ptr<osg::Node> node;
 375                 node = osgDB::readRefNodeFile(i->_name, i->_options.get());
 376                 if (!node.valid()) {
 377                     SG_LOG(SG_TERRAIN, SG_ALERT, i->_errorLocation << ": Failed to load "
 378                            << i->_token << " '" << i->_name << "'");
 379                     continue;
 380                 }
 381                 terrainGroup->addChild(node.get());
 382             }
 383         } else {
 384             SG_LOG(SG_TERRAIN, SG_INFO, "  Generating ocean tile");
 385
 386             osg::Node* node = SGOceanTile(bucket, options->getMaterialLib());
 387             if (node) {
 388                 terrainGroup->addChild(node);
 389             } else {
 390                 SG_LOG( SG_TERRAIN, SG_ALERT,
 391                         "Warning: failed to generate ocean tile!" );
 392             }
 393         }
 394
 395         for (std::list<_ObjectStatic>::iterator i = _objectStaticList.begin(); i != _objectStaticList.end(); ++i) {
 396             if (!i->_agl)
 397                 continue;
 398             i->_elev += elevation(*terrainGroup, SGGeod::fromDeg(i->_lon, i->_lat));
 399         }
 400
 401         for (std::list<_Sign>::iterator i = _signList.begin(); i != _signList.end(); ++i) {
 402             if (!i->_agl)
 403                 continue;
 404             i->_elev += elevation(*terrainGroup, SGGeod::fromDeg(i->_lon, i->_lat));
 405         }
 406
 407         if (_objectStaticList.empty() && _signList.empty()) {
 408             // The simple case, just return the terrain group
 409             return terrainGroup.release();
 410         } else {
 411             osg::PagedLOD* pagedLOD = new osg::PagedLOD;
 412             pagedLOD->setCenterMode(osg::PagedLOD::USE_BOUNDING_SPHERE_CENTER);
 413
 414             // This should be visible in any case.
 415             // If this is replaced by some lower level of detail, the parent LOD node handles this.
 416             pagedLOD->addChild(terrainGroup, 0, std::numeric_limits<float>::max());
 417
 418             // we just need to know about the read file callback that itself holds the data
 419             osg::ref_ptr<DelayLoadReadFileCallback> readFileCallback = new DelayLoadReadFileCallback;
 420             readFileCallback->_objectStaticList = _objectStaticList;
 421             readFileCallback->_signList = _signList;
 422             readFileCallback->_options = options;
 423             readFileCallback->_bucket = bucket;
 424             osg::ref_ptr<osgDB::Options> callbackOptions = new osgDB::Options;
 425             callbackOptions->setReadFileCallback(readFileCallback.get());
 426             pagedLOD->setDatabaseOptions(callbackOptions.get());
 427
 428             pagedLOD->setFileName(pagedLOD->getNumChildren(), "Dummy name - use the stored data in the read file callback");
 429             pagedLOD->setRange(pagedLOD->getNumChildren(), 0, 30000);
 430
 431             return pagedLOD;
 432         }
 433     }
 434
 435     bool _foundBase;
 436     std::list<_Object> _objectList;
 437     std::list<_ObjectStatic> _objectStaticList;
 438     std::list<_Sign> _signList;
 439 };
 440
 441 ReaderWriterSTG::ReaderWriterSTG()
 442 {
 443     supportsExtension("stg", "SimGear stg database format");
 444 }
 445
 446 ReaderWriterSTG::~ReaderWriterSTG()
 447 {
 448 }
 449
 450 const char* ReaderWriterSTG::className() const
 451 {
 452     return "STG Database reader";
 453 }
 454
 455 osgDB::ReaderWriter::ReadResult
 456 ReaderWriterSTG::readNode(const std::string& fileName, const osgDB::Options* options) const
 457 {
 458     _ModelBin modelBin;
 459     SGBucket bucket(bucketIndexFromFileName(fileName));
 460
 461     // We treat 123.stg different than ./123.stg.
 462     // The difference is that ./123.stg as well as any absolute path
 463     // really loads the given stg file and only this.
 464     // In contrast 123.stg uses the search paths to load a set of stg
 465     // files spread across the scenery directories.
 466     if (osgDB::getSimpleFileName(fileName) != fileName) {
 467         if (!modelBin.read(fileName, options))
 468             return ReadResult::FILE_NOT_FOUND;
 469     } else {
 470         // For stg meta files, we need options for the search path.
 471         if (!options)
 472             return ReadResult::FILE_NOT_FOUND;
 473
 474         SG_LOG(SG_TERRAIN, SG_INFO, "Loading tile " << fileName);
 475
 476         std::string basePath = bucket.gen_base_path();
 477
 478         // Stop scanning once an object base is found
 479         // This is considered a meta file, so apply the scenery path search
 480         const osgDB::FilePathList& filePathList = options->getDatabasePathList();
 481         for (osgDB::FilePathList::const_iterator i = filePathList.begin();
 482              i != filePathList.end() && !modelBin._foundBase; ++i) {
 483             SGPath objects(*i);
 484             objects.append("Objects");
 485             objects.append(basePath);
 486             objects.append(fileName);
 487             modelBin.read(objects.str(), options);
 488
 489             SGPath terrain(*i);
 490             terrain.append("Terrain");
 491             terrain.append(basePath);
 492             terrain.append(fileName);
 493             modelBin.read(terrain.str(), options);
 494         }
 495     }
 496
 497     return modelBin.load(bucket, options);
 498 }
 499
 500 }