#endif
#include <simgear/compiler.h>
-#include <plib/ul.h>
-#include STL_STRING
+#include <string>
#include <sstream>
+#include <istream>
-#include <osg/Array>
-#include <osg/Geometry>
-#include <osg/Geode>
#include <osg/LOD>
#include <osg/MatrixTransform>
#include <osg/Math>
#include <osg/NodeCallback>
-#include <osg/Switch>
+#include <osg/ProxyNode>
#include <osgDB/FileNameUtils>
+#include <osgDB/FileUtils>
#include <osgDB/ReaderWriter>
#include <osgDB/ReadFile>
#include <osgDB/Registry>
#include <simgear/bucket/newbucket.hxx>
#include <simgear/debug/logstream.hxx>
-#include <simgear/math/polar3d.hxx>
#include <simgear/math/sg_geodesy.hxx>
#include <simgear/math/sg_random.h>
-#include <simgear/math/SGMath.hxx>
#include <simgear/misc/sgstream.hxx>
#include <simgear/scene/material/mat.hxx>
#include <simgear/scene/material/matlib.hxx>
-#include <simgear/scene/model/ModelRegistry.hxx>
#include <simgear/scene/tgdb/apt_signs.hxx>
#include <simgear/scene/tgdb/obj.hxx>
-#include <simgear/scene/tgdb/SGReaderWriterBTGOptions.hxx>
-#include <simgear/scene/model/placementtrans.hxx>
-#include <simgear/scene/util/SGUpdateVisitor.hxx>
+#include <simgear/scene/util/OsgMath.hxx>
+#include <simgear/scene/util/SGReaderWriterOptions.hxx>
-#include "ReaderWriterSTG.hxx"
+#include "SGOceanTile.hxx"
#include "TileEntry.hxx"
-SG_USING_STD(string);
+using std::string;
using namespace simgear;
-ModelLoadHelper *TileEntry::_modelLoader=0;
+static ModelLoadHelper *_modelLoader=0;
-namespace {
-osgDB::RegisterReaderWriterProxy<ReaderWriterSTG> g_readerWriterSTGProxy;
-ModelRegistryCallbackProxy<LoadOnlyCallback> g_stgCallbackProxy("stg");
-}
-
-// FIXME: investigate what huge update flood is clamped away here ...
-class FGTileUpdateCallback : public osg::NodeCallback {
-public:
- virtual void operator()(osg::Node* node, osg::NodeVisitor* nv)
- {
- assert(dynamic_cast<SGUpdateVisitor*>(nv));
- SGUpdateVisitor* updateVisitor = static_cast<SGUpdateVisitor*>(nv);
-
- osg::Vec3 center = node->getBound().center();
- double distance = dist(updateVisitor->getGlobalEyePos(),
- SGVec3d(center[0], center[1], center[2]));
- if (updateVisitor->getVisibility() + node->getBound().radius() < distance)
- return;
-
- traverse(node, nv);
- }
-};
-
-namespace
+static SGBucket getBucketFromFileName(const std::string& fileName)
{
-// Update the timestamp on a tile whenever it is in view.
-
-class TileCullCallback : public osg::NodeCallback
-{
-public:
- TileCullCallback() : _timeStamp(0) {}
- TileCullCallback(const TileCullCallback& tc, const osg::CopyOp& copyOp) :
- NodeCallback(tc, copyOp), _timeStamp(tc._timeStamp)
- {
- }
-
- virtual void operator()(osg::Node* node, osg::NodeVisitor* nv);
- double getTimeStamp() const { return _timeStamp; }
- void setTimeStamp(double timeStamp) { _timeStamp = timeStamp; }
-protected:
- double _timeStamp;
-};
+ std::istringstream ss(osgDB::getNameLessExtension(fileName));
+ long index;
+ ss >> index;
+ if (ss.fail())
+ return SGBucket();
+ return SGBucket(index);
}
-void TileCullCallback::operator()(osg::Node* node, osg::NodeVisitor* nv)
+static bool
+loadStgFile(const std::string& absoluteFileName, osg::Group& group, const osgDB::Options* options)
{
- if (nv->getFrameStamp())
- _timeStamp = nv->getFrameStamp()->getReferenceTime();
- traverse(node, nv);
-}
+ if (absoluteFileName.empty())
+ return false;
+
+ sg_gzifstream in( absoluteFileName );
+ if ( !in.is_open() )
+ return false;
+
+ SG_LOG(SG_TERRAIN, SG_INFO, "Loading stg file " << absoluteFileName);
+
+ std::string filePath = osgDB::getFilePath(absoluteFileName);
+
+ osg::ref_ptr<SGReaderWriterOptions> staticOptions;
+ staticOptions = SGReaderWriterOptions::copyOrCreate(options);
+ staticOptions->getDatabasePathList().clear();
+ staticOptions->getDatabasePathList().push_back(filePath);
+ staticOptions->setObjectCacheHint(osgDB::Options::CACHE_NONE);
+
+ osg::ref_ptr<SGReaderWriterOptions> sharedOptions;
+ sharedOptions = SGReaderWriterOptions::copyOrCreate(options);
+ sharedOptions->getDatabasePathList().clear();
+
+ SGPath path = filePath;
+ path.append(".."); path.append(".."); path.append("..");
+ sharedOptions->getDatabasePathList().push_back(path.str());
+ std::string fg_root = options->getPluginStringData("SimGear::FG_ROOT");
+ sharedOptions->getDatabasePathList().push_back(fg_root);
+
+ bool has_base = false;
+ while ( ! in.eof() ) {
+ std::string token;
+ in >> token;
+
+ // No comment
+ if ( token.empty() || token[0] == '#' ) {
+ in >> ::skipeol;
+ continue;
+ }
+
+ // Then there is always a name
+ std::string name;
+ in >> name;
+
+ SGPath path = filePath;
+ path.append(name);
+
+ osg::ref_ptr<osg::Node> node;
+ if ( token == "OBJECT_BASE" ) {
+ // Load only once (first found)
+ SG_LOG( SG_TERRAIN, SG_BULK, " " << token << " " << name );
+
+ has_base = true;
+ node = osgDB::readRefNodeFile(path.str(),
+ staticOptions.get());
+
+ if (!node.valid()) {
+ SG_LOG( SG_TERRAIN, SG_ALERT, absoluteFileName
+ << ": Failed to load OBJECT_BASE '"
+ << name << "'" );
+ }
+
+ } else if ( token == "OBJECT" ) {
+ node = osgDB::readRefNodeFile(path.str(),
+ staticOptions.get());
+
+ if (!node.valid()) {
+ SG_LOG( SG_TERRAIN, SG_ALERT, absoluteFileName
+ << ": Failed to load OBJECT '"
+ << name << "'" );
+ }
+
+ } else {
+ double lon, lat, elev, hdg;
+ in >> lon >> lat >> elev >> hdg;
+
+ // Always OK to load
+ if ( token == "OBJECT_STATIC" ) {
+ /// Hmm, the findDataFile should happen downstream
+ std::string absName = osgDB::findDataFile(name,
+ staticOptions.get());
+ if(_modelLoader) {
+ node = _modelLoader->loadTileModel(absName, false);
+ } else {
+ osg::ref_ptr<SGReaderWriterOptions> opt;
+ opt = new SGReaderWriterOptions(*staticOptions);
+ if (SGPath(absName).lower_extension() == "ac")
+ opt->setInstantiateEffects(true);
+ else
+ opt->setInstantiateEffects(false);
+ node = osgDB::readRefNodeFile(absName, opt.get());
+ }
+
+ if (!node.valid()) {
+ SG_LOG( SG_TERRAIN, SG_ALERT, absoluteFileName
+ << ": Failed to load OBJECT_STATIC '"
+ << name << "'" );
+ }
+
+ } else if ( token == "OBJECT_SHARED" ) {
+ if(_modelLoader) {
+ node = _modelLoader->loadTileModel(name, true);
+ } else {
+ osg::ref_ptr<SGReaderWriterOptions> opt;
+ opt = new SGReaderWriterOptions(*sharedOptions);
+
+ /// Hmm, the findDataFile should happen in the downstream readers
+ std::string absName = osgDB::findDataFile(name, opt.get());
+
+ osg::ProxyNode* proxyNode = new osg::ProxyNode;
+ proxyNode->setLoadingExternalReferenceMode(osg::ProxyNode::DEFER_LOADING_TO_DATABASE_PAGER);
+ proxyNode->setFileName(0, absName);
+ if (SGPath(absName).lower_extension() == "ac")
+ opt->setInstantiateEffects(true);
+ else
+ opt->setInstantiateEffects(false);
+ proxyNode->setDatabaseOptions(opt.get());
+ node = proxyNode;
+ }
+
+ if (!node.valid()) {
+ SG_LOG( SG_TERRAIN, SG_ALERT, absoluteFileName
+ << ": Failed to load OBJECT_SHARED '"
+ << name << "'" );
+ }
+
+ } else if ( token == "OBJECT_SIGN" ) {
+ node = SGMakeSign(staticOptions->getMaterialLib(), name);
+
+ } else if ( token == "OBJECT_RUNWAY_SIGN" ) {
+ node = SGMakeRunwaySign(staticOptions->getMaterialLib(), name);
+
+ } else {
+ SG_LOG( SG_TERRAIN, SG_ALERT, absoluteFileName
+ << ": Unknown token '" << token << "'" );
+ }
+
+ if (node.valid() && token != "OBJECT") {
+ osg::Matrix matrix;
+ matrix = makeZUpFrame(SGGeod::fromDegM(lon, lat, elev));
+ matrix.preMultRotate(osg::Quat(SGMiscd::deg2rad(hdg),
+ osg::Vec3(0, 0, 1)));
+
+ osg::MatrixTransform* matrixTransform;
+ matrixTransform = new osg::MatrixTransform(matrix);
+ matrixTransform->setDataVariance(osg::Object::STATIC);
+ matrixTransform->addChild(node.get());
+ node = matrixTransform;
+ }
+ }
+
+ if (node.valid())
+ group.addChild(node.get());
+
+ in >> ::skipeol;
+ }
-double TileEntry::get_timestamp() const
-{
- if (_node.valid()) {
- return (dynamic_cast<TileCullCallback*>(_node->getCullCallback()))
- ->getTimeStamp();
- } else
- return DBL_MAX;
+ return has_base;
}
-
-void TileEntry::set_timestamp(double time_ms)
+
+void
+TileEntry::setModelLoadHelper(ModelLoadHelper *m)
{
- if (_node.valid()) {
- TileCullCallback* cb
- = dynamic_cast<TileCullCallback*>(_node->getCullCallback());
- if (cb)
- cb->setTimeStamp(time_ms);
- }
+ _modelLoader=m;
}
// Constructor
TileEntry::TileEntry ( const SGBucket& b )
: tile_bucket( b ),
+ tileFileName(b.gen_index_str()),
_node( new osg::LOD ),
- is_inner_ring(false),
- free_tracker(0),
- tileFileName(b.gen_index_str())
+ _priority(-FLT_MAX),
+ _current_view(false),
+ _time_expired(-1.0)
{
- _node->setUpdateCallback(new FGTileUpdateCallback);
- _node->setCullCallback(new TileCullCallback);
tileFileName += ".stg";
_node->setName(tileFileName);
// Give a default LOD range so that traversals that traverse
_node->setRange(0, 0.0, 10000.0);
}
-
-// Destructor
-TileEntry::~TileEntry ()
+TileEntry::TileEntry( const TileEntry& t )
+: tile_bucket( t.tile_bucket ),
+ tileFileName(t.tileFileName),
+ _node( new osg::LOD ),
+ _priority(t._priority),
+ _current_view(t._current_view),
+ _time_expired(t._time_expired)
{
+ _node->setName(tileFileName);
+ // Give a default LOD range so that traversals that traverse
+ // active children (like the groundcache lookup) will work before
+ // tile manager has had a chance to update this node.
+ _node->setRange(0, 0.0, 10000.0);
}
-static void WorldCoordinate(osg::Matrix& obj_pos, double lat,
- double lon, double elev, double hdg)
+// Destructor
+TileEntry::~TileEntry ()
{
- SGGeod geod = SGGeod::fromDegM(lon, lat, elev);
- obj_pos = geod.makeZUpFrame();
- // hdg is not a compass heading, but a counter-clockwise rotation
- // around the Z axis
- obj_pos.preMult(osg::Matrix::rotate(hdg * SGD_DEGREES_TO_RADIANS,
- 0.0, 0.0, 1.0));
-}
-
-
-// Free "n" leaf elements of an ssg tree. returns the number of
-// elements freed. An empty branch node is considered a leaf. This
-// is intended to spread the load of freeing a complex tile out over
-// several frames.
-static int fgPartialFreeSSGtree( osg::Group *b, int n ) {
- int num_deletes = b->getNumChildren();
-
- b->removeChildren(0, b->getNumChildren());
-
- return num_deletes;
}
-
-// Clean up the memory used by this tile and delete the arrays used by
-// ssg as well as the whole ssg branch
-bool TileEntry::free_tile() {
- int delete_size = 100;
- SG_LOG( SG_TERRAIN, SG_DEBUG,
- "FREEING TILE = (" << tile_bucket << ")" );
-
- SG_LOG( SG_TERRAIN, SG_DEBUG, "(start) free_tracker = " << free_tracker );
-
- if ( !(free_tracker & NODES) ) {
- free_tracker |= NODES;
- } else if ( !(free_tracker & VEC_PTRS) ) {
- free_tracker |= VEC_PTRS;
- } else if ( !(free_tracker & TERRA_NODE) ) {
- // delete the terrain branch (this should already have been
- // disconnected from the scene graph)
- SG_LOG( SG_TERRAIN, SG_DEBUG, "FREEING terra_transform" );
- if ( fgPartialFreeSSGtree( _node.get(), delete_size ) == 0 ) {
- _node = 0;
- free_tracker |= TERRA_NODE;
- }
- } else if ( !(free_tracker & LIGHTMAPS) ) {
- free_tracker |= LIGHTMAPS;
- } else {
- return true;
- }
-
- SG_LOG( SG_TERRAIN, SG_DEBUG, "(end) free_tracker = " << free_tracker );
-
- // if we fall down to here, we still have work todo, return false
- return false;
-}
-
-
// Update the ssg transform node for this tile so it can be
// properly drawn relative to our (0,0,0) point
void TileEntry::prep_ssg_node(float vis) {
_node->setRange( 0, 0, vis + bounding_radius );
}
-bool TileEntry::obj_load( const string& path,
- osg::Group *geometry, bool is_base, const osgDB::ReaderWriter::Options*options)
-{
- osg::Node* node = osgDB::readNodeFile(path, options);
- if (node)
- geometry->addChild(node);
-
- return node != 0;
-}
-
-
-typedef enum {
- OBJECT,
- OBJECT_SHARED,
- OBJECT_STATIC,
- OBJECT_SIGN,
- OBJECT_RUNWAY_SIGN
-} object_type;
-
-
-// storage class for deferred object processing in TileEntry::load()
-struct Object {
- Object(object_type t, const string& token, const SGPath& p, istream& in)
- : type(t), path(p)
- {
- in >> name;
- if (type != OBJECT)
- in >> lon >> lat >> elev >> hdg;
- in >> ::skipeol;
-
- if (type == OBJECT)
- SG_LOG(SG_TERRAIN, SG_INFO, " " << token << " " << name);
- else
- SG_LOG(SG_TERRAIN, SG_INFO, " " << token << " " << name << " lon=" <<
- lon << " lat=" << lat << " elev=" << elev << " hdg=" << hdg);
- }
- object_type type;
- string name;
- SGPath path;
- double lon, lat, elev, hdg;
-};
-
-// Work in progress... load the tile based entirely by name cuz that's
-// what we'll want to do with the database pager.
-
osg::Node*
-TileEntry::loadTileByName(const string& index_str,
- const osgDB::ReaderWriter::Options* options)
+TileEntry::loadTileByFileName(const string& fileName,
+ const osgDB::Options* options)
{
- long tileIndex;
- {
- std::istringstream idxStream(index_str);
- idxStream >> tileIndex;
+ SG_LOG(SG_TERRAIN, SG_INFO, "Loading tile " << fileName);
+
+ // We treat 123.stg different than ./123.stg.
+ // The difference is that ./123.stg as well as any absolute path
+ // really loads the given stg file and only this.
+ // In contrast 123.stg uses the search paths to load a set of stg
+ // files spread across the scenery directories.
+ std::string simpleFileName = osgDB::getSimpleFileName(fileName);
+ SGBucket bucket = getBucketFromFileName(simpleFileName);
+ osg::ref_ptr<osg::Group> group = new osg::Group;
+ if (simpleFileName != fileName || !options) {
+ // This is considered a real existing file.
+ // We still apply the search path algorithms for relative files.
+ loadStgFile(osgDB::findDataFile(fileName, options), *group, options);
+ return group.release();
}
- SGBucket tile_bucket(tileIndex);
- const string basePath = tile_bucket.gen_base_path();
-
- bool found_tile_base = false;
-
- SGPath object_base;
- vector<const Object*> objects;
-
- SG_LOG( SG_TERRAIN, SG_INFO, "Loading tile " << index_str );
-
- osgDB::FilePathList path_list=options->getDatabasePathList();
-
- // scan and parse all files and store information
- for (unsigned int i = 0; i < path_list.size(); i++) {
- // If we found a terrain tile in Terrain/, we have to process the
- // Objects/ dir in the same group, too, before we can stop scanning.
- // FGGlobals::set_fg_scenery() inserts an empty string to path_list
- // as marker.
- if (path_list[i].empty()) {
- if (found_tile_base)
- break;
- else
- continue;
- }
-
- bool has_base = false;
-
- SGPath tile_path = path_list[i];
- tile_path.append(basePath);
-
- SGPath basename = tile_path;
- basename.append( index_str );
-
- SG_LOG( SG_TERRAIN, SG_INFO, " Trying " << basename.str() );
-
-
- // Check for master .stg (scene terra gear) file
- SGPath stg_name = basename;
- stg_name.concat( ".stg" );
-
- sg_gzifstream in( stg_name.str() );
- if ( !in.is_open() )
- continue;
-
- while ( ! in.eof() ) {
- string token;
- in >> token;
-
- if ( token.empty() || token[0] == '#' ) {
- in >> ::skipeol;
- continue;
- }
- // Load only once (first found)
- if ( token == "OBJECT_BASE" ) {
- string name;
- in >> name >> ::skipws;
- SG_LOG( SG_TERRAIN, SG_INFO, " " << token << " " << name );
-
- if (!found_tile_base) {
- found_tile_base = true;
- has_base = true;
-
- object_base = tile_path;
- object_base.append(name);
-
- } else
- SG_LOG(SG_TERRAIN, SG_INFO, " (skipped)");
-
- // Load only if base is not in another file
- } else if ( token == "OBJECT" ) {
- if (!found_tile_base || has_base)
- objects.push_back(new Object(OBJECT, token, tile_path, in));
- else {
- string name;
- in >> name >> ::skipeol;
- SG_LOG(SG_TERRAIN, SG_INFO, " " << token << " "
- << name << " (skipped)");
- }
-
- // Always OK to load
- } else if ( token == "OBJECT_STATIC" ) {
- objects.push_back(new Object(OBJECT_STATIC, token, tile_path, in));
-
- } else if ( token == "OBJECT_SHARED" ) {
- objects.push_back(new Object(OBJECT_SHARED, token, tile_path, in));
-
- } else if ( token == "OBJECT_SIGN" ) {
- objects.push_back(new Object(OBJECT_SIGN, token, tile_path, in));
-
- } else if ( token == "OBJECT_RUNWAY_SIGN" ) {
- objects.push_back(new Object(OBJECT_RUNWAY_SIGN, token, tile_path, in));
-
- } else {
- SG_LOG( SG_TERRAIN, SG_DEBUG,
- "Unknown token '" << token << "' in " << stg_name.str() );
- in >> ::skipws;
- }
- }
+ // This is considered a meta file, so apply the scenery path search
+ const osgDB::FilePathList& filePathList = options->getDatabasePathList();
+ std::string basePath = bucket.gen_base_path();
+ // Stop scanning once an object base is found
+ bool foundBase = false;
+ for (osgDB::FilePathList::const_iterator i = filePathList.begin();
+ i != filePathList.end() && !foundBase; ++i) {
+ SGPath objects(*i);
+ objects.append("Objects");
+ objects.append(basePath);
+ objects.append(simpleFileName);
+ if (loadStgFile(objects.str(), *group, options))
+ foundBase = true;
+
+ SGPath terrain(*i);
+ terrain.append("Terrain");
+ terrain.append(basePath);
+ terrain.append(simpleFileName);
+ if (loadStgFile(terrain.str(), *group, options))
+ foundBase = true;
}
-
- SGReaderWriterBTGOptions *opt = new SGReaderWriterBTGOptions(*dynamic_cast<const SGReaderWriterBTGOptions *>(options));
-
- // obj_load() will generate ground lighting for us ...
- osg::Group* new_tile = new osg::Group;
-
- if (found_tile_base) {
- // load tile if found ...
- opt->setCalcLights(true);
- obj_load( object_base.str(), new_tile, true, options);
-
- } else {
- // ... or generate an ocean tile on the fly
+
+ // ... or generate an ocean tile on the fly
+ if (!foundBase) {
SG_LOG(SG_TERRAIN, SG_INFO, " Generating ocean tile");
- if ( !SGGenTile( path_list[0], tile_bucket,
- opt->getMatlib(), new_tile ) ) {
+
+ osg::ref_ptr<SGReaderWriterOptions> opt;
+ opt = SGReaderWriterOptions::copyOrCreate(options);
+ osg::Node* node = SGOceanTile(bucket, opt->getMaterialLib());
+ if ( node ) {
+ group->addChild(node);
+ } else {
SG_LOG( SG_TERRAIN, SG_ALERT,
"Warning: failed to generate ocean tile!" );
}
}
-
-
- // now that we have a valid center, process all the objects
- for (unsigned int j = 0; j < objects.size(); j++) {
- const Object *obj = objects[j];
-
- if (obj->type == OBJECT) {
- SGPath custom_path = obj->path;
- custom_path.append( obj->name );
- opt->setCalcLights(true);
- obj_load( custom_path.str(), new_tile, false, options);
-
- } else if (obj->type == OBJECT_SHARED || obj->type == OBJECT_STATIC) {
- // object loading is deferred to main render thread,
- // but lets figure out the paths right now.
- SGPath custom_path;
- if ( obj->type == OBJECT_STATIC ) {
- custom_path = obj->path;
- } else {
- // custom_path = globals->get_fg_root();
- }
- custom_path.append( obj->name );
-
- osg::Matrix obj_pos;
- WorldCoordinate( obj_pos, obj->lat, obj->lon, obj->elev, obj->hdg );
-
- osg::MatrixTransform *obj_trans = new osg::MatrixTransform;
- obj_trans->setMatrix( obj_pos );
-
- // wire as much of the scene graph together as we can
- new_tile->addChild( obj_trans );
-
- osg::Node* model = 0;
- if(_modelLoader)
- model = _modelLoader->loadTileModel(custom_path.str(),
- obj->type == OBJECT_SHARED);
- if (model)
- obj_trans->addChild(model);
- } else if (obj->type == OBJECT_SIGN || obj->type == OBJECT_RUNWAY_SIGN) {
- // load the object itself
- SGPath custom_path = obj->path;
- custom_path.append( obj->name );
-
- osg::Matrix obj_pos;
- WorldCoordinate( obj_pos, obj->lat, obj->lon, obj->elev, obj->hdg );
-
- osg::MatrixTransform *obj_trans = new osg::MatrixTransform;
- obj_trans->setMatrix( obj_pos );
-
- osg::Node *custom_obj = 0;
- if (obj->type == OBJECT_SIGN)
- custom_obj = SGMakeSign(opt->getMatlib(), custom_path.str(), obj->name);
- else
- custom_obj = SGMakeRunwaySign(opt->getMatlib(), custom_path.str(), obj->name);
-
- // wire the pieces together
- if ( custom_obj != NULL ) {
- obj_trans -> addChild( custom_obj );
- }
- new_tile->addChild( obj_trans );
-
- }
- delete obj;
- }
- return new_tile;
+ return group.release();
}
void
}
}
+void
+TileEntry::refresh()
+{
+ osg::Group *parent = NULL;
+ // find the nodes branch parent
+ if ( _node->getNumParents() > 0 ) {
+ // find the first parent (should only be one)
+ parent = _node->getParent( 0 ) ;
+ if( parent ) {
+ parent->removeChild( _node.get() );
+ }
+ }
+ _node = new osg::LOD;
+ if (parent)
+ parent->addChild(_node.get());
+}