osg::SceneFileHandler Class Reference

Brief OSGSceneFileHandler.

#include <OSGSceneFileHandler.h>

List of all members.

Progress
typedef void(*	progresscbfp )(UInt32 p)
typedef void(*	filenamecbfp )(const Char8 *fname)
void	setReadProgressCB (progresscbfp fp, bool use_thread=true)
progresscbfp	getReadProgressCB (void)
void	setReadBeginCB (filenamecbfp fp)
filenamecbfp	getReadBeginCB (void)
void	setReadEndCB (filenamecbfp fp)
filenamecbfp	getReadEndCB (void)
void	updateReadProgress (void)
void	updateReadProgress (UInt32 p)
void	triggerReadBegin (const Char8 *fname)
void	triggerReadEnd (const Char8 *fname)
void	setWriteProgressCB (progresscbfp fp)
progresscbfp	getWriteProgressCB (void)
void	setWriteBeginCB (filenamecbfp fp)
filenamecbfp	getWriteBeginCB (void)
void	setWriteEndCB (filenamecbfp fp)
filenamecbfp	getWriteEndCB (void)
void	updateWriteProgress (UInt32 p)
void	triggerWriteBegin (const Char8 *fname)
void	triggerWriteEnd (const Char8 *fname)
Read
typedef NodePtr(*	fileioreadcbfp )(SceneFileType *type, std::istream &is, const Char8 *ext)
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)
void	setReadCB (fileioreadcbfp fp)
fileioreadcbfp	getReadCB (void)
Write
typedef bool(*	fileiowritecbfp )(SceneFileType *type, const NodePtr &node, std::ostream &os, const Char8 *ext, bool compress)
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)
void	setWriteCB (fileiowritecbfp fp)
fileiowritecbfp	getWriteCB (void)
Member
static SceneFileHandler *	_the = NULL
static GraphOpSeq *	_defaultgraphOpSeq = NULL
FileTypeMap	_suffixTypeMap
static bool	addSceneFileType (SceneFileType &fileType)
static bool	subSceneFileType (SceneFileType &fileType)
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)
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	initReadProgress (std::istream &is)
void	terminateReadProgress (void)
Static Private Member Functions
static void	readProgress (void *data)
Private Attributes
progresscbfp	_readProgressFP
filenamecbfp	_readBeginFP
filenamecbfp	_readEndFP
progressS	_progressData
bool	_readReady
bool	_useProgressThread
progresscbfp	_writeProgressFP
filenamecbfp	_writeBeginFP
filenamecbfp	_writeEndFP
PathHandler *	_pathHandler
PathHandler	_defaultPathHandler
fileioreadcbfp	_readFP
fileiowritecbfp	_writeFP
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 void(* osg::SceneFileHandler::progresscbfp)(UInt32 p)

typedef void(* osg::SceneFileHandler::filenamecbfp)(const Char8 *fname)

typedef NodePtr(* osg::SceneFileHandler::fileioreadcbfp)(SceneFileType *type, std::istream &is, const Char8 *ext)

typedef bool(* osg::SceneFileHandler::fileiowritecbfp)(SceneFileType *type, const NodePtr &node, std::ostream &os, const Char8 *ext, bool compress)

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

Definition at line 202 of file OSGSceneFileHandler.h.

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

Definition at line 203 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 899 of file OSGSceneFileHandler.cpp.

References _defaultgraphOpSeq, _progressData, osg::SceneFileHandler::progressS::is, osg::SceneFileHandler::progressS::length, and osg::GraphOpSeq::setGraphOps().

                                        :
    _readProgressFP(NULL),
    _readBeginFP(NULL),
    _readEndFP(NULL),
    _progressData(),
    _readReady(false),
    _useProgressThread(false),
    _writeProgressFP(NULL),
    _writeBeginFP(NULL),
    _writeEndFP(NULL),
    _pathHandler(NULL),
    _defaultPathHandler(),
    _readFP(NULL),
    _writeFP(NULL)
{
    _progressData.length = 0;
    _progressData.is = NULL;

    if(_defaultgraphOpSeq == NULL)
    {
        // Set default optimizations
        _defaultgraphOpSeq = new GraphOpSeq;
        _defaultgraphOpSeq->setGraphOps("Stripe() SharePtr(includes=Material,StateChunk)");
    }

}

