#include <ImageStream.h>

Inheritance diagram for osg::ImageStream:

Collaboration diagram for osg::ImageStream:

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

typedef std::vector < osg::ref_ptr < DimensionsChangedCallback > >	DimensionsChangedCallbackVector

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions
	ImageStream ()

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

virtual Object *	cloneType () const

virtual Object *	clone (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 () const

void	setLoopingMode (LoopingMode mode)

LoopingMode	getLoopingMode () const

virtual double	getCreationTime () const

virtual double	getLength () const

virtual double	getFrameRate () const

virtual double	getCurrentTime () 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

virtual float	getAudioBalance ()
	set the balance of the audio: -1 = left, 0 = center, 1 = right More...

virtual void	setAudioBalance (float)

void	setAudioStreams (const AudioStreams &asl)

AudioStreams &	getAudioStreams ()

const AudioStreams &	getAudioStreams () const

virtual osg::Texture *	createSuitableTexture ()

Public Member Functions inherited from osg::Image
	Image ()

	Image (const Image &image, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

virtual osg::Image *	asImage ()

virtual const osg::Image *	asImage () const

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, int rowLength=0)

virtual void	readPixels (int x, int y, int width, int height, GLenum pixelFormat, GLenum type, int packing=1)

virtual void	readImageFromCurrentTexture (unsigned int contextID, bool copyMipMapsIfAvailable, GLenum type=GL_UNSIGNED_BYTE, unsigned int face=0)

void	swap (osg::Image &rhs)

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	setRowLength (int length)

int	getRowLength () 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	getRowStepInBytes () const

unsigned int	getImageSizeInBytes () const

unsigned int	getImageStepInBytes () const

unsigned int	getTotalSizeInBytes () const

unsigned int	getTotalSizeInBytesIncludingMipmaps () const

bool	valid () const

unsigned char *	data ()

const unsigned char *	data () const

unsigned char *	data (unsigned int column, unsigned int row=0, unsigned int image=0)

const unsigned char *	data (unsigned int column, unsigned int row=0, unsigned int image=0) const

bool	isDataContiguous () 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	setColor (const osg::Vec4 &color, unsigned int s, unsigned int t=0, unsigned int r=0)

void	setColor (const osg::Vec4 &color, const osg::Vec2 &texcoord)

void	setColor (const osg::Vec4 &color, const osg::Vec3 &texcoord)

void	flipHorizontal ()

void	flipVertical ()

void	flipDepth ()

void	ensureValidSizeForTexturing (GLint maxTextureSize)

bool	isMipmap () const

unsigned int	getNumMipmapLevels () const

void	setMipmapLevels (const MipmapDataType &mipmapDataVector)

const MipmapDataType &	getMipmapLevels () const

unsigned int	getMipmapOffset (unsigned int mipmapLevel) const

unsigned char *	getMipmapData (unsigned int mipmapLevel)

const unsigned char *	getMipmapData (unsigned int mipmapLevel) const

bool	supportsTextureSubloading () const

virtual bool	isImageTranslucent () const

void	setPixelBufferObject (PixelBufferObject *buffer)

PixelBufferObject *	getPixelBufferObject ()

const PixelBufferObject *	getPixelBufferObject () 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 *)

void	addDimensionsChangedCallback (DimensionsChangedCallback *cb)

void	removeDimensionsChangedCallback (DimensionsChangedCallback *cb)

