Class for encoding and decoding a TIFF raster image More...
#include <Inventor/image/SoTIFFImageRW.h>
Public Types | |
enum | CompressionMode { NO_COMPRESSION, PACKBITS_COMPRESSION } |
Public Member Functions | |
virtual SoType | getTypeId () const |
SoTIFFImageRW () | |
virtual | ~SoTIFFImageRW () |
virtual SbBool | open (SoRasterImageIO *rasterImageIO, OpenMode openMode) |
virtual SbBool | write (SbRasterImage *rasterImage, unsigned int xPos=0, unsigned int yPos=0) |
virtual SbBool | read (SbRasterImage *rasterImage, SbBool infoOnly=FALSE) |
virtual SbBool | readRegion (SbRasterImage *rasterImage, const SbBox2i32 ®ion) |
void | setCompressionMode (SoTIFFImageRW::CompressionMode compressionMode) |
SoTIFFImageRW::CompressionMode | getCompressionMode () const |
Static Public Member Functions | |
static SoType | getClassTypeId () |
This class is used for encoding and decoding a TIFF raster image.
The writeCapability is WRITE_SCANLINES and isMultipleBufferInverted is TRUE.
See SoRasterImageRW for more information and code examples.
SoRasterImageFile, SoRasterImageRW, SbRasterImage
SoTIFFImageRW::SoTIFFImageRW | ( | ) |
Constructor.
virtual SoTIFFImageRW::~SoTIFFImageRW | ( | ) | [virtual] |
Destructor.
static SoType SoTIFFImageRW::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoRasterImageRW.
SoTIFFImageRW::CompressionMode SoTIFFImageRW::getCompressionMode | ( | ) | const |
Gets the compression mode used for encoding.
virtual SoType SoTIFFImageRW::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoRasterImageRW.
virtual SbBool SoTIFFImageRW::open | ( | SoRasterImageIO * | rasterImageIO, | |
OpenMode | openMode | |||
) | [virtual] |
Opens the reader/writer in the specified open mode.
Returns true if successful.
Reimplemented from SoRasterImageRW.
virtual SbBool SoTIFFImageRW::read | ( | SbRasterImage * | rasterImage, | |
SbBool | infoOnly = FALSE | |||
) | [virtual] |
Reads, decodes, and fills the rasterImage parameter.
If infoOnly is TRUE, then the buffer will not be read; the parameter rasterImage will be set with raster size and raster number of components, the buffer will be NULL.
Implements SoRasterImageRW.
virtual SbBool SoTIFFImageRW::readRegion | ( | SbRasterImage * | rasterImage, | |
const SbBox2i32 & | region | |||
) | [virtual] |
Read the specified region of current open image into rasterImage. Returns true if successful. Call the open() method before calling this method.After calling this method successfully, the size of the SbRasterImage is the requested region size. The requested region may extend outside the source image. In this case, undefined pixels are set to zero. The region may be as small as a single pixel, e.g. (1,1,1,1), but xmin must be <= xmax and ymin <= ymax.
Reimplemented from SoRasterImageRW.
void SoTIFFImageRW::setCompressionMode | ( | SoTIFFImageRW::CompressionMode | compressionMode | ) |
Sets the compression mode to use when encoding the image.
Default compression is PACKBITS_COMPRESSION.
virtual SbBool SoTIFFImageRW::write | ( | SbRasterImage * | rasterImage, | |
unsigned int | xPos = 0 , |
|||
unsigned int | yPos = 0 | |||
) | [virtual] |
Writes and encodes the given data in the specific format.
If you are using the multiple writing mode, then you can specify the offset (with xPos,yPos) you want to write to.
Implements SoRasterImageRW.