OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Protected Attributes
osgDB::ReaderWriter::ReadResult Class Reference

List of all members.

Public Types

enum  ReadStatus {
  NOT_IMPLEMENTED, FILE_NOT_HANDLED, FILE_NOT_FOUND, FILE_LOADED,
  FILE_LOADED_FROM_CACHE, ERROR_IN_READING_FILE, 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)
 ReadResult (const ReadResult &rr)
ReadResultoperator= (const ReadResult &rr)
osg::ObjectgetObject ()
osg::ImagegetImage ()
osg::HeightFieldgetHeightField ()
osg::NodegetNode ()
osgDB::ArchivegetArchive ()
osg::ShadergetShader ()
bool validObject ()
bool validImage ()
bool validHeightField ()
bool validNode ()
bool validArchive ()
bool validShader ()
osg::ObjecttakeObject ()
osg::ImagetakeImage ()
osg::HeightFieldtakeHeightField ()
osg::NodetakeNode ()
osgDB::ArchivetakeArchive ()
osg::ShadertakeShader ()
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

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.

FILE_LOADED 

File successfully found, loaded, and converted into osg.

FILE_LOADED_FROM_CACHE 

File found in cache and returned.

ERROR_IN_READING_FILE 

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

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.


Constructor & Destructor Documentation

osgDB::ReaderWriter::ReadResult::ReadResult ( ReadStatus  status = FILE_NOT_HANDLED) [inline]
osgDB::ReaderWriter::ReadResult::ReadResult ( const std::string &  m) [inline]
osgDB::ReaderWriter::ReadResult::ReadResult ( osg::Object obj,
ReadStatus  status = FILE_LOADED 
) [inline]
osgDB::ReaderWriter::ReadResult::ReadResult ( const ReadResult rr) [inline]

Member Function Documentation

bool osgDB::ReaderWriter::ReadResult::error ( ) const [inline]
osgDB::Archive* osgDB::ReaderWriter::ReadResult::getArchive ( )
osg::HeightField* osgDB::ReaderWriter::ReadResult::getHeightField ( )
osg::Image* osgDB::ReaderWriter::ReadResult::getImage ( )
osg::Node* osgDB::ReaderWriter::ReadResult::getNode ( )
osg::Object* osgDB::ReaderWriter::ReadResult::getObject ( )
osg::Shader* osgDB::ReaderWriter::ReadResult::getShader ( )
bool osgDB::ReaderWriter::ReadResult::loadedFromCache ( ) const [inline]
std::string& osgDB::ReaderWriter::ReadResult::message ( ) [inline]
const std::string& osgDB::ReaderWriter::ReadResult::message ( ) const [inline]
bool osgDB::ReaderWriter::ReadResult::notEnoughMemory ( ) const [inline]
bool osgDB::ReaderWriter::ReadResult::notFound ( ) const [inline]

References osgDB::FILE_NOT_FOUND.

bool osgDB::ReaderWriter::ReadResult::notHandled ( ) const [inline]
ReadResult& osgDB::ReaderWriter::ReadResult::operator= ( const ReadResult rr) [inline]

References _status, _message, and _object.

ReadStatus osgDB::ReaderWriter::ReadResult::status ( ) const [inline]
bool osgDB::ReaderWriter::ReadResult::success ( ) const [inline]
osgDB::Archive* osgDB::ReaderWriter::ReadResult::takeArchive ( )
osg::HeightField* osgDB::ReaderWriter::ReadResult::takeHeightField ( )
osg::Image* osgDB::ReaderWriter::ReadResult::takeImage ( )
osg::Node* osgDB::ReaderWriter::ReadResult::takeNode ( )
osg::Object* osgDB::ReaderWriter::ReadResult::takeObject ( )
osg::Shader* osgDB::ReaderWriter::ReadResult::takeShader ( )
bool osgDB::ReaderWriter::ReadResult::validArchive ( ) [inline]
bool osgDB::ReaderWriter::ReadResult::validHeightField ( ) [inline]
bool osgDB::ReaderWriter::ReadResult::validImage ( ) [inline]
bool osgDB::ReaderWriter::ReadResult::validNode ( ) [inline]
bool osgDB::ReaderWriter::ReadResult::validObject ( ) [inline]
bool osgDB::ReaderWriter::ReadResult::validShader ( ) [inline]

Member Data Documentation

Referenced by operator=().

Referenced by operator=().

Referenced by operator=().


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

osg logo
Generated at Mon Oct 3 2011 12:39:46 for the OpenSceneGraph by doxygen 1.7.5.