Public Member Functions inherited from osg::BufferData
	BufferData ()

	BufferData (const BufferData &bd, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

virtual osg::Array *	asArray ()

virtual const osg::Array *	asArray () const

virtual osg::PrimitiveSet *	asPrimitiveSet ()

virtual const osg::PrimitiveSet *	asPrimitiveSet () const

void	setBufferObject (BufferObject *bufferObject)

BufferObject *	getBufferObject ()

const BufferObject *	getBufferObject () const

void	setBufferIndex (unsigned int index)

unsigned int	getBufferIndex () const

GLBufferObject *	getGLBufferObject (unsigned int contextID) const

GLBufferObject *	getOrCreateGLBufferObject (unsigned int contextID) const

void	setModifiedCallback (ModifiedCallback *md)

ModifiedCallback *	getModifiedCallback ()

const ModifiedCallback *	getModifiedCallback () const

void	dirty ()

void	setModifiedCount (unsigned int value)

unsigned int	getModifiedCount () const

virtual void	resizeGLObjectBuffers (unsigned int maxSize)

void	releaseGLObjects (State *state=0) const

unsigned int	getNumClients () const

void	addClient (osg::Object *)

void	removeClient (osg::Object *)

Public Member Functions inherited from osg::Object
	Object ()

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

std::string	getCompoundClassName () const

virtual Node *	asNode ()

virtual const Node *	asNode () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () const

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::UserDataContainer *	getUserDataContainer ()

const osg::UserDataContainer *	getUserDataContainer () const

osg::UserDataContainer *	getOrCreateUserDataContainer ()

virtual void	setUserData (Referenced *obj)

virtual Referenced *	getUserData ()

virtual const Referenced *	getUserData () 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)

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const

int	ref () const

int	unref () const

int	unref_nodelete () const

int	referenceCount () const

ObserverSet *	getObserverSet () const

ObserverSet *	getOrCreateObserverSet () 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 ()

Image &	operator= (const Image &)

void	handleDimensionsChangedCallbacks ()

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

int	_rowLength

GLint	_internalTextureFormat

GLenum	_pixelFormat

GLenum	_dataType

unsigned int	_packing

float	_pixelAspectRatio

AllocationMode	_allocationMode

unsigned char *	_data

MipmapDataType	_mipmapData

DimensionsChangedCallbackVector	_dimensionsChangedCallbacks

Protected Attributes inherited from osg::BufferData
unsigned int	_modifiedCount

unsigned int	_bufferIndex

osg::ref_ptr< BufferObject >	_bufferObject

osg::ref_ptr< ModifiedCallback >	_modifiedCallback

unsigned int	_numClients

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	computeBlockSize (GLenum pixelFormat, GLenum packing)

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 unsigned int	computeImageSizeInBytes (int width, int height, int depth, GLenum pixelFormat, GLenum type, int packing=1, int slice_packing=1, int image_packing=1)

static int	computeNearestPowerOfTwo (int s, float bias=0.5f)

static int	computeNumberOfMipmapLevels (int s, int t=1, int r=1)

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

Detailed Description

Image Stream class.

Definition at line 28 of file ImageStream.h.

Member Typedef Documentation

typedef std::vector< osg::ref_ptr<osg::AudioStream> > osg::ImageStream::AudioStreams

Definition at line 100 of file ImageStream.h.

Member Enumeration Documentation

enum osg::ImageStream::LoopingMode

Enumerator
NO_LOOPING
LOOPING

Definition at line 66 of file ImageStream.h.

enum osg::ImageStream::StreamStatus

Enumerator
INVALID
PLAYING
PAUSED
REWINDING

Definition at line 45 of file ImageStream.h.

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

Definition at line 114 of file ImageStream.h.

Member Function Documentation

virtual void osg::ImageStream::applyLoopingMode ( )

inlineprotectedvirtual

Reimplemented in osg::ImageSequence.

Definition at line 112 of file ImageStream.h.

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.

Definition at line 40 of file ImageStream.h.

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.

Definition at line 37 of file ImageStream.h.

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.

Definition at line 36 of file ImageStream.h.

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.

virtual osg::Texture* osg::ImageStream::createSuitableTexture ( )

inlinevirtual

create a suitable texture for this imagestream, return NULL, if not supported implement this method in subclasses to use special technologies like CoreVideo or similar.

Definition at line 109 of file ImageStream.h.