SceneFileHandler::SceneFileHandler

(

const SceneFileHandler &

obj

)

[protected]

constructors & destructors

Definition at line 946 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 976 of file OSGSceneFileHandler.cpp.

References _the.

Referenced by addSceneFileType(), osg::VRMLFile::beginNode(), osg::ProxyGroup::changed(), osg::VRMLInlineDesc::endNode(), osg::VRMLFile::endNode(), osg::ProxyGroup::loadProc(), osg::OFFSceneFileType::read(), osg::OBJSceneFileType::read(), osg::ImageFileHandler::read(), osg::OBJSceneFileType::readMTL(), readProgress(), osg::VRMLFile::scanFile(), osg::VRMLFile::scanStream(), osg::ProxyGroup::startLoading(), subSceneFileType(), osg::VRMLWriteAction::updateProgress(), osg::VRMLFile::use(), and osg::VRMLWriteAction::write().

{
    if(_the == NULL)
        _the = new SceneFileHandler;

    return *_the;
}

SceneFileType * SceneFileHandler::getFileType

(

const Char8 *

fileNameOrExtension

)

[virtual]

Definition at line 131 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 175 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,
		bool	use_thread = true
	)

Definition at line 986 of file OSGSceneFileHandler.cpp.

References _readProgressFP, _useProgressThread, and terminateReadProgress().

{
    if(use_thread)
    {
        terminateReadProgress();
    }
    else
    {
        // check if setReadProgressCB was called before with use_thread enabled.
        if(_useProgressThread)
            terminateReadProgress();
    }

    _readProgressFP = fp;
    _useProgressThread = use_thread;
}

SceneFileHandler::progresscbfp SceneFileHandler::getReadProgressCB

(

void

)

Definition at line 1003 of file OSGSceneFileHandler.cpp.

References _readProgressFP.

{
    return _readProgressFP;
}

void SceneFileHandler::setReadBeginCB

(

SceneFileHandler::filenamecbfp

fp

)

Definition at line 1008 of file OSGSceneFileHandler.cpp.

References _readBeginFP.

{
    _readBeginFP = fp;
}

SceneFileHandler::filenamecbfp SceneFileHandler::getReadBeginCB

(

void

)

Definition at line 1013 of file OSGSceneFileHandler.cpp.

References _readBeginFP.

{
    return _readBeginFP;
}

void SceneFileHandler::setReadEndCB

(

SceneFileHandler::filenamecbfp

fp

)

Definition at line 1018 of file OSGSceneFileHandler.cpp.

References _readEndFP.

{
    _readEndFP = fp;
}

SceneFileHandler::filenamecbfp SceneFileHandler::getReadEndCB

(

void

)

Definition at line 1023 of file OSGSceneFileHandler.cpp.

References _readEndFP.

{
    return _readEndFP;
}

void SceneFileHandler::updateReadProgress

(

void

)

Definition at line 1117 of file OSGSceneFileHandler.cpp.

References _readProgressFP, _useProgressThread, and readProgress().

Referenced by osg::VRMLFile::beginNode(), osg::VRMLFile::endNode(), read(), osg::OFFSceneFileType::read(), osg::OBJSceneFileType::read(), osg::VRMLFile::scanFile(), osg::VRMLFile::scanStream(), osg::VRMLFile::use(), and osg::VRMLWriteAction::write().

{
    if(_readProgressFP == NULL)
        return;

    if(_useProgressThread)
        return;

    readProgress(NULL);
}

