com.ajtjp.jImageReader.reader

Class TGAReader

java.lang.Object

javax.imageio.ImageReader

com.ajtjp.jImageReader.reader.TGAReader

All Implemented Interfaces:

JImageReader

public class TGAReader
extends ImageReader
implements JImageReader

Reader for Targa Truevision (.tga) images.

Most TGA variants are supported. Exceptions include 8-bit color mapped images

Author:

Andrew

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLORMAP_NONE
static int	COLORMAP_PRESENT

Fields inherited from class javax.imageio.ImageReader

availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

Constructor Summary

Constructors

Constructor and Description
TGAReader()
TGAReader(ImageReaderSpi originatingProvider)
TGAReader(String string)

Method Summary

Modifier and Type	Method and Description
static boolean	canReadImage(ImageInputStream iis)
void	createBufferedImage() Creates a BufferedImage from the TGA image.
void	exportImage(BufferedImage image, String fileName) Exports a (currently monochrome) TGA image.
int	getHeight() Returns the image's height.
int	getHeight(int imageIndex)
BufferedImage	getImage() Returns the image that the reader has imported.
IIOMetadata	getImageMetadata(int imageIndex)
Iterator<ImageTypeSpecifier>	getImageTypes(int image)
Map<String,String>	getMetadata()
String	getMetadataSummary() Returns a summary of the image's metadata.
int	getNumImages(boolean whatever)
IIOMetadata	getStreamMetadata()
int	getWidth() Returns the image's width.
int	getWidth(int imageIndex)
void	parse()
void	processFile() Processes the file supplied at initialization, and stores the image in the reader.
BufferedImage	read(int imageIndex, ImageReadParam ignored)
void	readFile()
void	readFile(ImageInputStream iis) Reads the TGA file into the buffer.
String	toString()

Methods inherited from class javax.imageio.ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, canReadRaster, checkReadParamBandSettings, clearAbortRequest, computeRegions, dispose, getAspectRatio, getAvailableLocales, getDefaultReadParam, getDestination, getFormatName, getImageMetadata, getInput, getLocale, getMinIndex, getNumThumbnails, getOriginatingProvider, getRawImageType, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, hasThumbnails, isIgnoringMetadata, isImageTiled, isRandomAccessEasy, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, readAll, readAll, readAsRenderedImage, readerSupportsThumbnails, readRaster, readThumbnail, readTile, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, reset, setInput, setInput, setInput, setLocale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COLORMAP_NONE

public static final int COLORMAP_NONE

See Also:

Constant Field Values

COLORMAP_PRESENT

public static final int COLORMAP_PRESENT

See Also:

Constant Field Values

Constructor Detail

TGAReader

public TGAReader()

TGAReader

public TGAReader(ImageReaderSpi originatingProvider)

TGAReader

public TGAReader(String string)

Method Detail

processFile

public void processFile()
                 throws IllegalDataException,
                        UnsupportedVariantException

Description copied from interface: JImageReader

Processes the file supplied at initialization, and stores the image in the reader.

Specified by:

processFile in interface JImageReader

Throws:

IllegalDataException - If the data is not valid for this type of reader.

UnsupportedVariantException - If the supplied file is a variant of the reader's format that is not supported.

readFile

public void readFile()

readFile

public void readFile(ImageInputStream iis)

Reads the TGA file into the buffer. Does not actually do any processing.

Parameters:

iis - The ImageInputStream to read

parse

public void parse()
           throws IllegalDataException,
                  UnsupportedVariantException

Throws:

IllegalDataException

UnsupportedVariantException

createBufferedImage

public void createBufferedImage()

Creates a BufferedImage from the TGA image.

getImage

public BufferedImage getImage()

Description copied from interface: JImageReader

Returns the image that the reader has imported.

Specified by:

getImage in interface JImageReader

Returns:

The image that has been read from the file.

getWidth

public int getWidth()

Description copied from interface: JImageReader

Returns the image's width.

Specified by:

getWidth in interface JImageReader

Returns:

The image's width.

getHeight

public int getHeight()

Description copied from interface: JImageReader

Returns the image's height.

Specified by:

getHeight in interface JImageReader

Returns:

The image's height.

getMetadataSummary

public String getMetadataSummary()

Description copied from interface: JImageReader

Returns a summary of the image's metadata. This will likely not be a String in future releases.

Specified by:

getMetadataSummary in interface JImageReader

Returns:

A summary fo the image's metadata.

getMetadata

public Map<String,String> getMetadata()

toString

public String toString()

Overrides:

toString in class Object

exportImage

public void exportImage(BufferedImage image,
                        String fileName)

Exports a (currently monochrome) TGA image. NOT YET IMPLEMENTED!

Parameters:

image - The image to be exported.

fileName - The name of the file, as it should be written to disk.

read

public BufferedImage read(int imageIndex,
                          ImageReadParam ignored)

Specified by:

read in class ImageReader

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)

Specified by:

getImageMetadata in class ImageReader

getStreamMetadata

public IIOMetadata getStreamMetadata()

Specified by:

getStreamMetadata in class ImageReader

getImageTypes

public Iterator<ImageTypeSpecifier> getImageTypes(int image)

Specified by:

getImageTypes in class ImageReader

getHeight

public int getHeight(int imageIndex)

Specified by:

getHeight in class ImageReader

getWidth

public int getWidth(int imageIndex)

Specified by:

getWidth in class ImageReader

getNumImages

public int getNumImages(boolean whatever)

Specified by:

getNumImages in class ImageReader

canReadImage

public static boolean canReadImage(ImageInputStream iis)