virtual float osg::ImageStream::getAudioBalance ( )

inlinevirtual

set the balance of the audio: -1 = left, 0 = center, 1 = right

Definition at line 97 of file ImageStream.h.

AudioStreams& osg::ImageStream::getAudioStreams ( )

inline

Definition at line 102 of file ImageStream.h.

const AudioStreams& osg::ImageStream::getAudioStreams ( ) const

inline

Definition at line 103 of file ImageStream.h.

virtual double osg::ImageStream::getCreationTime ( ) const

inlinevirtual

Definition at line 82 of file ImageStream.h.

virtual double osg::ImageStream::getCurrentTime ( ) const

inlinevirtual

Definition at line 85 of file ImageStream.h.

virtual double osg::ImageStream::getFrameRate ( ) const

inlinevirtual

Definition at line 84 of file ImageStream.h.

virtual double osg::ImageStream::getLength ( ) const

inlinevirtual

Reimplemented in osg::ImageSequence.

Definition at line 83 of file ImageStream.h.

LoopingMode osg::ImageStream::getLoopingMode ( ) const

inline

Definition at line 80 of file ImageStream.h.

virtual double osg::ImageStream::getReferenceTime ( ) const

inlinevirtual

Reimplemented in osg::ImageSequence.

Definition at line 88 of file ImageStream.h.

StreamStatus osg::ImageStream::getStatus ( ) const

inline

Definition at line 63 of file ImageStream.h.

virtual double osg::ImageStream::getTimeMultiplier ( ) const

inlinevirtual

Reimplemented in osg::ImageSequence.

Definition at line 91 of file ImageStream.h.

virtual float osg::ImageStream::getVolume ( ) const

inlinevirtual

Definition at line 94 of file ImageStream.h.

virtual bool osg::ImageStream::isSameKindAs ( const Object * obj ) const

inlinevirtual

Reimplemented from osg::Image.

Reimplemented in osg::ImageSequence.

Definition at line 38 of file ImageStream.h.

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.

Definition at line 39 of file ImageStream.h.

virtual void osg::ImageStream::pause ( )

inlinevirtual

Reimplemented in osg::ImageSequence.

Definition at line 57 of file ImageStream.h.

virtual void osg::ImageStream::play ( )

inlinevirtual

Reimplemented in osg::ImageSequence.

Definition at line 55 of file ImageStream.h.

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

inlinevirtual

Definition at line 61 of file ImageStream.h.

virtual void osg::ImageStream::rewind ( )

inlinevirtual

Reimplemented in osg::ImageSequence.

Definition at line 59 of file ImageStream.h.

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

inlinevirtual

Reimplemented in osg::ImageSequence.

Definition at line 53 of file ImageStream.h.

virtual void osg::ImageStream::setAudioBalance ( float )

inlinevirtual

Definition at line 98 of file ImageStream.h.

void osg::ImageStream::setAudioStreams ( const AudioStreams & asl )

inline

Definition at line 101 of file ImageStream.h.

void osg::ImageStream::setLoopingMode ( LoopingMode mode )

inline

Definition at line 72 of file ImageStream.h.

virtual void osg::ImageStream::setReferenceTime ( double )

inlinevirtual

Reimplemented in osg::ImageSequence.

Definition at line 87 of file ImageStream.h.

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

inlinevirtual

Reimplemented in osg::ImageSequence.

Definition at line 90 of file ImageStream.h.

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

inlinevirtual

Definition at line 93 of file ImageStream.h.

Member Data Documentation

AudioStreams osg::ImageStream::_audioStreams

protected

Definition at line 119 of file ImageStream.h.

LoopingMode osg::ImageStream::_loopingMode

protected

Definition at line 117 of file ImageStream.h.

StreamStatus osg::ImageStream::_status

protected

Definition at line 116 of file ImageStream.h.

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

osg_head/include/osg/ImageStream.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation