OpenSceneGraph
Public Types | Public Member Functions | Protected Attributes | List of all members
osgDB::ReaderWriter::ReadResult Class Reference
Collaboration diagram for osgDB::ReaderWriter::ReadResult:
Collaboration graph
[legend]

Public Types

enum  ReadStatus {
  NOT_IMPLEMENTED, FILE_NOT_HANDLED, FILE_NOT_FOUND, ERROR_IN_READING_FILE,
  FILE_LOADED, FILE_LOADED_FROM_CACHE, FILE_REQUESTED, INSUFFICIENT_MEMORY_TO_LOAD
}
 

Public Member Functions

 ReadResult (ReadStatus status=FILE_NOT_HANDLED)
 
 ReadResult (const std::string &m)
 
 ReadResult (osg::Object *obj, ReadStatus status=FILE_LOADED)
 
template<class T >
 ReadResult (const osg::ref_ptr< T > &obj, ReadStatus status=FILE_LOADED)
 
 ReadResult (const ReadResult &rr)
 
ReadResultoperator= (const ReadResult &rr)
 
bool operator< (const ReadResult &rhs) const
 
osg::ObjectgetObject ()
 
osg::ImagegetImage ()
 
osg::HeightFieldgetHeightField ()
 
osg::NodegetNode ()
 
osgDB::ArchivegetArchive ()
 
osg::ShadergetShader ()
 
osg::ScriptgetScript ()
 
bool validObject ()
 
bool validImage ()
 
bool validHeightField ()
 
bool validNode ()
 
bool validArchive ()
 
bool validShader ()
 
bool validScript ()
 
osg::ObjecttakeObject ()
 
osg::ImagetakeImage ()
 
osg::HeightFieldtakeHeightField ()
 
osg::NodetakeNode ()
 
osgDB::ArchivetakeArchive ()
 
osg::ShadertakeShader ()
 
osg::ScripttakeScript ()
 
std::string & message ()
 
const std::string & message () const
 
ReadStatus status () const
 
bool success () const
 
bool loadedFromCache () const
 
bool error () const
 
bool notHandled () const
 
bool notFound () const
 
bool notEnoughMemory () const
 

Protected Attributes

ReadStatus _status
 
std::string _message
 
osg::ref_ptr< osg::Object_object
 

Member Enumeration Documentation

◆ ReadStatus

Enumerator
NOT_IMPLEMENTED 

read*() method not implemented in concrete ReaderWriter.

FILE_NOT_HANDLED 

File is not appropriate for this file reader, due to some incompatibility, but not a read error.

FILE_NOT_FOUND 

File could not be found or could not be read.

ERROR_IN_READING_FILE 

File found, loaded, but an error was encountered during processing.

FILE_LOADED 

File successfully found, loaded, and converted into osg.

FILE_LOADED_FROM_CACHE 

File found in cache and returned.

FILE_REQUESTED 

Asynchronous file read has been requested, but returning immediately, keep polling plugin until file read has been completed.

INSUFFICIENT_MEMORY_TO_LOAD 

File found but not loaded because estimated required memory surpasses available memory.


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