osg::ImageStream Class Reference

Image Stream class. More...

Inheritance diagram for osg::ImageStream:

List of all members.

Public Types
enum	StreamStatus { INVALID, PLAYING, PAUSED, REWINDING }
enum	LoopingMode { NO_LOOPING, LOOPING }
typedef std::vector < osg::ref_ptr < osg::AudioStream > >	AudioStreams
Public Member Functions
	ImageStream ()
	ImageStream (const ImageStream &image, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
virtual Object *	cloneType () const
	Clone the type of an object, with Object* return type.
virtual Object *	clone (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	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
virtual void	setAudioBalance (float)
void	setAudioStreams (const AudioStreams &asl)
AudioStreams &	getAudioStreams ()
const AudioStreams &	getAudioStreams () const
virtual osg::Texture *	createSuitableTexture ()
	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.
Protected Member Functions
virtual void	applyLoopingMode ()
virtual	~ImageStream ()
Protected Attributes
StreamStatus	_status
LoopingMode	_loopingMode
AudioStreams	_audioStreams

---

Detailed Description

Image Stream class.

---

Member Typedef Documentation

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

---

Member Enumeration Documentation

enum osg::ImageStream::LoopingMode

Enumerator:

NO_LOOPING
LOOPING

enum osg::ImageStream::StreamStatus

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

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual void osg::ImageStream::applyLoopingMode

(

)

[inline, protected, virtual]

Reimplemented in osg::ImageSequence.

virtual const char* osg::ImageStream::className

(

)

const [inline, virtual]

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 [inline, virtual]

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 [inline, virtual]

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.

virtual osg::Texture* osg::ImageStream::createSuitableTexture

(

)

[inline, virtual]

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.

References NULL.

virtual float osg::ImageStream::getAudioBalance

(

)

[inline, virtual]

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

AudioStreams& osg::ImageStream::getAudioStreams

(

)

[inline]

const AudioStreams& osg::ImageStream::getAudioStreams

(

)

const [inline]

virtual double osg::ImageStream::getCreationTime

(

)

const [inline, virtual]

virtual double osg::ImageStream::getCurrentTime

(

)

const [inline, virtual]

virtual double osg::ImageStream::getFrameRate

(

)

const [inline, virtual]

virtual double osg::ImageStream::getLength

(

)

const [inline, virtual]

Reimplemented in osg::ImageSequence.

LoopingMode osg::ImageStream::getLoopingMode

(

)

const [inline]

virtual double osg::ImageStream::getReferenceTime

(

)

const [inline, virtual]

Reimplemented in osg::ImageSequence.

StreamStatus osg::ImageStream::getStatus

(

)

const [inline]

virtual double osg::ImageStream::getTimeMultiplier

(

)

const [inline, virtual]

Reimplemented in osg::ImageSequence.

virtual float osg::ImageStream::getVolume

(

)

const [inline, virtual]

virtual bool osg::ImageStream::isSameKindAs

(

const Object *

obj

)

const [inline, virtual]

Reimplemented from osg::Image.

Reimplemented in osg::ImageSequence.

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

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::pause

(

)

[inline, virtual]

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::play

(

)

[inline, virtual]

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::quit

(

bool

= true

)

[inline, virtual]

virtual void osg::ImageStream::rewind

(

)

[inline, virtual]

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::seek

(

double

)

[inline, virtual]

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::setAudioBalance

(

float

)

[inline, virtual]

void osg::ImageStream::setAudioStreams

(

const AudioStreams &

asl

)

[inline]

void osg::ImageStream::setLoopingMode

(

LoopingMode

mode

)

[inline]

virtual void osg::ImageStream::setReferenceTime

(

double

)

[inline, virtual]

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::setTimeMultiplier

(

double

)

[inline, virtual]

Reimplemented in osg::ImageSequence.

virtual void osg::ImageStream::setVolume

(

float

)

[inline, virtual]

---

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:

• osg/ImageStream