void SceneFileHandler::updateReadProgress

(

UInt32

p

)

Definition at line 1128 of file OSGSceneFileHandler.cpp.

References _readProgressFP.

{
    if(_readProgressFP == NULL)
        return;

    _readProgressFP(p);
}

void SceneFileHandler::triggerReadBegin

(

const Char8 *

fname

)

Definition at line 1028 of file OSGSceneFileHandler.cpp.

References _readBeginFP.

Referenced by read().

{
    if(_readBeginFP != NULL)
      _readBeginFP(fname);
}

void SceneFileHandler::triggerReadEnd

(

const Char8 *

fname

)

Definition at line 1034 of file OSGSceneFileHandler.cpp.

References _readEndFP.

Referenced by read().

{
    if(_readEndFP != NULL)
      _readEndFP(fname);
}

void SceneFileHandler::setWriteProgressCB

(

progresscbfp

fp

)

Definition at line 1138 of file OSGSceneFileHandler.cpp.

References _writeProgressFP.

{
    _writeProgressFP = fp;
}

SceneFileHandler::progresscbfp SceneFileHandler::getWriteProgressCB

(

void

)

Definition at line 1143 of file OSGSceneFileHandler.cpp.

References _writeProgressFP.

{
    return _writeProgressFP;
}

void SceneFileHandler::setWriteBeginCB

(

SceneFileHandler::filenamecbfp

fp

)

Definition at line 1148 of file OSGSceneFileHandler.cpp.

References _writeBeginFP.

{
    _writeBeginFP = fp;
}

SceneFileHandler::filenamecbfp SceneFileHandler::getWriteBeginCB

(

void

)

Definition at line 1153 of file OSGSceneFileHandler.cpp.

References _writeBeginFP.

{
    return _writeBeginFP;
}

void SceneFileHandler::setWriteEndCB

(

SceneFileHandler::filenamecbfp

fp

)

Definition at line 1158 of file OSGSceneFileHandler.cpp.

References _writeEndFP.

{
    _writeEndFP = fp;
}

SceneFileHandler::filenamecbfp SceneFileHandler::getWriteEndCB

(

void

)

Definition at line 1163 of file OSGSceneFileHandler.cpp.

References _writeEndFP.

{
    return _writeEndFP;
}

void SceneFileHandler::updateWriteProgress

(

UInt32

p

)

Definition at line 1181 of file OSGSceneFileHandler.cpp.

References _writeProgressFP.

Referenced by osg::VRMLWriteAction::updateProgress(), osg::VRMLWriteAction::write(), and write().

{
    if(_writeProgressFP == NULL)
        return;

    _writeProgressFP(p);
}

void SceneFileHandler::triggerWriteBegin

(

const Char8 *

fname

)

Definition at line 1168 of file OSGSceneFileHandler.cpp.

References _writeBeginFP.

Referenced by write().

{
    if(_writeBeginFP != NULL)
      _writeBeginFP(fname);
}

void SceneFileHandler::triggerWriteEnd

(

const Char8 *

fname

)

Definition at line 1174 of file OSGSceneFileHandler.cpp.

References _writeEndFP.

Referenced by write().

{
    if(_writeEndFP != NULL)
      _writeEndFP(fname);
}

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

Definition at line 201 of file OSGSceneFileHandler.cpp.

References _readFP, getFileType(), osg::SceneFileType::getName(), initReadProgress(), osg::isGZip(), osg::NullFC, osg::SceneFileType::read(), osg::GraphOpSeq::run(), SFATAL, SINFO, SWARNING, and terminateReadProgress().

Referenced by osg::VRMLInlineDesc::endNode(), 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;
    
        // check for fileio read callback
        if(_readFP != NULL)
        {
            initReadProgress(is);
            scene = _readFP(type, is, fileNameOrExtension);
            terminateReadProgress();
        }
        else
        {
            if(isGZip(is))
            {
                SINFO << "Detected gzip compressed stream." << std::endl;

#ifdef OSG_ZSTREAM_SUPPORTED
                initReadProgress(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;
                }
                terminateReadProgress();
#else
                SFATAL << "Compressed streams are not supported! Configure with --enable-png --with-png=DIR options." << std::endl;
#endif
            }
            else
            {
                initReadProgress(is);
                scene = type->read(is, fileNameOrExtension);
                terminateReadProgress();
            }
        }

        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 275 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 300 of file OSGSceneFileHandler.cpp.

References _readFP, getFileType(), osg::SceneFileType::getName(), initPathHandler(), osg::NullFC, read(), osg::SceneFileType::readFile(), osg::GraphOpSeq::run(), SINFO, SWARNING, triggerReadBegin(), triggerReadEnd(), and updateReadProgress().

{
    if(!fileName)
    {
        SWARNING << "cannot read NULL file" << std::endl;
        return NullFC;
    }

    std::string fullFilePath = initPathHandler(fileName);
    if(fullFilePath.empty())
    {
        if(_readFP != NULL)
        {
            // that's a fallback could be a url so the callback
            // can handle this correctly.
            SceneFileType *type = getFileType(fileName);
            if(type != NULL)
            {
                // create a dummy stream with the bad flag set.
                std::ifstream in;
                in.setstate(std::ios::badbit);
                return _readFP(type, in, fileName);
            }
            else
            {
                SWARNING << "Couldn't open file " << fileName << std::endl;
                return NullFC;
            }
        }
        else
        {
            SWARNING << "Couldn't open file " << fileName << std::endl;
            return NullFC;
        }
    }

    SceneFileType *type = getFileType(fullFilePath.c_str());
    NodePtr scene = NullFC;

    if (type)
    {
    triggerReadBegin(fullFilePath.c_str());
    updateReadProgress(0);

        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)
        {
                triggerReadEnd(fullFilePath.c_str());
                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 395 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;
}

void SceneFileHandler::setReadCB

(

fileioreadcbfp

fp

)

Definition at line 450 of file OSGSceneFileHandler.cpp.

References _readFP.

{
    _readFP = fp;
}

SceneFileHandler::fileioreadcbfp SceneFileHandler::getReadCB

(

void

)

Definition at line 455 of file OSGSceneFileHandler.cpp.

References _readFP.

{
    return _readFP;
}

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

Definition at line 480 of file OSGSceneFileHandler.cpp.

References _writeFP, getFileType(), osg::SceneFileType::getName(), SFATAL, SINFO, SWARNING, updateWriteProgress(), and osg::SceneFileType::write().

Referenced by write().

{
    bool retCode = false;
    SceneFileType *type = getFileType(fileNameOrExtension);

    if(type)
    {
        updateWriteProgress(0);
        SINFO << "try to write stream as " << type->getName() << std::endl;
        
        if(_writeFP != NULL)
        {
            retCode = _writeFP(type, node, os, fileNameOrExtension, compress);
        }
        else
        {
            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 540 of file OSGSceneFileHandler.cpp.

References getFileType(), osg::SceneFileType::getName(), SINFO, SWARNING, triggerWriteBegin(), triggerWriteEnd(), updateWriteProgress(), write(), and osg::SceneFileType::writeFile().

{
    bool retCode = false;
    SceneFileType *type = getFileType(fileName);

    if (type)
    {
        updateWriteProgress(0);
    triggerWriteBegin(fileName);
        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
        triggerWriteEnd(fileName);
    }
    else
        SWARNING << "can't write " << fileName << "; unknown scene format" << std::endl;

    return retCode;
}

void SceneFileHandler::setWriteCB

(

fileiowritecbfp

fp

)

Definition at line 578 of file OSGSceneFileHandler.cpp.

References _writeFP.

{
    _writeFP = fp;
}

SceneFileHandler::fileiowritecbfp SceneFileHandler::getWriteCB

(

void

)

Definition at line 583 of file OSGSceneFileHandler.cpp.

References _writeFP.

{
    return _writeFP;
}

PathHandler * SceneFileHandler::getPathHandler

(

void

)

[virtual]

Returns the path handler used

Definition at line 591 of file OSGSceneFileHandler.cpp.

References _defaultPathHandler, and _pathHandler.

Referenced by osg::ProxyGroup::changed(), osg::VRMLInlineDesc::endNode(), initPathHandler(), osg::ImageFileHandler::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 603 of file OSGSceneFileHandler.cpp.

References _pathHandler.

{
    _pathHandler = pathHandler;
}

GraphOpSeq * SceneFileHandler::getDefaultGraphOp

(

void

)

[virtual]

Definition at line 638 of file OSGSceneFileHandler.cpp.

References _defaultgraphOpSeq.

{
    return _defaultgraphOpSeq;
}

void SceneFileHandler::setDefaultGraphOp

(

GraphOpSeq *

graphOpSeq

)

[virtual]

Definition at line 643 of file OSGSceneFileHandler.cpp.

References _defaultgraphOpSeq.

{
    _defaultgraphOpSeq = graphOpSeq;
}

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

Definition at line 649 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 663 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 696 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 773 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 836 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 611 of file OSGSceneFileHandler.cpp.

References _defaultPathHandler, _pathHandler, osg::PathHandler::clearBaseFile(), osg::PathHandler::clearPathList(), osg::PathHandler::findFile(), 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.clearBaseFile();
        _defaultPathHandler.push_frontCurrentDir();
        fullFilePath = _defaultPathHandler.findFile(fileName);
        _defaultPathHandler.setBaseFile(fullFilePath.c_str());
    }

    return fullFilePath;
}

void osg::SceneFileHandler::operator=

(

const SceneFileHandler &

source

)

[private]

void SceneFileHandler::initReadProgress

(

std::istream &

is

)

[private]

Definition at line 1040 of file OSGSceneFileHandler.cpp.

References _progressData, _readProgressFP, _readReady, _useProgressThread, 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);

    _readReady = false;
    if(_useProgressThread)
    {
        Thread *pt = Thread::find("osg::FileIOReadProgressThread");
        if(pt == NULL)
            pt = OSG::Thread::get("osg::FileIOReadProgressThread");

        if(pt != NULL)
            pt->runFunction(readProgress, 0, NULL);
        else
            SWARNING << "Couldn't create read progress thread!" << std::endl;
    }
}

