eve.fx

Class ImageAdapter

java.lang.Object

eve.fx.ImageObject

eve.fx.ImageAdapter

All Implemented Interfaces:

Drawable, IImage, ImageMaker, ImageData

Direct Known Subclasses:

RGBImageData

public class ImageAdapter
extends ImageObject

This class is used to provide an IImage interface to an ImageData object. It does not change the type of the ImageData image or its scan line type.

Field Summary

Fields

Modifier and Type	Field and Description
protected ImageData	imageData

Fields inherited from class eve.fx.ImageObject

background, height, 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
ImageAdapter() You must call the set() method after calling this.
ImageAdapter(ImageData id)

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics g, int x, int y, int options)
static IImage	drawableToIImage(Drawable d, PixelBuffer reuse)
static void	drawRGB(ImageData image, Graphics g, int x, int y, boolean useAlpha)
void	free() This frees resources associated with this ImageAdapter only, not the original ImageData.
int[]	getImageColorTable() For indexed images, this retrieves the color table as an array of ARGB integers.
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.
void	getImageScanLines(int startLine, int numLines, Object destArray, int offset, int destScanLineLength) Place a set of scan lines into a destination array.
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[]	getPixels(int[] dest, int offset, int x, int y, int width, int height, int rowStride) Retrieve the pixels from the Image in encoded ARGB values.
boolean	isReadableImage() By default this returns true.
boolean	isWriteableImage() Returns if you can write data to the ImageData.
void	set(ImageData newImageData)
void	setImageScanLines(int startLine, int numLines, Object sourceArray, int offset, int sourceScanLineLength) Place a set of scan lines from a source Array into the ImageData.
boolean	setPixels(int[] src, int offset, int x, int y, int width, int height, int rowStride) Set the pixels in the IImage in encoded ARGB values.
static IImage	toIImage(ImageData id, ImageAdapter reuseWrapper)
boolean	usesAlpha() Returns whether the image uses the Alpha channel.

Methods inherited from class eve.fx.ImageObject

createImageFor, draw, draw, freeImage, getBackground, getCompatibleImagePoints, getDPI, getHeight, getImageData, getImageHeight, getImageWidth, getNativeDrawable, getPixelsUsingScanLines, getScanLinesUsingPixels, getWidth, scanLinesComplete, setPixelsUsingScanLines, setScanLinePixels, setScanLinesUsingPixels

Methods inherited from class java.lang.Object

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

Field Detail

imageData

protected ImageData imageData

Constructor Detail

ImageAdapter

public ImageAdapter()

You must call the set() method after calling this.

ImageAdapter

public ImageAdapter(ImageData id)

Method Detail

drawableToIImage

public static IImage drawableToIImage(Drawable d,
                                      PixelBuffer reuse)

toIImage

public static IImage toIImage(ImageData id,
                              ImageAdapter reuseWrapper)

set

public void set(ImageData newImageData)

drawRGB

public static void drawRGB(ImageData image,
                           Graphics g,
                           int x,
                           int y,
                           boolean useAlpha)

draw

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

free

public void free()

This frees resources associated with this ImageAdapter only, not the original ImageData.

Specified by:

free in interface Drawable

Overrides:

free in class ImageObject

See Also:

Drawable.free()

getPixels

public int[] getPixels(int[] dest,
                       int offset,
                       int x,
                       int y,
                       int width,
                       int height,
                       int rowStride)

Description copied from interface: ImageData

Retrieve the pixels from the Image in encoded ARGB values. If the usesAlpha() method returns false, then the A component of each pixel value (the top 8 bits) should be ignored.

Parameters:

dest - The destination int array. If this is null then a new array should be created.

offset - The offset into the array to start placing pixels.

x - the x co-ordinate within the image.

y - the y co-ordinate within the image.

width - the width of the pixel block to get.

height - the height of the pixel block to get.

rowStride - the number of int values between each row in the destination int array. If this is 0 it will be assumed to be equal to width.

Returns:

The array containing the pixels, or null if getting pixels is not supported.

usesAlpha

public boolean usesAlpha()

Description copied from interface: IImage

Returns whether the image uses the Alpha channel.

getImageType

public int getImageType()

Description copied from interface: ImageData

This returns one of the TYPE_XXX values

Specified by:

getImageType in interface ImageData

Overrides:

getImageType in class ImageObject

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

Overrides:

getImageScanLineType in class ImageObject

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

Overrides:

getImageScanLineLength in class ImageObject

getImageScanLines

public void getImageScanLines(int startLine,
                              int numLines,
                              Object destArray,
                              int offset,
                              int destScanLineLength)
                       throws IllegalStateException

Description copied from interface: ImageData

Place a set of scan lines into a destination array. The type of the destination array must be either byte[] or int[] depending on the value of getImageScanLineType().

Throws:

IllegalStateException

setImageScanLines

public void setImageScanLines(int startLine,
                              int numLines,
                              Object sourceArray,
                              int offset,
                              int sourceScanLineLength)
                       throws IllegalStateException

Description copied from interface: ImageData

Place a set of scan lines from a source Array into the ImageData. The type of the destination array must be either byte[] or int[] depending on the value of getImageScanLineType().

Throws:

IllegalStateException

isWriteableImage

public boolean isWriteableImage()

Description copied from interface: ImageData

Returns if you can write data to the ImageData.

isReadableImage

public boolean isReadableImage()

Description copied from class: ImageObject

By default this returns true.

Specified by:

isReadableImage in interface ImageData

Overrides:

isReadableImage in class ImageObject

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

Overrides:

getImageColorTable in class ImageObject

setPixels

public boolean setPixels(int[] src,
                         int offset,
                         int x,
                         int y,
                         int width,
                         int height,
                         int rowStride)

Description copied from interface: ImageData

Set the pixels in the IImage in encoded ARGB values. If the usesAlpha() method returns false, then the A component of each pixel value (the top 8 bits) will be ignored.

Parameters:

src - The source int array.

offset - The offset into the array to start retrieving pixels.

x - the x co-ordinate within the image.

y - the y co-ordinate within the image.

width - the width of the pixel block to get.

height - the height of the pixel block to get.

rowStride - the number of int values between each row in the source int array. If this is 0 it will be assumed to be equal to width.

Returns:

true if setting pixel values is supported, false if not.