IlvTIFFStreamer Class Reference

Bitmap streamer class. More...

#include <ilviews/bitmaps/tiff.h>

Inheritance diagram for IlvTIFFStreamer:

Public Member Functions
	IlvTIFFStreamer ()
	Constructor.
IlBoolean	canRead () const
	Indicates that the instance can read from a stream. More...
IlBoolean	canWrite () const
	Indicates that the instance can write to a stream. More...
IlBoolean	checkSignature (const IlUChar *data, IlUInt size)
	Indicates whether the instance can handle the stream. More...
Compression	getCompression () const
	Returns the compression mode. More...
IlUInt	getRowsPerStrip () const
	Returns The number of rows per strip used when saving. More...
IlBoolean	getTagValue (IlAny identifier, IlUInt tag, IlUInt &count, IlAny value=0)
	Returns the value of a given tag in a stream. More...
IlUInt	getTileHeight () const
	Returns The tile height used when saving. More...
IlUInt	getTileWidth () const
	Returns the tile width used when saving. More...
Mode	getWriteMode () const
	Returns the write mode. More...
virtual IlAny	openStream (ILVSTDPREF istream &stream)
	Opens the stream. More...
IlvBitmapData *	read (ILVSTDPREF istream &stream)
	Reads a TIFF image from a stream. More...
IlvBitmapInformation *	readInfo (ILVSTDPREF istream &stream)
	Reads image information from a stream. More...
IlvBitmapData *	readTile (ILVSTDPREF istream &stream, IlUShort x, IlUShort y)
	Reads a TIFF tile from a stream. More...
void	setCompression (Compression compression)
	Sets the compression mode used when writing. More...
void	setRowsPerStrip (IlUInt rowsperstrip)
	Sets the number of rows per strip used when saving. More...
void	setTileHeight (IlUInt tileheight)
	Sets the tile height used when saving. More...
void	setTileWidth (IlUInt tilewidth)
	Sets the tile width used when saving. More...
void	setWriteMode (Mode mode)
	Sets the write mode. More...
IlBoolean	write (IlvBitmapData *data, ILVSTDPREF ostream &stream)
	Writes an IlvBitmapData to a TIFF stream. More...
virtual void	writeCustomData (IlAny identifier)
	Allows custom data to be written in the stream. More...
IlBoolean	writeTagValue (IlAny identifier, IlUInt tag, IlUInt count, IlAny value=0)
	Writes a tag in the stream. More...
Public Member Functions inherited from IlvBitmapStreamer
virtual void	callReadProgressCallback (IlUInt current, IlUInt max)
	Calls the callback for read progression. More...
virtual void	callWriteProgressCallback (IlUInt current, IlUInt max)
	Calls the callback for write progression. More...
virtual const char *	getName () const
	Returns the internal name of the streamer. More...
IlvQuantizer *	getQuantizer () const
	Returns the quantizer used by this streamer. More...
virtual IlvBitmapData *	read (IL_STDPREF istream &stream)
	Reads from a stream. More...
virtual IlvBitmapInformation *	readInfo (IL_STDPREF istream &stream)
	Reads information from a stream. More...
void	setQuantizer (IlvQuantizer *quantizer)
	Sets the quantizer used (if needed) by this streamer. More...
virtual void	setReadProgressCallback (IlvProgressCallback rCallback, IlAny arg=0)
	Sets the callback for read progression. More...
virtual void	setWriteProgressCallback (IlvProgressCallback wCallback, IlAny arg=0)
	Sets the callback for write progression. More...
virtual IlBoolean	write (IlvBitmapData *bitmapData, IL_STDPREF ostream &stream)
	Writes an IlvBitmapData to a stream. More...
virtual	~IlvBitmapStreamer ()
	Reads a bitmap using the registered streamers. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvBitmapStreamer
static void	Register (IlvBitmapStreamer *streamer)
	Registers the given streamer. More...
static IlBoolean	UnRegister (IlvBitmapStreamer *streamer)
	Unregisters the given streamer. More...
static IlvBitmapStreamer *	Get (const char *name)
	Reads a bitmap using the registered streamers. More...
static IlvBitmap *	Read (IlvDisplay *display, IL_STDPREF istream &stream, const IlUChar *signature, IlUInt signatureLen)
	Reads a bitmap using the registered streamers. More...
static IlvBitmapData *	ReadBitmapData (IL_STDPREF istream &stream, const IlUChar *signature, IlUInt signatureLen)
	Reads bitmap data using the registered streamers. More...
static IlvBitmapInformation *	ReadInfo (IL_STDPREF istream &stream, const IlUChar *signature, IlUInt signatureLen)
	Reads bitmap information using the registered streamers. More...
static IlvBitmapStreamer **	GetRegisteredStreamers (IlUInt &count)
	Returns the registered streamers. More...
static IlBoolean	CheckInModules (const IlUChar *sigbuffer, const IlUChar *filename=0)
	Reads a bitmap using the registered streamers. More...
static	IlListOf (IlvBitmapStreamers)*_Streamers
	Reads a bitmap using the registered streamers. More...
Protected Member Functions inherited from IlvBitmapStreamer
	IlvBitmapStreamer ()
	Reads a bitmap using the registered streamers. More...
Protected Attributes inherited from IlvBitmapStreamer
IlvProgressCallback	_readProgressCallback
	Reads a bitmap using the registered streamers. More...
