Module org.refcodes.graphical

Package org.refcodes.graphical

Interface Pixmap<PX>

Type Parameters:

PX - The type of the pixel being managed by the Pixmap.

All Superinterfaces:

HeightAccessor, WidthAccessor

All Known Subinterfaces:

Pixmap.PixmapBuilder<PX,B>, Pixmap.PixmapProperty<PX>, RgbPixmap, RgbPixmap.RgbPixmapBuilder, RgbPixmap.RgbPixmapProperty

All Known Implementing Classes:

RgbPixmapBuilderImpl, RgbPixmapImpl

public interface Pixmap<PX>
extends WidthAccessor, HeightAccessor

A pixmap represents the data of a two dimensional image. The pixels may be accessed by providing an x and a y position and, depending on the sub-types, a pixel my be represented by an RgbPixel (as of the Pixmap type).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Pixmap.PixmapBuilder<PX,B extends Pixmap.PixmapBuilder<PX,B>>	Provides a builder method for a pixmap property returning the builder for applying multiple build operations.
static interface	Pixmap.PixmapMutator<PX>	Provides a mutator for a pixmap property.
static interface	Pixmap.PixmapProperty<PX>	Provides a pixmap property.

Nested classes/interfaces inherited from interface org.refcodes.graphical.HeightAccessor

HeightAccessor.HeightBuilder<B extends HeightAccessor.HeightBuilder<B>>, HeightAccessor.HeightMutator, HeightAccessor.HeightProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.WidthAccessor

WidthAccessor.WidthBuilder<B extends WidthAccessor.WidthBuilder<B>>, WidthAccessor.WidthMutator, WidthAccessor.WidthProperty

Method Summary

Modifier and Type	Method	Description
int	getHeight()	Retrieves the height of the Pixmap.
PX	getPixelAt(int aPosX, int aPosY)	Retrieves a pixel at a given position.
PX[][]	getPixels()	Returns the two dimensional pixels array representing the pixmap.
int	getWidth()	Retrieves the width of the Pixmap.
default boolean	hasPixelAt(int aPosX, int aPosY)	Tests whether there is a pixel at a given position.

Method Detail

getPixels

PX[][] getPixels()

Returns the two dimensional pixels array representing the pixmap.

Returns:

The pixmap array.

getWidth

int getWidth()

Retrieves the width of the Pixmap.

Specified by:

getWidth in interface WidthAccessor

Returns:

The width of the Pixmap

getHeight

int getHeight()

Retrieves the height of the Pixmap.

Specified by:

getHeight in interface HeightAccessor

Returns:

The height of the Pixmap

getPixelAt

PX getPixelAt(int aPosX,
              int aPosY)
       throws IndexOutOfBoundsException

Retrieves a pixel at a given position.

Parameters:

aPosX - The x position for the pixel to be retrieved.

aPosY - The y position for the pixel to be retrieved.

Returns:

The according pixel

Throws:

IndexOutOfBoundsException - in case the index is out of bounds.

hasPixelAt

default boolean hasPixelAt(int aPosX,
                           int aPosY)
                    throws IndexOutOfBoundsException

Tests whether there is a pixel at a given position.

Parameters:

aPosX - The x position for the pixel to be tested.

aPosY - The y position for the pixel to be tested.

Returns:

True if we have a pixel at this position.

Throws:

IndexOutOfBoundsException - in case the index is out of bounds.