void SceneFileHandler::terminateReadProgress

(

void

)

[private]

Definition at line 1065 of file OSGSceneFileHandler.cpp.

References _progressData, _readProgressFP, _readReady, osg::Thread::find(), osg::SceneFileHandler::progressS::is, osg::BaseThread::join(), and osg::SceneFileHandler::progressS::length.

Referenced by read(), and setReadProgressCB().

{
    if(_readProgressFP == NULL)
        return;

    _readReady = true;
    Thread *pt = Thread::find("osg::FileIOReadProgressThread");
    if(pt != NULL)
    {
        // terminate thread
        Thread::join(pt);
    }

    _progressData.length = 0;
    _progressData.is = NULL;
}

void SceneFileHandler::readProgress

(

void *

data

)

[static, private]

Definition at line 1082 of file OSGSceneFileHandler.cpp.

References _progressData, _readProgressFP, _readReady, _useProgressThread, osg::SceneFileHandler::progressS::is, osg::SceneFileHandler::progressS::length, osg::osgsleep(), p, and the().

Referenced by initReadProgress(), and updateReadProgress().

{
    if(the()._readProgressFP == NULL || the()._progressData.is == NULL)
        return;

    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;
        }

        the()._readProgressFP(p);

        if(the()._useProgressThread)
            osgsleep(100);
        else
            break;
    }

    if(the()._useProgressThread && p < 100)
    {
        the()._readProgressFP(100);
    }
}

