openscenegraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::ImageSequence Class Reference
Inheritance diagram for osg::ImageSequence:
osg::ImageStream osg::Image osg::BufferData osg::Object osg::Referenced

Public Types

enum  Mode { PRE_LOAD_ALL_IMAGES, PAGE_AND_RETAIN_IMAGES, PAGE_AND_DISCARD_USED_IMAGES }
typedef std::vector
< osg::ref_ptr< osg::Image > > 
Images
typedef std::vector< std::string > FileNames
- Public Types inherited from osg::ImageStream
enum  StreamStatus { INVALID, PLAYING, PAUSED, REWINDING }
enum  LoopingMode { NO_LOOPING, LOOPING }
typedef std::vector
< osg::ref_ptr
< osg::AudioStream > > 
AudioStreams
- Public Types inherited from osg::Image
enum  WriteHint { NO_PREFERENCE, STORE_INLINE, EXTERNAL_FILE }
enum  AllocationMode { NO_DELETE, USE_NEW_DELETE, USE_MALLOC_FREE }
enum  Origin { BOTTOM_LEFT, TOP_LEFT }
typedef std::vector< unsigned int > MipmapDataType

Public Member Functions

 ImageSequence ()
 ImageSequence (const ImageSequence &ImageSequence, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual int compare (const Image &rhs) const
virtual void setReferenceTime (double t)
virtual double getReferenceTime () const
virtual void setTimeMultiplier (double tm)
virtual double getTimeMultiplier () const
virtual void seek (double time)
virtual void play ()
virtual void pause ()
virtual void rewind ()
void setMode (Mode mode)
Mode getMode () const
void setLength (double length)
virtual double getLength () const
void addImageFile (const std::string &fileName)
void setImageFile (unsigned int pos, const std::string &fileName)
std::string getImageFile (unsigned int pos) const
unsigned int getNumImageFiles () const
FileNamesgetFileNames ()
const FileNamesgetFileNames () const
void addImage (osg::Image *image)
void setImage (int s, int t, int r, GLint internalTextureformat, GLenum pixelFormat, GLenum type, unsigned char *data, AllocationMode mode, int packing=1)
void setImage (unsigned int pos, osg::Image *image)
ImagegetImage (unsigned int pos)
const ImagegetImage (unsigned int pos) const
unsigned int getNumImages () const
ImagesgetImages ()
const ImagesgetImages () const
virtual bool requiresUpdateCall () const
virtual void update (NodeVisitor *nv)
- Public Member Functions inherited from osg::ImageStream
 ImageStream ()
 ImageStream (const ImageStream &image, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void quit (bool=true)
StreamStatus getStatus ()
void setLoopingMode (LoopingMode mode)
LoopingMode getLoopingMode () const
virtual double getCreationTime () const
virtual double getFrameRate () const
virtual void setVolume (float)
virtual float getVolume () const
void setAudioStreams (const AudioStreams &asl)
AudioStreamsgetAudioStreams ()
const AudioStreamsgetAudioStreams () const
- Public Member Functions inherited from osg::Image
 Image ()
 Image (const Image &image, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual const GLvoid * getDataPointer () const
virtual unsigned int getTotalDataSize () const
void setFileName (const std::string &fileName)
const std::string & getFileName () const
void setWriteHint (WriteHint writeHint)
WriteHint getWriteHint () const
void setAllocationMode (AllocationMode mode)
AllocationMode getAllocationMode () const
virtual void allocateImage (int s, int t, int r, GLenum pixelFormat, GLenum type, int packing=1)
virtual void readPixels (int x, int y, int width, int height, GLenum pixelFormat, GLenum type)
virtual void readImageFromCurrentTexture (unsigned int contextID, bool copyMipMapsIfAvailable, GLenum type=GL_UNSIGNED_BYTE)
void scaleImage (int s, int t, int r)
virtual void scaleImage (int s, int t, int r, GLenum newDataType)
virtual void copySubImage (int s_offset, int t_offset, int r_offset, const osg::Image *source)
void setOrigin (Origin origin)
Origin getOrigin () const
int s () const
int t () const
int r () const
void setInternalTextureFormat (GLint internalFormat)
GLint getInternalTextureFormat () const
void setPixelFormat (GLenum pixelFormat)
GLenum getPixelFormat () const
void setDataType (GLenum dataType)
GLenum getDataType () const
void setPacking (unsigned int packing)
unsigned int getPacking () const
bool isCompressed () const
void setPixelAspectRatio (float pixelAspectRatio)
float getPixelAspectRatio () const
unsigned int getPixelSizeInBits () const
unsigned int getRowSizeInBytes () const
unsigned int getImageSizeInBytes () const
unsigned int getTotalSizeInBytes () const
unsigned int getTotalSizeInBytesIncludingMipmaps () const
bool valid () const
unsigned char * data ()
const unsigned char * data () const
unsigned char * data (int column, int row=0, int image=0)
const unsigned char * data (int column, int row=0, int image=0) const
Vec4 getColor (unsigned int s, unsigned t=0, unsigned r=0) const
Vec4 getColor (const Vec2 &texcoord) const
Vec4 getColor (const Vec3 &texcoord) const
void flipHorizontal ()
void flipVertical ()
void ensureValidSizeForTexturing (GLint maxTextureSize)
bool isMipmap () const
unsigned int getNumMipmapLevels () const
void setMipmapLevels (const MipmapDataType &mipmapDataVector)
const MipmapDataTypegetMipmapLevels () const
unsigned int getMipmapOffset (unsigned int mipmapLevel) const
unsigned char * getMipmapData (unsigned int mipmapLevel)
const unsigned char * getMipmapData (unsigned int mipmapLevel) const
virtual bool isImageTranslucent () const
void setPixelBufferObject (PixelBufferObject *buffer)
PixelBufferObjectgetPixelBufferObject ()
const PixelBufferObjectgetPixelBufferObject () const
virtual bool sendFocusHint (bool)
virtual bool sendPointerEvent (int, int, int)
virtual bool sendKeyEvent (int, bool)
virtual void setFrameLastRendered (const osg::FrameStamp *)
- Public Member Functions inherited from osg::BufferData
 BufferData ()
 BufferData (const BufferData &bd, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
void setBufferObject (BufferObject *bufferObject)
BufferObjectgetBufferObject ()
const BufferObjectgetBufferObject () const
void setBufferIndex (unsigned int index)
unsigned int getBufferIndex () const
GLBufferObjectgetGLBufferObject (unsigned int contextID) const
GLBufferObjectgetOrCreateGLBufferObject (unsigned int contextID) const
void setModifiedCallback (ModifiedCallback *md)
ModifiedCallbackgetModifiedCallback ()
const ModifiedCallbackgetModifiedCallback () const
void dirty ()
void setModifiedCount (unsigned int value)
unsigned int getModifiedCount () const
virtual void resizeGLObjectBuffers (unsigned int maxSize)
void releaseGLObjects (State *state=0) const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Protected Types

typedef std::set< std::string > FilesRequested

Protected Member Functions

virtual ~ImageSequence ()
virtual void applyLoopingMode ()
void setImageToChild (const osg::Image *image)
void computeTimePerImage ()
int imageIndex (double time)
- Protected Member Functions inherited from osg::ImageStream
virtual ~ImageStream ()
- Protected Member Functions inherited from osg::Image
virtual ~Image ()
Imageoperator= (const Image &)
void deallocateData ()
void setData (unsigned char *data, AllocationMode allocationMode)
- Protected Member Functions inherited from osg::BufferData
virtual ~BufferData ()
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

double _referenceTime
double _timeMultiplier
Mode _mode
double _length
double _timePerImage
OpenThreads::Mutex _mutex
FileNames _fileNames
Images _images
FilesRequested _filesRequested
int _previousAppliedImageIndex
bool _seekTimeSet
double _seekTime
- Protected Attributes inherited from osg::ImageStream
StreamStatus _status
LoopingMode _loopingMode
AudioStreams _audioStreams
- Protected Attributes inherited from osg::Image
std::string _fileName
WriteHint _writeHint
Origin _origin
int _s
int _t
int _r
GLint _internalTextureFormat
GLenum _pixelFormat
GLenum _dataType
unsigned int _packing
float _pixelAspectRatio
AllocationMode _allocationMode
unsigned char * _data
MipmapDataType _mipmapData
ref_ptr< PixelBufferObject_bufferObject
- Protected Attributes inherited from osg::BufferData
unsigned int _modifiedCount
unsigned int _bufferIndex
osg::ref_ptr< BufferObject_bufferObject
osg::ref_ptr< ModifiedCallback_modifiedCallback
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

- Static Public Member Functions inherited from osg::Image
static bool isPackedType (GLenum type)
static GLenum computePixelFormat (GLenum pixelFormat)
static GLenum computeFormatDataType (GLenum pixelFormat)
static unsigned int computeNumComponents (GLenum pixelFormat)
static unsigned int computePixelSizeInBits (GLenum pixelFormat, GLenum type)
static unsigned int computeRowWidthInBytes (int width, GLenum pixelFormat, GLenum type, int packing)
static int computeNearestPowerOfTwo (int s, float bias=0.5f)
static int computeNumberOfMipmapLevels (int s, int t=1, int r=1)

Detailed Description

Image Buffer class.

Member Typedef Documentation

typedef std::vector< std::string > osg::ImageSequence::FileNames
typedef std::set< std::string > osg::ImageSequence::FilesRequested
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 ( )
inlineprotectedvirtual

Member Function Documentation

void osg::ImageSequence::addImage ( osg::Image image)
void osg::ImageSequence::addImageFile ( const std::string &  fileName)
virtual void osg::ImageSequence::applyLoopingMode ( )
protectedvirtual

Reimplemented from osg::ImageStream.

virtual const char* osg::ImageSequence::className ( ) const
inlinevirtual

return the name of the object's class type. Must be defined by derived classes.

Reimplemented from osg::ImageStream.

virtual Object* osg::ImageSequence::clone ( const CopyOp ) const
inlinevirtual

Clone an object, with Object* return type. Must be defined by derived classes.

Reimplemented from osg::ImageStream.

virtual Object* osg::ImageSequence::cloneType ( ) const
inlinevirtual

Clone the type of an object, with Object* return 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.

void osg::ImageSequence::computeTimePerImage ( )
protected
FileNames& osg::ImageSequence::getFileNames ( )
inline
const FileNames& osg::ImageSequence::getFileNames ( ) const
inline
Image* osg::ImageSequence::getImage ( unsigned int  pos)
const Image* osg::ImageSequence::getImage ( unsigned int  pos) const
std::string osg::ImageSequence::getImageFile ( unsigned int  pos) const
Images& osg::ImageSequence::getImages ( )
inline
const Images& osg::ImageSequence::getImages ( ) const
inline
virtual double osg::ImageSequence::getLength ( ) const
inlinevirtual

Reimplemented from osg::ImageStream.

Mode osg::ImageSequence::getMode ( ) const
inline
unsigned int osg::ImageSequence::getNumImageFiles ( ) const
inline
unsigned int osg::ImageSequence::getNumImages ( ) const
inline
virtual double osg::ImageSequence::getReferenceTime ( ) const
inlinevirtual

Reimplemented from osg::ImageStream.

virtual double osg::ImageSequence::getTimeMultiplier ( ) const
inlinevirtual

Reimplemented from osg::ImageStream.

int osg::ImageSequence::imageIndex ( double  time)
protected
virtual bool osg::ImageSequence::isSameKindAs ( const Object obj) const
inlinevirtual

Reimplemented from osg::ImageStream.

virtual const char* osg::ImageSequence::libraryName ( ) const
inlinevirtual

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 void osg::ImageSequence::pause ( )
virtual

Reimplemented from osg::ImageStream.

virtual void osg::ImageSequence::play ( )
virtual

Reimplemented from osg::ImageStream.

virtual bool osg::ImageSequence::requiresUpdateCall ( ) const
inlinevirtual

ImageSequence requires a call to update(NodeVisitor*) during the update traversal so return true.

Reimplemented from osg::Image.

virtual void osg::ImageSequence::rewind ( )
virtual

Reimplemented from osg::ImageStream.

virtual void osg::ImageSequence::seek ( double  time)
virtual

Reimplemented from osg::ImageStream.

void osg::ImageSequence::setImage ( int  s,
int  t,
int  r,
GLint  internalTextureformat,
GLenum  pixelFormat,
GLenum  type,
unsigned char *  data,
AllocationMode  mode,
int  packing = 1 
)
inlinevirtual

Set the image dimensions, format and data.

Reimplemented from osg::Image.

References osg::Image::setImage().

void osg::ImageSequence::setImage ( unsigned int  pos,
osg::Image image 
)
void osg::ImageSequence::setImageFile ( unsigned int  pos,
const std::string &  fileName 
)
void osg::ImageSequence::setImageToChild ( const osg::Image image)
protected
void osg::ImageSequence::setLength ( double  length)
void osg::ImageSequence::setMode ( Mode  mode)
virtual void osg::ImageSequence::setReferenceTime ( double  t)
inlinevirtual

Reimplemented from osg::ImageStream.

virtual void osg::ImageSequence::setTimeMultiplier ( double  tm)
inlinevirtual

Reimplemented from osg::ImageStream.

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

update method for osg::Image subclasses that update themselves during the update traversal.

Reimplemented from osg::Image.

Member Data Documentation

FileNames osg::ImageSequence::_fileNames
protected
FilesRequested osg::ImageSequence::_filesRequested
protected
Images osg::ImageSequence::_images
protected
double osg::ImageSequence::_length
protected
Mode osg::ImageSequence::_mode
protected
OpenThreads::Mutex osg::ImageSequence::_mutex
mutableprotected
int osg::ImageSequence::_previousAppliedImageIndex
protected
double osg::ImageSequence::_referenceTime
protected
double osg::ImageSequence::_seekTime
protected
bool osg::ImageSequence::_seekTimeSet
protected
double osg::ImageSequence::_timeMultiplier
protected
double osg::ImageSequence::_timePerImage
protected

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