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

Public Types

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

 ImageStream ()
 ImageStream (const ImageStream &image, 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 seek (double)
virtual void play ()
virtual void pause ()
virtual void rewind ()
virtual void quit (bool=true)
StreamStatus getStatus ()
void setLoopingMode (LoopingMode mode)
LoopingMode getLoopingMode () const
virtual double getCreationTime () const
virtual double getLength () const
virtual double getFrameRate () const
virtual void setReferenceTime (double)
virtual double getReferenceTime () const
virtual void setTimeMultiplier (double)
virtual double getTimeMultiplier () 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 setImage (int s, int t, int r, GLint internalTextureformat, GLenum pixelFormat, GLenum type, unsigned char *data, AllocationMode mode, 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 requiresUpdateCall () const
virtual void update (NodeVisitor *)
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 Member Functions

virtual void applyLoopingMode ()
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

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 Stream class.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator:
NO_LOOPING 
LOOPING 
Enumerator:
INVALID 
PLAYING 
PAUSED 
REWINDING 

Constructor & Destructor Documentation

osg::ImageStream::ImageStream ( )
osg::ImageStream::ImageStream ( const ImageStream image,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::ImageStream::~ImageStream ( )
inlineprotectedvirtual

Member Function Documentation

virtual void osg::ImageStream::applyLoopingMode ( )
inlineprotectedvirtual

Reimplemented in osg::ImageSequence.

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

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

Reimplemented from osg::Image.

Reimplemented in osg::ImageSequence.

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

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

Reimplemented from osg::Image.

Reimplemented in osg::ImageSequence.

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

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

Reimplemented from osg::Image.

Reimplemented in osg::ImageSequence.

virtual int osg::ImageStream::compare ( const Image rhs) const
virtual

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

Reimplemented from osg::Image.

Reimplemented in osg::ImageSequence.

AudioStreams& osg::ImageStream::getAudioStreams ( )
inline
const AudioStreams& osg::ImageStream::getAudioStreams ( ) const
inline
virtual double osg::ImageStream::getCreationTime ( ) const
inlinevirtual
virtual double osg::ImageStream::getFrameRate ( ) const
inlinevirtual
virtual double osg::ImageStream::getLength ( ) const
inlinevirtual

Reimplemented in osg::ImageSequence.

LoopingMode osg::ImageStream::getLoopingMode ( ) const
inline
virtual double osg::ImageStream::getReferenceTime ( ) const
inlinevirtual

Reimplemented in osg::ImageSequence.

StreamStatus osg::ImageStream::getStatus ( )
inline
virtual double osg::ImageStream::getTimeMultiplier ( ) const
inlinevirtual

Reimplemented in osg::ImageSequence.

virtual float osg::ImageStream::getVolume ( ) const
inlinevirtual
virtual bool osg::ImageStream::isSameKindAs ( const Object obj) const
inlinevirtual

Reimplemented from osg::Image.

Reimplemented in osg::ImageSequence.

virtual const char* osg::ImageStream::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::Image.

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::pause ( )
inlinevirtual

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::play ( )
inlinevirtual

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::quit ( bool  = true)
inlinevirtual
virtual void osg::ImageStream::rewind ( )
inlinevirtual

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::seek ( double  )
inlinevirtual

Reimplemented in osg::ImageSequence.

void osg::ImageStream::setAudioStreams ( const AudioStreams asl)
inline
void osg::ImageStream::setLoopingMode ( LoopingMode  mode)
inline
virtual void osg::ImageStream::setReferenceTime ( double  )
inlinevirtual

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::setTimeMultiplier ( double  )
inlinevirtual

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::setVolume ( float  )
inlinevirtual

Member Data Documentation

AudioStreams osg::ImageStream::_audioStreams
protected
LoopingMode osg::ImageStream::_loopingMode
protected
StreamStatus osg::ImageStream::_status
protected

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