IlvTIFFStreamer Class Reference

Bitmap streamer class. More...

#include <ilviews/bitmaps/tiff.h>

Inheritance diagram for IlvTIFFStreamer:

List of all members.

Public Member Functions
	IlvTIFFStreamer ()
	Constructor.
IlBoolean	canRead () const
	Indicates that the instance can read from a stream.
IlBoolean	canWrite () const
	Indicates that the instance can write to a stream.
IlBoolean	checkSignature (const IlUChar *data, IlUInt size)
	Indicates whether the instance can handle the stream.
Compression	getCompression () const
	Returns the compression mode.
IlUInt	getRowsPerStrip () const
	Returns The number of rows per strip used when saving.
IlBoolean	getTagValue (IlAny identifier, IlUInt tag, IlUInt &count, IlAny value=0)
	Returns the value of a given tag in a stream.
IlUInt	getTileHeight () const
	Returns The tile height used when saving.
IlUInt	getTileWidth () const
	Returns the tile width used when saving.
Mode	getWriteMode () const
	Returns the write mode.
virtual IlAny	openStream (ILVSTDPREF istream &stream)
	Opens the stream.
IlvBitmapData *	read (ILVSTDPREF istream &stream)
	Reads a TIFF image from a stream.
IlvBitmapInformation *	readInfo (ILVSTDPREF istream &stream)
	Reads image information from a stream.
IlvBitmapData *	readTile (ILVSTDPREF istream &stream, IlUShort x, IlUShort y)
	Reads a TIFF tile from a stream.
void	setCompression (Compression compression)
	Sets the compression mode used when writing.
void	setRowsPerStrip (IlUInt rowsperstrip)
	Sets the number of rows per strip used when saving.
void	setTileHeight (IlUInt tileheight)
	Sets the tile height used when saving.
void	setTileWidth (IlUInt tilewidth)
	Sets the tile width used when saving.
void	setWriteMode (Mode mode)
	Sets the write mode.
IlBoolean	write (IlvBitmapData *data, ILVSTDPREF ostream &stream)
	Writes an IlvBitmapData to a TIFF stream.
virtual void	writeCustomData (IlAny identifier)
	Allows custom data to be written in the stream.
IlBoolean	writeTagValue (IlAny identifier, IlUInt tag, IlUInt count, IlAny value=0)
	Writes a tag in the stream.

---

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.