---

Friends And Related Function Documentation

friend class SceneFileType [friend]

Definition at line 238 of file OSGSceneFileHandler.h.

---

Member Data Documentation

SceneFileHandler * SceneFileHandler::_the = NULL [static, protected]

Definition at line 216 of file OSGSceneFileHandler.h.

Referenced by the().

GraphOpSeq * SceneFileHandler::_defaultgraphOpSeq = NULL [static, protected]

Definition at line 218 of file OSGSceneFileHandler.h.

Referenced by getDefaultGraphOp(), SceneFileHandler(), and setDefaultGraphOp().

FileTypeMap osg::SceneFileHandler::_suffixTypeMap [protected]

Definition at line 220 of file OSGSceneFileHandler.h.

Referenced by addSceneFileType(), getFileType(), getSuffixList(), print(), and subSceneFileType().

progresscbfp osg::SceneFileHandler::_readProgressFP [private]

Definition at line 255 of file OSGSceneFileHandler.h.

Referenced by getReadProgressCB(), initReadProgress(), readProgress(), setReadProgressCB(), terminateReadProgress(), and updateReadProgress().

filenamecbfp osg::SceneFileHandler::_readBeginFP [private]

Definition at line 256 of file OSGSceneFileHandler.h.

Referenced by getReadBeginCB(), setReadBeginCB(), and triggerReadBegin().

filenamecbfp osg::SceneFileHandler::_readEndFP [private]

Definition at line 257 of file OSGSceneFileHandler.h.

Referenced by getReadEndCB(), setReadEndCB(), and triggerReadEnd().

progressS osg::SceneFileHandler::_progressData [private]

Definition at line 259 of file OSGSceneFileHandler.h.

Referenced by initReadProgress(), readProgress(), SceneFileHandler(), and terminateReadProgress().

bool osg::SceneFileHandler::_readReady [private]

Definition at line 260 of file OSGSceneFileHandler.h.

Referenced by initReadProgress(), readProgress(), and terminateReadProgress().

bool osg::SceneFileHandler::_useProgressThread [private]

Definition at line 261 of file OSGSceneFileHandler.h.

Referenced by initReadProgress(), readProgress(), setReadProgressCB(), and updateReadProgress().

progresscbfp osg::SceneFileHandler::_writeProgressFP [private]

Definition at line 263 of file OSGSceneFileHandler.h.

Referenced by getWriteProgressCB(), setWriteProgressCB(), and updateWriteProgress().

filenamecbfp osg::SceneFileHandler::_writeBeginFP [private]

Definition at line 264 of file OSGSceneFileHandler.h.

Referenced by getWriteBeginCB(), setWriteBeginCB(), and triggerWriteBegin().

filenamecbfp osg::SceneFileHandler::_writeEndFP [private]

Definition at line 265 of file OSGSceneFileHandler.h.

Referenced by getWriteEndCB(), setWriteEndCB(), and triggerWriteEnd().

PathHandler* osg::SceneFileHandler::_pathHandler [private]

Definition at line 267 of file OSGSceneFileHandler.h.

Referenced by getPathHandler(), initPathHandler(), and setPathHandler().

PathHandler osg::SceneFileHandler::_defaultPathHandler [private]

Definition at line 268 of file OSGSceneFileHandler.h.

Referenced by getPathHandler(), and initPathHandler().

fileioreadcbfp osg::SceneFileHandler::_readFP [private]

Definition at line 270 of file OSGSceneFileHandler.h.

Referenced by getReadCB(), read(), and setReadCB().

fileiowritecbfp osg::SceneFileHandler::_writeFP [private]

Definition at line 271 of file OSGSceneFileHandler.h.

Referenced by getWriteCB(), setWriteCB(), and write().

---

The documentation for this class was generated from the following files:

• OSGSceneFileHandler.h
• OSGSceneFileHandler.cpp