eve.fx

Class ImageObject

java.lang.Object

eve.fx.ImageObject

All Implemented Interfaces:

Drawable, IImage, ImageMaker, ImageData

Direct Known Subclasses:

BufferedImageData, ByteArrayImageData, Drawing, GraphicsImageData, GrayScaleImage, Image, ImageAdapter, ImageSubSection, Picture, PixelBuffer, RotatedImageData

public abstract class ImageObject
extends Object
implements IImage, ImageMaker

This is a base class for a number of other IImage classes. It assumes that the image type is TYPE_ARGB or TYPE_RGB, depending on whether you override usesAlpha() to return true or false.

It also implements getImageScanLines() and setImageScanLines() using

Field Summary

Fields

Modifier and Type	Field and Description
protected Color	background
protected int	height
protected int	width

Fields inherited from interface eve.sys.ImageData

CREATE_OPTION_DONT_SCALE_UP, CREATE_OPTION_IGNORE_ALPHA, CREATE_OPTION_KEEP_ASPECT_RATIO, CREATE_OPTION_ROUGH_SCALING, SCAN_LINE_BYTE_ARRAY, SCAN_LINE_INT_ARRAY, TYPE_ARGB, TYPE_GRAY_SCALE_16, TYPE_GRAY_SCALE_2, TYPE_GRAY_SCALE_256, TYPE_GRAY_SCALE_4, TYPE_INDEXED_16, TYPE_INDEXED_2, TYPE_INDEXED_256, TYPE_INDEXED_4, TYPE_MASK, TYPE_MONO, TYPE_RGB, TYPE_UNKNOWN

Fields inherited from interface eve.fx.Drawable

ACTIVE, DISABLED, INACTIVE, INDENT_ITEM_FLAG, OUTLINED

Constructor Summary

Constructors

Constructor and Description
ImageObject()

Method Summary

Modifier and Type	Method and Description
void	createImageFor(ImageDataInfo imageInfo, Rect interestedArea) This is called at the start of decoding - to let the ImageMaker know the parameters of the image to be created.
void	draw(Graphics g, int x, int y, int width, int height, int options)
void	draw(Graphics g, int x, int y, Rect visibleDestinationArea, int options) Draw the Drawable to the Graphics and specify the area on the graphics that is visible.
void	free()
void	freeImage() Free any resource associated with the ImageData object.
Color	getBackground() This returns a background color if one is set for the image.
Image	getCompatibleImagePoints(double width, double height)
boolean	getDPI(double[] dest) This returns false on an Image.
int	getHeight()
int[]	getImageColorTable() For indexed images, this retrieves the color table as an array of ARGB integers.
ImageData	getImageData() After decoding is done this is used to retrieve the fully decoded image.
int	getImageHeight()
int	getImageScanLineLength() If the scan line type is SCAN_LINE_BYTE_ARRAY then this indicates the number of bytes is needed for one complete scan line.
int	getImageScanLineType() Get the type of scan line used by the image - either SCAN_LINE_BYTE_ARRAY or SCAN_LINE_INT_ARRAY
int	getImageType() This returns one of the TYPE_XXX values
int	getImageWidth()
Object	getNativeDrawable()
protected int[]	getPixelsUsingScanLines(int[] dest, int offset, int x, int y, int width, int height, int rowStride)
protected void	getScanLinesUsingPixels(int startLine, int numLines, Object destArray, int offset, int destScanLineLength) This is a way to implement the ImageData.getImageScanLines() method using the IImage.getPixels() method.
int	getWidth()
boolean	isReadableImage() By default this returns true.
void	scanLinesComplete() This is called once all scan lines are complete.
protected boolean	setPixelsUsingScanLines(int[] source, int offset, int x, int y, int width, int height, int rowStride)
boolean	setScanLinePixels(int scanLine, int[] pixels, int offset, int destX, int destFrequency, int numPixels, int srcFrequency) This is used when decoding images.
protected void	setScanLinesUsingPixels(int startLine, int numLines, Object sourceArray, int offset, int sourceScanLineLength) This is a way to implement the ImageData.setImageScanLines() method using the IImage.setPixels() method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eve.fx.IImage

usesAlpha

Methods inherited from interface eve.sys.ImageData

getImageScanLines, getPixels, isWriteableImage, setImageScanLines, setPixels

Methods inherited from interface eve.fx.Drawable

draw

Field Detail

width

protected int width

height

protected int height

background

protected Color background

Constructor Detail

ImageObject

public ImageObject()

Method Detail

getNativeDrawable

public Object getNativeDrawable()

getBackground

public Color getBackground()

Description copied from interface: IImage

This returns a background color if one is set for the image.

Specified by:

getBackground in interface IImage

getWidth

public int getWidth()

Specified by:

getWidth in interface Drawable

getHeight

public int getHeight()

Specified by:

getHeight in interface Drawable

getImageType

public int getImageType()

Description copied from interface: ImageData

This returns one of the TYPE_XXX values

Specified by:

getImageType in interface ImageData

getImageScanLineType

public int getImageScanLineType()

Description copied from interface: ImageData

Get the type of scan line used by the image - either SCAN_LINE_BYTE_ARRAY or SCAN_LINE_INT_ARRAY

Specified by:

getImageScanLineType in interface ImageData

getImageScanLineLength

public int getImageScanLineLength()

Description copied from interface: ImageData

If the scan line type is SCAN_LINE_BYTE_ARRAY then this indicates the number of bytes is needed for one complete scan line.

Specified by:

getImageScanLineLength in interface ImageData

getImageWidth

public int getImageWidth()

Specified by:

getImageWidth in interface ImageData

