com.openinventor.inventor.image

Class SoTIFFImageRW

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.image.SoRasterImageRW

com.openinventor.inventor.image.SoTIFFImageRW

public class SoTIFFImageRW
extends SoRasterImageRW

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.

See also:

SoRasterImageFile, SoRasterImageRW, SbRasterImage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoTIFFImageRW.CompressionModes CompressionMode.

Nested classes/interfaces inherited from class com.openinventor.inventor.image.SoRasterImageRW

SoRasterImageRW.OpenModes, SoRasterImageRW.ReadCapabilities, SoRasterImageRW.WriteCapabilities

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_COMPRESSION Deprecated. Use SoTIFFImageRW.CompressionModes.NO_COMPRESSION instead.
static int	PACKBITS_COMPRESSION Deprecated. Use SoTIFFImageRW.CompressionModes.PACKBITS_COMPRESSION instead.

Fields inherited from class com.openinventor.inventor.image.SoRasterImageRW

OPEN_READ, OPEN_WRITE, READ_AVAILABLE, READ_UNAVAILABLE, WRITE_FULL_IMAGE, WRITE_SCANLINES, WRITE_UNAVAILABLE

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoTIFFImageRW() Constructor.

Method Summary

Modifier and Type	Method and Description
SoTIFFImageRW.CompressionModes	getCompressionMode() Gets the compression mode used for encoding.
boolean	read(SbRasterImage rasterImage, long imageIndex) Calls read(rasterImage, imageIndex, false).
boolean	read(SbRasterImage rasterImage, long imageIndex, boolean infoOnly) Read the current open image into rasterImage.
boolean	readRegion(SbRasterImage rasterImage, long imageIndex, SbBox2i32 region) Read the specified region of current open image into rasterImage.
void	setCompressionMode(SoTIFFImageRW.CompressionModes compressionMode) Sets the compression mode to use when encoding the image.

Methods inherited from class com.openinventor.inventor.image.SoRasterImageRW

checkRead, close, enableMultipleWriting, getReadCapability, getWriteCapability, isMultipleBufferInverted, isMultipleWritingEnabled, open, read, read, readRegion, write, write, write, writeFooter, writeHeader, writeHeader

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_COMPRESSION

@Deprecated
public static final int NO_COMPRESSION

Deprecated. Use SoTIFFImageRW.CompressionModes.NO_COMPRESSION instead.

PACKBITS_COMPRESSION

@Deprecated
public static final int PACKBITS_COMPRESSION

Deprecated. Use SoTIFFImageRW.CompressionModes.PACKBITS_COMPRESSION instead.

Constructor Detail

SoTIFFImageRW

public SoTIFFImageRW()

Constructor.

Method Detail

read

public boolean read(SbRasterImage rasterImage,
                    long imageIndex)

Calls read(rasterImage, imageIndex, false).

read

public boolean read(SbRasterImage rasterImage,
                    long imageIndex,
                    boolean infoOnly)

Read the current open image into rasterImage. Returns true if successful. Call the open() method before calling this method.

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.

getCompressionMode

public SoTIFFImageRW.CompressionModes getCompressionMode()

Gets the compression mode used for encoding.

setCompressionMode

public void setCompressionMode(SoTIFFImageRW.CompressionModes compressionMode)

Sets the compression mode to use when encoding the image. Default compression is PACKBITS_COMPRESSION.

readRegion

public boolean readRegion(SbRasterImage rasterImage,
                          long imageIndex,
                          SbBox2i32 region)

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.