org.refcodes.graphical

Class RgbPixmapImpl

java.lang.Object

org.refcodes.graphical.RgbPixmapImpl

All Implemented Interfaces:

Pixmap<RgbPixel>, RgbPixmap

Direct Known Subclasses:

RgbPixmapImpl.RgbPixmapPropertyBuilderImpl

public class RgbPixmapImpl
extends Object
implements RgbPixmap

The Class RgbPixmapImpl.

Author:

steiner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RgbPixmapImpl.RgbPixmapPropertyBuilderImpl The Class RgbPixmapPropertyBuilderImpl.

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

RgbPixmap.RgbPixmapBuilder<B extends RgbPixmap.RgbPixmapBuilder<B>>, RgbPixmap.RgbPixmapMutator, RgbPixmap.RgbPixmapProperty, RgbPixmap.RgbPixmapPropertyBuilder

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

Pixmap.PixmapBuilder<PX,B extends Pixmap.PixmapBuilder<PX,B>>, Pixmap.PixmapMutator<PX>, Pixmap.PixmapProperty<PX>, Pixmap.PixmapPropertyBuilder<PX,B extends Pixmap.PixmapPropertyBuilder<PX,B>>

Field Summary

Fields

Modifier and Type	Field and Description
protected RgbPixel[][]	_pixels

Constructor Summary

Constructors

Constructor and Description
RgbPixmapImpl() Instantiates a new rgb pixmap impl.
RgbPixmapImpl(int aWidth, int aHeight) Instantiates a new rgb pixmap impl.
RgbPixmapImpl(RgbPixel[][] aPixels) Instantiates a new rgb pixmap impl.

Method Summary

Modifier and Type	Method and Description
RgbPixel	getPixelAt(int aPosX, int aPosY) Retrieves a pixel at a given position.
RgbPixel[][]	getPixels() Returns the two dimensional pixels array representing the pixmap.
int	getPixmapHeight() Retrieves the height of the Pixmap.
int	getPixmapWidth() Retrieves the width of the Pixmap.

Methods inherited from class java.lang.Object

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

Field Detail

_pixels

protected RgbPixel[][] _pixels

Constructor Detail

RgbPixmapImpl

public RgbPixmapImpl()

Instantiates a new rgb pixmap impl.

RgbPixmapImpl

public RgbPixmapImpl(RgbPixel[][] aPixels)

Instantiates a new rgb pixmap impl.

Parameters:

aPixels - the pixels

RgbPixmapImpl

public RgbPixmapImpl(int aWidth,
                     int aHeight)

Instantiates a new rgb pixmap impl.

Parameters:

aWidth - the width

aHeight - the height

Method Detail

getPixels

public RgbPixel[][] getPixels()

Returns the two dimensional pixels array representing the pixmap.

Specified by:

getPixels in interface Pixmap<RgbPixel>

Returns:

The pixmap array.

getPixmapWidth

public int getPixmapWidth()

Retrieves the width of the Pixmap.

Specified by:

getPixmapWidth in interface Pixmap<RgbPixel>

Returns:

The width of the Pixmap

getPixmapHeight

public int getPixmapHeight()

Retrieves the height of the Pixmap.

Specified by:

getPixmapHeight in interface Pixmap<RgbPixel>

Returns:

The height of the Pixmap

getPixelAt

public RgbPixel getPixelAt(int aPosX,
                           int aPosY)
                    throws IndexOutOfBoundsException

Retrieves a pixel at a given position.

Specified by:

getPixelAt in interface Pixmap<RgbPixel>

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.