eve.fx

Class RGBImageData

java.lang.Object

eve.fx.ImageObject

eve.fx.ImageAdapter

eve.fx.RGBImageData

All Implemented Interfaces:

Drawable, IImage, ImageMaker, ImageData

public class RGBImageData
extends ImageAdapter
implements IImage

This class can be used to wrap up an ImageData of any type to act as an ImageData of type TYPE_ARGB or TYPE_RGB and which uses int[] scan lines. It also provides an IImage interface for the ImageData.

Field Summary

Fields inherited from class eve.fx.ImageAdapter

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
RGBImageData() If you use this constructor, make sure you call the set() method before using any of the other methods.
RGBImageData(ImageData image)

Method Summary

Modifier and Type	Method and Description
static boolean	actsAsRGBImageData(ImageData image) Return true if the specified ImageData acts in the same way that an RGBImageData would act.
void	free() This only frees this Object's local data - it does not free the Image the RGBImage wraps.
int[]	getImageColorTable() This always returns null.
int	getImageScanLineLength() This always returns the width of the original image.
void	getImageScanLines(int startLine, int numLines, Object destArray, int offset, int destScanLineLength) Get the image scan lines, always as ARGB integer values.
int	getImageScanLineType() This always returns SCAN_LINE_INT_ARRAY;
int	getImageType() This returns either TYPE_ARGB or TYPE_RGB.
void	setImageScanLines(int startLine, int numLines, Object sourceArray, int offset, int sourceScanLineLength) Set the image scan lines, always as ARGB integer values.
static ImageData	toImageData(ImageData image, RGBImageData wrapper) If the specified Image implements RGBImageData in exactly the same way as an RGBImageData does, then return the Image itself.

Methods inherited from class eve.fx.ImageAdapter

draw, drawableToIImage, drawRGB, getPixels, isReadableImage, isWriteableImage, set, setPixels, toIImage, usesAlpha

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

Methods inherited from interface eve.fx.IImage

getBackground, usesAlpha

Methods inherited from interface eve.sys.ImageData

freeImage, getImageHeight, getImageWidth, getPixels, isReadableImage, isWriteableImage, setPixels

Methods inherited from interface eve.fx.Drawable

draw, draw, draw, getHeight, getWidth

Constructor Detail

RGBImageData

public RGBImageData()

If you use this constructor, make sure you call the set() method before using any of the other methods.

RGBImageData

public RGBImageData(ImageData image)

Method Detail

actsAsRGBImageData

public static boolean actsAsRGBImageData(ImageData image)

Return true if the specified ImageData acts in the same way that an RGBImageData would act. That is, its type is TYPE_RGB or TYPE_ARGB, and it uses scan lines of type int[], and its scan line length is equal to its width.

toImageData

public static ImageData toImageData(ImageData image,
                                    RGBImageData wrapper)

If the specified Image implements RGBImageData in exactly the same way as an RGBImageData does, then return the Image itself. Otherwise return the image wrapped in an RGBImageData object - using the provided wrapper object if it is not null.

getImageType

public int getImageType()

This returns either TYPE_ARGB or TYPE_RGB.

Specified by:

getImageType in interface ImageData

Overrides:

getImageType in class ImageAdapter

getImageScanLineType

public int getImageScanLineType()

This always returns SCAN_LINE_INT_ARRAY;

Specified by:

getImageScanLineType in interface ImageData

Overrides:

getImageScanLineType in class ImageAdapter

getImageScanLineLength

public int getImageScanLineLength()

This always returns the width of the original image.

Specified by:

getImageScanLineLength in interface ImageData

Overrides:

getImageScanLineLength in class ImageAdapter

getImageScanLines

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

Get the image scan lines, always as ARGB integer values.

Specified by:

getImageScanLines in interface ImageData

Overrides:

getImageScanLines in class ImageAdapter

setImageScanLines

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

Set the image scan lines, always as ARGB integer values.

Specified by:

setImageScanLines in interface ImageData

Overrides:

setImageScanLines in class ImageAdapter

Throws:

IllegalStateException

getImageColorTable

public int[] getImageColorTable()

This always returns null.

Specified by:

getImageColorTable in interface ImageData

Overrides:

getImageColorTable in class ImageAdapter

free

public void free()

This only frees this Object's local data - it does not free the Image the RGBImage wraps.

Specified by:

free in interface Drawable

Overrides:

free in class ImageAdapter

See Also:

Drawable.free()