IlAny	_argr
	Reads a bitmap using the registered streamers. More...
IlvProgressCallback	_writeProgressCallback
	Reads a bitmap using the registered streamers. More...
IlAny	_argw
	Reads a bitmap using the registered streamers. More...
IlvQuantizer *	_quantizer
	Reads a bitmap using the registered streamers. More...

Detailed Description

Bitmap streamer class.

Library: display

This streamer provides methods to deal with a stream containing a TIFF image. This streamer can read and write.

Member Function Documentation

IlBoolean IlvTIFFStreamer::canRead ( ) const

virtual

Indicates that the instance can read from a stream.

Returns

IlTrue.

Reimplemented from IlvBitmapStreamer.

IlBoolean IlvTIFFStreamer::canWrite ( ) const

virtual

Indicates that the instance can write to a stream.

Returns

IlTrue.

Reimplemented from IlvBitmapStreamer.

IlBoolean IlvTIFFStreamer::checkSignature ( const IlUChar *  data, IlUInt  size  )

virtual

Indicates whether the instance can handle the stream.

Parameters

data	The stream signature.
size	The size of the stream signature.

Returns

IlTrue if the instance recognizes the signature.

Implements IlvBitmapStreamer.

Compression IlvTIFFStreamer::getCompression

(

)

const

Returns the compression mode.

Returns

The compression mode.

IlUInt IlvTIFFStreamer::getRowsPerStrip

(

)

const

Returns The number of rows per strip used when saving.

Returns

The number of rows per strip.

IlBoolean IlvTIFFStreamer::getTagValue	(	IlAny	identifier,
		IlUInt	tag,
		IlUInt &	count,
		IlAny	value = 0
	)

Returns the value of a given tag in a stream.

This method must be called between openStream and closeStream. The tag value must be known by the underlying TIFF library. Values must be copied.

Parameters

identifier	The stream identifier.
tag	The tag
count	The number of elements.
value	The tag value.

Returns

IlTrue if the tag is known and its value has been found.

IlUInt IlvTIFFStreamer::getTileHeight

(

)

const

Returns The tile height used when saving.

Returns

The tile height.

IlUInt IlvTIFFStreamer::getTileWidth

(

)

const

Returns the tile width used when saving.

Returns

The tile width.

Mode IlvTIFFStreamer::getWriteMode

(

)

const

Returns the write mode.

Returns

The write mode.

virtual IlAny IlvTIFFStreamer::openStream ( ILVSTDPREF istream &  stream )

virtual

Opens the stream.

Parameters

stream

The stream to open.

Returns

A stream identifier.

IlvBitmapData* IlvTIFFStreamer::read

(

ILVSTDPREF istream &

stream

)

Reads a TIFF image from a stream.

Parameters

stream

The stream to read from.

Returns

An instance of IlvBitmapData.

IlvBitmapInformation* IlvTIFFStreamer::readInfo

(

ILVSTDPREF istream &

stream

)

Reads image information from a stream.

Parameters

stream

The stream to read from.

Returns

An instance of IlvBitmapInformation.

IlvBitmapData* IlvTIFFStreamer::readTile	(	ILVSTDPREF istream &	stream,
		IlUShort	x,
		IlUShort	y
	)

Reads a TIFF tile from a stream.

Parameters

stream	The stream to read from.
x	The horizontal position of the tile.
y	The vertical position of the tile.

Returns

An instance of IlvBitmapData.

void IlvTIFFStreamer::setCompression

(

Compression

compression

)

Sets the compression mode used when writing.

The compression can be one of IlvTIFFstreamer::None, IlvTIFFstreamer::Packbits, or IlvTIFFstreamer::Zip.

Parameters

compression

The new compression mode.

void IlvTIFFStreamer::setRowsPerStrip

(

IlUInt

rowsperstrip

)

Sets the number of rows per strip used when saving.

Parameters

rowsperstrip

The new rows per strip value.

void IlvTIFFStreamer::setTileHeight

(

IlUInt

tileheight

)

Sets the tile height used when saving.

Parameters

tileheight

The new tile height.

void IlvTIFFStreamer::setTileWidth

(

IlUInt

tilewidth

)

Sets the tile width used when saving.

Parameters

tilewidth

The new tile width.

void IlvTIFFStreamer::setWriteMode

(

Mode

mode

)

Sets the write mode.

The mode can be either IlvTIFFStreamer::Tile or IlvTIFFStreamer::Strip.

Parameters

mode	The new write mode.

IlBoolean IlvTIFFStreamer::write	(	IlvBitmapData *	data,
		ILVSTDPREF ostream &	stream
	)

Writes an IlvBitmapData to a TIFF stream.

Parameters

data	The bitmap data to write.
stream	The stream to write to.

Returns

IlTrue if the bitmap data has been written.

virtual void IlvTIFFStreamer::writeCustomData ( IlAny  identifier )

virtual

Allows custom data to be written in the stream.

This method will be called by the write method.

Parameters

identifier

The stream identifier.

IlBoolean IlvTIFFStreamer::writeTagValue	(	IlAny	identifier,
		IlUInt	tag,
		IlUInt	count,
		IlAny	value = 0
	)

Writes a tag in the stream.

Parameters

identifier	The stream identifier.
tag	The tag
count	the number of elements.
value	The tag value.

Returns

IlTrue if the tag is known and its value has been written.