osg::SceneFileHandler Class Reference

Brief OSGSceneFileHandler.

#include <OSGSceneFileHandler.h>

List of all members.

Progress
void	setReadProgressCB (progresscbfp fp)
progresscbfp	getReadProgressCB (void)
*typedef void(*	progresscbfp )(UInt32 p)
Member
FileTypeMap	_suffixTypeMap
static bool	addSceneFileType (SceneFileType &fileType)
static bool	subSceneFileType (SceneFileType &fileType)
*static SceneFileHandler *	_the = NULL
Public Types
typedef std::vector< FieldContainerPtr >	FCPtrStore
Public Member Functions
Destructors
*virtual	~SceneFileHandler (void)
Get
*virtual SceneFileType *	getFileType (const Char8 *fileNameOrExtension)
virtual int	getSuffixList (std::list< const Char8 * > &suffixList, UInt32 flags=SceneFileType::OSG_READ_SUPPORTED|SceneFileType::OSG_WRITE_SUPPORTED)
Read
*virtual NodePtr	read (std::istream &is, const Char8 *ext, GraphOpSeq *graphOpSeq=_defaultgraphOpSeq)
virtual FCPtrStore	readTopNodes (std::istream &is, const Char8 *ext, GraphOpSeq *graphOpSeq=_defaultgraphOpSeq)
virtual NodePtr	read (const Char8 *fileName, GraphOpSeq *graphOpSeq=_defaultgraphOpSeq)
virtual FCPtrStore	readTopNodes (const Char8 *fileName, GraphOpSeq *graphOpSeq=_defaultgraphOpSeq)
Write
*virtual bool	write (const NodePtr &node, std::ostream &os, const Char8 *ext, bool compress=false)
virtual bool	write (const NodePtr &node, const Char8 *fileName, bool compress=false)
PathHandler
*virtual PathHandler *	getPathHandler (void)
virtual void	setPathHandler (PathHandler *pathHandler)
DefaultGraphOp
*virtual GraphOpSeq *	getDefaultGraphOp (void)
virtual void	setDefaultGraphOp (GraphOpSeq *graphOpSeq)
Options
*virtual bool	setOptions (const Char8 *suffix, const Char8 *options)
virtual const Char8 *	getOptions (const Char8 *suffix)
Debug
*void	print (void)
Static Public Member Functions
Class Get
*static SceneFileHandler &	the (void)
Protected Types
typedef std::list< SceneFileType * >	FileTypeList
typedef std::map< IDString, FileTypeList * >	FileTypeMap
Protected Member Functions
Constructors
*	SceneFileHandler (void)
	SceneFileHandler (const SceneFileHandler &obj)
Private Member Functions
std::string	initPathHandler (const Char8 *fileName)
void	operator= (const SceneFileHandler &source)
	prohibit default function (move to 'public' if needed)
void	startReadProgressThread (std::istream &is)
void	stopReadProgressThread (void)
Static Private Member Functions
static void	readProgress (void *data)
Private Attributes
progresscbfp	_readProgressFP
progressS	_progressData
bool	_readReady
PathHandler *	_pathHandler
PathHandler	_defaultPathHandler
Static Private Attributes
static GraphOpSeq *	_defaultgraphOpSeq = NULL
Friends
class	SceneFileType
Classes
struct	FindOverride
struct	progressS

---

Detailed Description

Definition at line 63 of file OSGSceneFileHandler.h.

---

Member Typedef Documentation

typedef std::vector<FieldContainerPtr> osg::SceneFileHandler::FCPtrStore

Definition at line 68 of file OSGSceneFileHandler.h.

typedef std::list< SceneFileType *> osg::SceneFileHandler::FileTypeList [protected]

Definition at line 163 of file OSGSceneFileHandler.h.

typedef std::map<IDString, FileTypeList *> osg::SceneFileHandler::FileTypeMap [protected]

Definition at line 164 of file OSGSceneFileHandler.h.

---

Constructor & Destructor Documentation

SceneFileHandler::~SceneFileHandler (  void   )  [virtual]

Definition at line 972 of file OSGSceneFileHandler.cpp. { }

SceneFileHandler::SceneFileHandler (  void   )  [protected]

constructors & destructors Definition at line 826 of file OSGSceneFileHandler.cpp. References _defaultgraphOpSeq, and osg::GraphOpSeq::addGraphOp(). : _readProgressFP(NULL), _progressData(), _readReady(false), _pathHandler(NULL), _defaultPathHandler() { if(_defaultgraphOpSeq == NULL) { _defaultgraphOpSeq = new GraphOpSeq; // Add default striper. _defaultgraphOpSeq->addGraphOp(new StripeGraphOp); } return; }

SceneFileHandler::SceneFileHandler (  const SceneFileHandler &  obj  )  [protected]

constructors & destructors Definition at line 863 of file OSGSceneFileHandler.cpp. References SWARNING. { SWARNING << "In copy constructor; I shouldn't be in this corner" << std::endl; }

---

Member Function Documentation

SceneFileHandler & SceneFileHandler::the (  void   )  [static]

Definition at line 889 of file OSGSceneFileHandler.cpp. References _the. Referenced by addSceneFileType(), osg::ProxyGroup::changed(), osg::VRMLInlineDesc::endNode(), osg::ProxyGroup::loadProc(), osg::Image::read(), osg::OBJSceneFileType::readMTL(), readProgress(), osg::ProxyGroup::startLoading(), and subSceneFileType(). { if(_the == NULL) { _the = new SceneFileHandler; } return *_the; }

SceneFileType * SceneFileHandler::getFileType (  const Char8 *  fileNameOrExtension  )  [virtual]

Definition at line 130 of file OSGSceneFileHandler.cpp. References _suffixTypeMap, p, osg::IDString::set(), and osg::IDString::toLower(). Referenced by getOptions(), read(), setOptions(), and write(). { const Char8 separator = '.'; if(fileNameOrExtension == NULL) return NULL; std::string fe = fileNameOrExtension; Int32 p = fe.rfind(separator); std::string ext; if(p != -1) ext = fe.substr(p+1, fe.length() - p - 1); else ext = fe; // extension without '.' // skip .gz extension if(ext == "gz") { fe = fe.substr(0, p); p = fe.rfind(separator); if(p != -1) ext = fe.substr(p+1, fe.length() - p - 1); else ext = fe; } IDString suffix; suffix.set(ext.c_str()); suffix.toLower(); FileTypeMap::iterator sI = _suffixTypeMap.find(suffix); SceneFileType *type = (sI == _suffixTypeMap.end()) ? 0 : sI->second->front(); return type; }

Int32 SceneFileHandler::getSuffixList (  std::list< const Char8 * > &  suffixList, UInt32  flags = SceneFileType::OSG_READ_SUPPORTED|SceneFileType::OSG_WRITE_SUPPORTED )  [virtual]

Definition at line 174 of file OSGSceneFileHandler.cpp. References _suffixTypeMap, and osg::SceneFileType::getFlags(). { Int32 count = 0; FileTypeMap::iterator sI; suffixList.clear(); for ( sI = _suffixTypeMap.begin(); sI != _suffixTypeMap.end(); ++sI) { SceneFileType *type = sI->second->front(); if((type->getFlags() & flags) == flags) { suffixList.push_back(sI->first.str()); count++; } } return count; }

void SceneFileHandler::setReadProgressCB (  progresscbfp  fp  )

Definition at line 899 of file OSGSceneFileHandler.cpp. References _readProgressFP, and stopReadProgressThread(). { stopReadProgressThread(); _readProgressFP = fp; }

SceneFileHandler::progresscbfp SceneFileHandler::getReadProgressCB (  void   )

Definition at line 905 of file OSGSceneFileHandler.cpp. References _readProgressFP. { return _readProgressFP; }

NodePtr SceneFileHandler::read (  std::istream &  is, const Char8 *  ext, GraphOpSeq *  graphOpSeq = _defaultgraphOpSeq )  [virtual]

Definition at line 200 of file OSGSceneFileHandler.cpp. References getFileType(), osg::SceneFileType::getName(), osg::isGZip(), osg::NullFC, osg::SceneFileType::read(), osg::GraphOpSeq::run(), SFATAL, SINFO, startReadProgressThread(), stopReadProgressThread(), and SWARNING. Referenced by osg::ProxyGroup::loadProc(), read(), readTopNodes(), and osg::ProxyGroup::startLoading(). { SceneFileType *type = getFileType(fileNameOrExtension); NodePtr scene = NullFC; if(!fileNameOrExtension) { SWARNING << "cannot read NULL extension" << std::endl; return NullFC; } if (type) { SINFO << "try to read stream as " << type->getName() << std::endl; if(isGZip(is)) { SINFO << "Detected gzip compressed stream." << std::endl; #ifdef OSG_ZSTREAM_SUPPORTED startReadProgressThread(is); zip_istream unzipper(is); scene = type->read(unzipper, fileNameOrExtension); if(scene != NullFC) { if(unzipper.check_crc()) SINFO << "Compressed stream has correct checksum." << std::endl; else SFATAL << "Compressed stream has wrong checksum." << std::endl; } stopReadProgressThread(); #else SFATAL << "Compressed streams are not supported! Configure with --enable-png --with-png=DIR options." << std::endl; #endif } else { startReadProgressThread(is); scene = type->read(is, fileNameOrExtension); stopReadProgressThread(); } if(scene != NullFC) { if(graphOpSeq != NULL) graphOpSeq->run(scene); SINFO << "read ok:" << std::endl; } else { SWARNING << "could not read " << std::endl; } } else { SWARNING << "could not read unknown file format" << std::endl; } return scene; }

SceneFileHandler::FCPtrStore SceneFileHandler::readTopNodes (  std::istream &  is, const Char8 *  ext, GraphOpSeq *  graphOpSeq = _defaultgraphOpSeq )  [virtual]

Definition at line 264 of file OSGSceneFileHandler.cpp. References osg::Node::create(), osg::NodePtr::getCore(), osg::NullFC, read(), and osg::GraphOpSeq::run(). Referenced by readTopNodes(). { std::vector<FieldContainerPtr> nodeVec; NodePtr scene = read(is, fileNameOrExtension); if(scene == NullFC) return nodeVec; while(scene->getNChildren() > 0) { NodePtr child = scene->getChild(0); NodePtr newChild = Node::create(); while(child->getNChildren() > 0) newChild->addChild(child->getChild(0)); newChild->setCore(child->getCore()); if(graphOpSeq != NULL) graphOpSeq->run(newChild); nodeVec.push_back(newChild); scene->subChild(child); } return nodeVec; }

NodePtr SceneFileHandler::read (  const Char8 *  fileName, GraphOpSeq *  graphOpSeq = _defaultgraphOpSeq )  [virtual]

Definition at line 289 of file OSGSceneFileHandler.cpp. References getFileType(), osg::SceneFileType::getName(), initPathHandler(), osg::NullFC, read(), osg::SceneFileType::readFile(), osg::GraphOpSeq::run(), SINFO, and SWARNING. { if(!fileName) { SWARNING << "cannot read NULL file" << std::endl; return NullFC; } std::string fullFilePath = initPathHandler(fileName); if(fullFilePath.empty()) { SWARNING << "Couldn't open file " << fileName << std::endl; return NullFC; } SceneFileType *type = getFileType(fullFilePath.c_str()); NodePtr scene = NullFC; if (type) { SINFO << "try to read " << fullFilePath << " as " << type->getName() << std::endl; std::ifstream in(fullFilePath.c_str(), std::ios::binary); if(in) { scene = read(in, fullFilePath.c_str(), graphOpSeq); in.close(); if(scene != NullFC) return scene; } else { SWARNING << "Couldn't open input stream for file " << fullFilePath << std::endl; } #ifndef OSG_DISABLE_DEPRECATED // Ok stream interface didn't work try via filename if(scene == NullFC) scene = type->readFile(fullFilePath.c_str()); if (scene != NullFC) { if(graphOpSeq != NULL) graphOpSeq->run(scene); SINFO << "read ok:" << std::endl; } else { SWARNING << "could not read " << std::endl; } #endif } else { SWARNING << "could not read " << fullFilePath << "; unknown file format" << std::endl; } return scene; }

SceneFileHandler::FCPtrStore SceneFileHandler::readTopNodes (  const Char8 *  fileName, GraphOpSeq *  graphOpSeq = _defaultgraphOpSeq )  [virtual]

Definition at line 355 of file OSGSceneFileHandler.cpp. References osg::Node::create(), osg::NodePtr::getCore(), initPathHandler(), osg::NullFC, read(), readTopNodes(), osg::GraphOpSeq::run(), and SWARNING. { std::vector<FieldContainerPtr> nodeVec; if(!fileName) { SWARNING << "cannot read NULL file" << std::endl; return nodeVec; } std::string fullFilePath = initPathHandler(fileName); if(fullFilePath.empty()) { SWARNING << "Couldn't open file " << fileName << std::endl; return nodeVec; } std::ifstream in(fullFilePath.c_str(), std::ios::binary); if(in) { nodeVec = readTopNodes(in, fullFilePath.c_str(), graphOpSeq); in.close(); } else { SWARNING << "Couldn't open input stream for file " << fullFilePath << std::endl; } // Ok stream interface didn't work try via filename if(nodeVec.empty()) { NodePtr scene = read(fullFilePath.c_str()); if(scene == NullFC) return nodeVec; while(scene->getNChildren() > 0) { NodePtr child = scene->getChild(0); NodePtr newChild = Node::create(); while(child->getNChildren() > 0) newChild->addChild(child->getChild(0)); newChild->setCore(child->getCore()); if(graphOpSeq != NULL) graphOpSeq->run(newChild); nodeVec.push_back(newChild); scene->subChild(child); } } return nodeVec; }

bool SceneFileHandler::write (  const NodePtr &  node, std::ostream &  os, const Char8 *  ext, bool  compress = false )  [virtual]

Definition at line 430 of file OSGSceneFileHandler.cpp. References getFileType(), osg::SceneFileType::getName(), SFATAL, SINFO, SWARNING, and osg::SceneFileType::write(). Referenced by write(). { bool retCode = false; SceneFileType *type = getFileType(fileNameOrExtension); if(type) { SINFO << "try to write stream as " << type->getName() << std::endl; if(compress) { #ifdef OSG_ZSTREAM_SUPPORTED SINFO << "writing compressed stream." << std::endl; zip_ostream zipper(os, true); retCode = type->write(node, zipper, fileNameOrExtension); zipper.zflush(); #else SFATAL << "Compressed streams are not supported! Configure with --enable-png --with-png=DIR options." << std::endl; #endif } else { retCode = type->write(node, os, fileNameOrExtension); } } else SWARNING << "can't write stream unknown scene format" << std::endl; return retCode; }

bool SceneFileHandler::write (  const NodePtr &  node, const Char8 *  fileName, bool  compress = false )  [virtual]

Definition at line 481 of file OSGSceneFileHandler.cpp. References getFileType(), osg::SceneFileType::getName(), SINFO, SWARNING, write(), and osg::SceneFileType::writeFile(). { bool retCode = false; SceneFileType *type = getFileType(fileName); if (type) { SINFO << "try to write " << fileName << " as " << type->getName() << std::endl; std::ofstream out(fileName, std::ios::binary); if(out) { retCode = write(node, out, fileName, compress); out.close(); } else { SWARNING << "Can not open output stream for file '" << fileName << "'!" << std::endl; } #ifndef OSG_DISABLE_DEPRECATED if(!retCode) retCode = type->writeFile(node, fileName); #endif if(!retCode) SWARNING << "Couldn't write " << fileName << std::endl; } else SWARNING << "can't write " << fileName << "; unknown scene format" << std::endl; return retCode; }

PathHandler * SceneFileHandler::getPathHandler (  void   )  [virtual]

Returns the path handler used Definition at line 519 of file OSGSceneFileHandler.cpp. References _defaultPathHandler, and _pathHandler. Referenced by osg::ProxyGroup::changed(), osg::VRMLInlineDesc::endNode(), osg::Image::read(), and osg::OBJSceneFileType::readMTL(). { if(_pathHandler == NULL) return &_defaultPathHandler; else return _pathHandler; }

void SceneFileHandler::setPathHandler (  PathHandler *  pathHandler  )  [virtual]

Method to set the path handler. Definition at line 531 of file OSGSceneFileHandler.cpp. References _pathHandler. { _pathHandler = pathHandler; }

GraphOpSeq * SceneFileHandler::getDefaultGraphOp (  void   )  [virtual]

Definition at line 565 of file OSGSceneFileHandler.cpp. References _defaultgraphOpSeq. { return _defaultgraphOpSeq; }

void SceneFileHandler::setDefaultGraphOp (  GraphOpSeq *  graphOpSeq  )  [virtual]

Definition at line 570 of file OSGSceneFileHandler.cpp. References _defaultgraphOpSeq. { _defaultgraphOpSeq = graphOpSeq; }

bool SceneFileHandler::setOptions (  const Char8 *  suffix, const Char8 *  options )  [virtual]

Definition at line 576 of file OSGSceneFileHandler.cpp. References getFileType(), and osg::SceneFileType::setOptions(). { if(suffix == NULL) return false; SceneFileType *type = getFileType(suffix); if(type == NULL) return false; type->setOptions(options); return true; }

const Char8 * SceneFileHandler::getOptions (  const Char8 *  suffix  )  [virtual]

Definition at line 590 of file OSGSceneFileHandler.cpp. References getFileType(), and osg::SceneFileType::getOptions(). { if(suffix == NULL) return NULL; SceneFileType *type = getFileType(suffix); if(type == NULL) return NULL; return type->getOptions(); }

void SceneFileHandler::print (  void   )

Definition at line 623 of file OSGSceneFileHandler.cpp. References _suffixTypeMap, osg::SceneFileType::getFlags(), osg::SceneFileType::OSG_READ_SUPPORTED, and osg::SceneFileType::OSG_WRITE_SUPPORTED. { FileTypeMap::iterator sI; for(sI = _suffixTypeMap.begin(); sI != _suffixTypeMap.end(); sI++) { std::string rw; SceneFileType *type = sI->second->front(); if((type->getFlags() & SceneFileType::OSG_READ_SUPPORTED) && (type->getFlags() & SceneFileType::OSG_WRITE_SUPPORTED)) { rw = "reader and writer"; } else { if(type->getFlags() & SceneFileType::OSG_READ_SUPPORTED) rw = "reader"; if(type->getFlags() & SceneFileType::OSG_WRITE_SUPPORTED) rw = "writer"; } std::cerr << "suffix: " << sI->first.str() << ", type: " << sI->second->front()->getName() << " " << rw << std::endl; } }

bool SceneFileHandler::addSceneFileType (  SceneFileType &  fileType  )  [static, protected]

Definition at line 700 of file OSGSceneFileHandler.cpp. References _suffixTypeMap, osg::SceneFileType::doOverride(), osg::SceneFileType::getOverridePriority(), osg::IDString::set(), osg::SceneFileType::suffixList(), SWARNING, the(), osg::IDString::toLower(), and osg::SceneFileHandler::FindOverride::uiRefPriority. Referenced by osg::SceneFileType::SceneFileType(). { bool retCode = false; std::list<IDString>::iterator sI; FileTypeMap ::iterator smI; IDString suffix; for( sI = fileType.suffixList().begin(); sI != fileType.suffixList().end(); ++sI) { suffix.set(sI->str()); suffix.toLower(); smI = the()._suffixTypeMap.find(suffix); if (smI != the()._suffixTypeMap.end()) { if(fileType.doOverride() == true) { FindOverride overrideFinder; FileTypeList::iterator lIt; overrideFinder.uiRefPriority = fileType.getOverridePriority(); lIt = std::find_if(the()._suffixTypeMap[suffix]->begin(), the()._suffixTypeMap[suffix]->end(), overrideFinder); the()._suffixTypeMap[suffix]->insert(lIt, &fileType); SWARNING << "Added an file type with suffix " << suffix << " overriding " << std::endl; } else { the()._suffixTypeMap[suffix]->push_back(&fileType); SWARNING << "Added an file type with suffix " << suffix << " non overriding at the end of the list" << std::endl; } } else { FileTypeList *pTmpList = new FileTypeList; pTmpList->push_back(&fileType); the()._suffixTypeMap[suffix] = pTmpList; retCode = true; } } return retCode; }

bool SceneFileHandler::subSceneFileType (  SceneFileType &  fileType  )  [static, protected]

Definition at line 763 of file OSGSceneFileHandler.cpp. References _suffixTypeMap, osg::IDString::set(), osg::SceneFileType::suffixList(), the(), and osg::IDString::toLower(). Referenced by osg::SceneFileType::~SceneFileType(). { bool retCode = false; std::list<IDString>::iterator sI; FileTypeMap ::iterator smI; IDString suffix; for( sI = fileType.suffixList().begin(); sI != fileType.suffixList().end(); ++sI) { suffix.set(sI->str()); suffix.toLower(); smI = the()._suffixTypeMap.find(suffix); if (smI != the()._suffixTypeMap.end()) { the()._suffixTypeMap.erase(smI); retCode = true; } } return retCode; }

std::string SceneFileHandler::initPathHandler (  const Char8 *  fileName  )  [private]

Method to initialize the path handler. Definition at line 539 of file OSGSceneFileHandler.cpp. References _defaultPathHandler, _pathHandler, osg::PathHandler::clearPathList(), osg::PathHandler::findFile(), osg::ImageFileHandler::getPathHandler(), osg::PathHandler::push_frontCurrentDir(), osg::PathHandler::setBaseFile(), osg::ImageFileHandler::setPathHandler(), and osg::ImageFileHandler::the(). Referenced by read(), and readTopNodes(). { std::string fullFilePath; if(_pathHandler != NULL) { // Set also a image path handler if not set. if(ImageFileHandler::the().getPathHandler() == NULL) ImageFileHandler::the().setPathHandler(_pathHandler); fullFilePath = _pathHandler->findFile(fileName); } else { // Set a default image path handler if not set. if(ImageFileHandler::the().getPathHandler() == NULL) ImageFileHandler::the().setPathHandler(&_defaultPathHandler); _defaultPathHandler.clearPathList(); _defaultPathHandler.push_frontCurrentDir(); _defaultPathHandler.setBaseFile(fileName); fullFilePath = _defaultPathHandler.findFile(fileName); } return fullFilePath; }

void osg::SceneFileHandler::operator= (  const SceneFileHandler &  source  )  [private]

void SceneFileHandler::startReadProgressThread (  std::istream &  is  )  [private]

Definition at line 910 of file OSGSceneFileHandler.cpp. References _progressData, _readProgressFP, _readReady, osg::Thread::find(), osg::SceneFileHandler::progressS::is, osg::SceneFileHandler::progressS::length, readProgress(), osg::PThreadBase::runFunction(), and SWARNING. Referenced by read(). { if(_readProgressFP == NULL) return; // get length of the stream. _progressData.is = &is; is.seekg(0, std::ios::end); _progressData.length = is.tellg(); is.seekg(0, std::ios::beg); Thread *pt = Thread::find("osg::FileIOReadProgressThread"); if(pt == NULL) pt = OSG::Thread::get("osg::FileIOReadProgressThread"); _readReady = false; if(pt != NULL) pt->runFunction(readProgress, 0, NULL); else SWARNING << "Couldn't create read progress thread!" << std::endl; }

void SceneFileHandler::stopReadProgressThread (  void   )  [private]

Definition at line 932 of file OSGSceneFileHandler.cpp. References _readProgressFP, _readReady, osg::Thread::find(), and osg::BaseThread::join(). Referenced by read(), and setReadProgressCB(). { if(_readProgressFP == NULL) return; Thread *pt = Thread::find("osg::FileIOReadProgressThread"); if(pt != NULL) { // terminate thread _readReady = true; Thread::join(pt); } }

void SceneFileHandler::readProgress (  void *  data  )  [static, private]

Definition at line 947 of file OSGSceneFileHandler.cpp. References _progressData, _readProgressFP, _readReady, osg::SceneFileHandler::progressS::is, osg::SceneFileHandler::progressS::length, osg::osgsleep(), p, and the(). Referenced by startReadProgressThread(). { UInt32 p = 0; while(p < 100 && !the()._readReady) { if(!the()._progressData.is->eof() && !the()._progressData.is->bad()) { UInt64 pos = the()._progressData.is->tellg(); p = UInt32((pos * 100) / the()._progressData.length); if(p > 100) p = 100; } else { p = 100; }