Class for encoding and decoding a TIFF raster image More...
#include <Inventor/image/SoTIFFImageRW.h>
Public Types | |
enum | CompressionMode { NO_COMPRESSION , PACKBITS_COMPRESSION } |
CompressionMode. More... | |
Public Types inherited from SoRasterImageRW | |
enum | WriteCapability { WRITE_SCANLINES , WRITE_FULL_IMAGE , WRITE_UNAVAILABLE } |
Write Capability enumeration values. More... | |
enum | ReadCapability { READ_AVAILABLE , READ_UNAVAILABLE } |
Read Capability enumeration values. More... | |
enum | OpenMode { OPEN_READ , OPEN_WRITE } |
open Mode enumeration values. More... | |
Public Member Functions | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
SoTIFFImageRW () | |
Constructor. | |
virtual | ~SoTIFFImageRW () |
Destructor. | |
virtual SbBool | open (SoRasterImageIO *rasterImageIO, OpenMode openMode) |
Opens the reader/writer in the specified open mode. | |
virtual SbBool | write (SbRasterImage *rasterImage, unsigned int xPos=0, unsigned int yPos=0) |
Writes and encodes the given data in the specific format. | |
virtual SbBool | read (SbRasterImage *rasterImage, SbBool infoOnly=FALSE) |
Reads, decodes, and fills the rasterImage parameter. | |
virtual SbBool | readRegion (SbRasterImage *rasterImage, const SbBox2i32 ®ion) |
Read the specified region of current open image into rasterImage. | |
void | setCompressionMode (SoTIFFImageRW::CompressionMode compressionMode) |
Sets the compression mode to use when encoding the image. | |
SoTIFFImageRW::CompressionMode | getCompressionMode () const |
Gets the compression mode used for encoding. | |
Public Member Functions inherited from SoRasterImageRW | |
virtual | ~SoRasterImageRW () |
Destructor. | |
virtual void | close () |
Closes the reader/writer. | |
virtual SbBool | checkRead (SoRasterImageFile *imageFile) |
Checks if the specified file can be read. | |
virtual SbBool | writeHeader (const SbVec2i32 &size) |
Writes and encodes the header for this specific format. | |
virtual SbBool | writeFooter () |
Writes and encodes the footer for this specific format. | |
virtual SbString * | getSuffixes (int &numSuffixes) const |
Returns the list of file suffixes supported. | |
virtual SbBool | isMultipleBufferInverted () const |
Returns the write order when using multiple buffers. | |
virtual SoRasterImageRW::WriteCapability | getWriteCapability () const |
Returns the write capability of the raster format. | |
virtual SoRasterImageRW::ReadCapability | getReadCapability () const |
Returns the read capability of the raster format. | |
virtual void | enableMultipleWriting (SbBool state) |
Enable writing image with multiple calls to write method. | |
virtual SbBool | isMultipleWritingEnabled () const |
Returns TRUE if multiple buffer writing is enabled. | |
virtual SoDEPRECATED SbBool | writeHeader (SbVec2i32 &size) |
Writes and encodes the header for this specific format. | |
virtual SoDEPRECATED SbBool | writeHeader (SbVec2s &size) |
Writes and encodes the header for this specific format. | |
Static Public Member Functions | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Static Public Member Functions inherited from SoRasterImageRW | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Class for encoding and decoding a TIFF raster image
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
Definition at line 51 of file SoTIFFImageRW.h.
CompressionMode.
Enumerator | |
---|---|
NO_COMPRESSION | No compression. |
PACKBITS_COMPRESSION | Default compression. |
Definition at line 59 of file SoTIFFImageRW.h.
SoTIFFImageRW::SoTIFFImageRW | ( | ) |
Constructor.
|
virtual |
Destructor.
|
static |
Returns the type identifier for this class.
SoTIFFImageRW::CompressionMode SoTIFFImageRW::getCompressionMode | ( | ) | const |
Gets the compression mode used for encoding.
|
virtual |
Returns the type identifier for this specific instance.
Implements SoRasterImageRW.
|
virtual |
Opens the reader/writer in the specified open mode.
Returns true if successful.
Reimplemented from SoRasterImageRW.
|
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 |
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 |
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.