osg::ImageSequence Class Reference

Image Buffer class. More...

Inheritance diagram for osg::ImageSequence:

Inheritance graph
[legend]

List of all members.

Public Types

enum  Mode { PRE_LOAD_ALL_IMAGES, PAGE_AND_RETAIN_IMAGES, PAGE_AND_DISCARD_USED_IMAGES }
typedef std::list
< osg::ref_ptr< osg::Image > > 
Images
typedef std::list< std::string > FileNames

Public Member Functions

 ImageSequence ()
 ImageSequence (const ImageSequence &ImageSequence, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual ObjectcloneType () const
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &copyop) const
 Clone an object, with Object* return type.
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
 return the name of the object's library.
virtual const char * className () const
 return the name of the object's class type.
virtual int compare (const Image &rhs) const
 Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
virtual void setReferenceTime (double t)
virtual double getReferenceTime () const
virtual void setTimeMultiplier (double tm)
virtual double getTimeMultiplier () const
void setMode (Mode mode)
Mode getMode () const
void setDuration (double duration)
double getDuration () const
void addImageFile (const std::string &fileName)
FileNamesgetFileNames ()
const FileNamesgetFileNames () const
void addImage (osg::Image *image)
ImagesgetImages ()
const ImagesgetImages () const
virtual void update (NodeVisitor *nv)

Protected Types

typedef std::pair< std::string,
osg::ref_ptr< osg::Image > > 
FileNameImagePair
typedef std::list
< FileNameImagePair
FileNameImageList

Protected Member Functions

virtual ~ImageSequence ()
void setImageToChild (const osg::Image *image)
void computeTimePerImage ()

Protected Attributes

double _referenceTime
double _timeMultiplier
Mode _mode
double _duration
double _timePerImage
OpenThreads::Mutex _mutex
FileNames _fileNames
FileNames::iterator _fileNamesIterator
double _fileNamesIteratorTime
double _imageHeadTime
Images _images
Images::iterator _imageIterator
double _imageIteratorTime
FileNameImageList _filesRequested

Classes

struct  UpdateCallback


Detailed Description

Image Buffer class.

Member Typedef Documentation

typedef std::list< std::string > osg::ImageSequence::FileNames

typedef std::pair< std::string, osg::ref_ptr<osg::Image> > osg::ImageSequence::FileNameImagePair [protected]

typedef std::list< FileNameImagePair > osg::ImageSequence::FileNameImageList [protected]


Member Enumeration Documentation

Enumerator:
PRE_LOAD_ALL_IMAGES 
PAGE_AND_RETAIN_IMAGES 
PAGE_AND_DISCARD_USED_IMAGES 


Constructor & Destructor Documentation

osg::ImageSequence::ImageSequence (  ) 

osg::ImageSequence::ImageSequence ( const ImageSequence ImageSequence,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::ImageSequence::~ImageSequence (  )  [inline, protected, virtual]


Member Function Documentation

virtual Object* osg::ImageSequence::cloneType (  )  const [inline, virtual]

Clone the type of an object, with Object* return type.

Must be defined by derived classes.

Reimplemented from osg::ImageStream.

virtual Object* osg::ImageSequence::clone ( const CopyOp  )  const [inline, virtual]

Clone an object, with Object* return type.

Must be defined by derived classes.

Reimplemented from osg::ImageStream.

virtual bool osg::ImageSequence::isSameKindAs ( const Object obj  )  const [inline, virtual]

Reimplemented from osg::ImageStream.

virtual const char* osg::ImageSequence::libraryName (  )  const [inline, virtual]

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Reimplemented from osg::ImageStream.

virtual const char* osg::ImageSequence::className (  )  const [inline, virtual]

return the name of the object's class type.

Must be defined by derived classes.

Reimplemented from osg::ImageStream.

virtual int osg::ImageSequence::compare ( const Image rhs  )  const [virtual]

Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Reimplemented from osg::ImageStream.

virtual void osg::ImageSequence::setReferenceTime ( double  t  )  [inline, virtual]

Reimplemented from osg::ImageStream.

virtual double osg::ImageSequence::getReferenceTime (  )  const [inline, virtual]

Reimplemented from osg::ImageStream.

virtual void osg::ImageSequence::setTimeMultiplier ( double  tm  )  [inline, virtual]

Reimplemented from osg::ImageStream.

virtual double osg::ImageSequence::getTimeMultiplier (  )  const [inline, virtual]

Reimplemented from osg::ImageStream.

void osg::ImageSequence::setMode ( Mode  mode  ) 

Mode osg::ImageSequence::getMode (  )  const [inline]

void osg::ImageSequence::setDuration ( double  duration  ) 

double osg::ImageSequence::getDuration (  )  const [inline]

void osg::ImageSequence::addImageFile ( const std::string &  fileName  ) 

FileNames& osg::ImageSequence::getFileNames (  )  [inline]

const FileNames& osg::ImageSequence::getFileNames (  )  const [inline]

void osg::ImageSequence::addImage ( osg::Image image  ) 

Images& osg::ImageSequence::getImages (  )  [inline]

const Images& osg::ImageSequence::getImages (  )  const [inline]

virtual void osg::ImageSequence::update ( NodeVisitor nv  )  [virtual]

Reimplemented from osg::Image.

void osg::ImageSequence::setImageToChild ( const osg::Image image  )  [protected]

void osg::ImageSequence::computeTimePerImage (  )  [protected]


Member Data Documentation

double osg::ImageSequence::_duration [protected]

OpenThreads::Mutex osg::ImageSequence::_mutex [protected]

FileNames::iterator osg::ImageSequence::_fileNamesIterator [protected]

Images::iterator osg::ImageSequence::_imageIterator [protected]


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

Generated at Thu Aug 14 04:12:59 2008 for the OpenSceneGraph by doxygen 1.5.6.