getImageHeight

public int getImageHeight()

Specified by:

getImageHeight in interface ImageData

setScanLinesUsingPixels

protected void setScanLinesUsingPixels(int startLine,
                                       int numLines,
                                       Object sourceArray,
                                       int offset,
                                       int sourceScanLineLength)
                                throws IllegalStateException

This is a way to implement the ImageData.setImageScanLines() method using the IImage.setPixels() method. Use this in setImageScanLines() if you have implemented setPixels() correctly.

Parameters:

startLine -

numLines -

sourceArray -

offset -

sourceScanLineLength -

Throws:

IllegalStateException

getScanLinesUsingPixels

protected void getScanLinesUsingPixels(int startLine,
                                       int numLines,
                                       Object destArray,
                                       int offset,
                                       int destScanLineLength)
                                throws IllegalStateException

This is a way to implement the ImageData.getImageScanLines() method using the IImage.getPixels() method. Use this in getImageScanLines() if you have implemented getPixels() correctly.

Parameters:

startLine -

numLines -

sourceArray -

offset -

sourceScanLineLength -

Throws:

IllegalStateException

setPixelsUsingScanLines

protected boolean setPixelsUsingScanLines(int[] source,
                                          int offset,
                                          int x,
                                          int y,
                                          int width,
                                          int height,
                                          int rowStride)

getPixelsUsingScanLines

protected int[] getPixelsUsingScanLines(int[] dest,
                                        int offset,
                                        int x,
                                        int y,
                                        int width,
                                        int height,
                                        int rowStride)

getImageColorTable

public int[] getImageColorTable()

Description copied from interface: ImageData

For indexed images, this retrieves the color table as an array of ARGB integers. If the image type is not TYPE_INDEXED_XXX, then null will be returned.

Specified by:

getImageColorTable in interface ImageData

isReadableImage

public boolean isReadableImage()

By default this returns true.

Specified by:

isReadableImage in interface ImageData

freeImage

public void freeImage()

Description copied from interface: ImageData

Free any resource associated with the ImageData object.

Specified by:

freeImage in interface ImageData

setScanLinePixels

public boolean setScanLinePixels(int scanLine,
                                 int[] pixels,
                                 int offset,
                                 int destX,
                                 int destFrequency,
                                 int numPixels,
                                 int srcFrequency)

This is used when decoding images. For certain interlaced images the pixels on a scan line are not available as a single sequence of pixels, but rather as pixels that are spaced at fixed distances apart on the scan line.

Also scan lines may be presented in a random sequence and multiple times.

Specified by:

setScanLinePixels in interface ImageMaker

Parameters:

interestedArea - the area specified in createImageFor() that the ImageMaker indicated it was interested in.

scanLine - the scan line index (starting at 0) of the full original image being set.

pixels - an array containing the scan line ARGB pixel values.

offset - the start of the pixel within the pixels array.

destX - the x location where the first pixel should be placed.

destFrequency - the distance between the pixels being provided. If this value is 1, then the pixels are actually right next to each other. A value of 2 means that every other pixel is being done.

numPixels - the number of pixels being set.

srcFrequency - the distance between the pixels in the pixels array. This will usually be 1 but may be any other distance.

Returns:

true if the pixels were successfully set.

createImageFor

public void createImageFor(ImageDataInfo imageInfo,
                           Rect interestedArea)
                    throws IllegalArgumentException

Description copied from interface: ImageMaker

This is called at the start of decoding - to let the ImageMaker know the parameters of the image to be created. The minimum this will provide is the width and height of the image - but other information may not be available. No matter what type of image is being decoded the pixels are always provided in ARGB int format using setScanLinePixels.

Specified by:

createImageFor in interface ImageMaker

Parameters:

imageInfo - information on the image to be decoded.

interestedArea - when the method is called this is set to be the full area of the image (0,0,imageWidth,imageHeight). This method can alter this Rect to be a sub-area within the image. In that case the object that is providing pixel data will know that it need not provide pixel data outside that area. However you should not assume that this will strictly be adhered to. It is possible that all pixels for the entire image may still be provided to setScanLinePixels().

Throws:

IllegalArgumentException - if the ImageMaker decides it cannot create the image.

scanLinesComplete

public void scanLinesComplete()

This is called once all scan lines are complete.

Specified by:

scanLinesComplete in interface ImageMaker

getImageData

public ImageData getImageData()

Description copied from interface: ImageMaker

After decoding is done this is used to retrieve the fully decoded image. The ImageDecoder does not call this method.

Specified by:

getImageData in interface ImageMaker

Returns:

the fully decoded image.

free

public void free()

Specified by:

free in interface Drawable

draw

public void draw(Graphics g,
                 int x,
                 int y,
                 int width,
                 int height,
                 int options)

Specified by:

draw in interface Drawable

getDPI

public boolean getDPI(double[] dest)

This returns false on an Image. The DPI of an image is not definable.

getCompatibleImagePoints

public Image getCompatibleImagePoints(double width,
                                      double height)

draw

public void draw(Graphics g,
                 int x,
                 int y,
                 Rect visibleDestinationArea,
                 int options)

Description copied from interface: Drawable

Draw the Drawable to the Graphics and specify the area on the graphics that is visible. The Drawable can thereby reduce its drawing requirements by only drawing the specific portion of itself that would be visible.

Specified by:

draw in interface Drawable

Parameters:

g - the Graphics to draw to.

x - the x-location on the graphics to draw to.

y - the y-location on the graphics to draw to.

visibleDestinationArea - the area that will be updated on the Graphics. If this is null then assume that all of the Drawable must be drawn.

options - any of the Drawable options OR'ed together.