Module org.refcodes.graphical

Package org.refcodes.graphical

Interface Pixmap.PixmapBuilder<PX,B extends Pixmap.PixmapBuilder<PX,B>>

Type Parameters:

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

B - The builder to return in order to be able to apply multiple build operations.

All Superinterfaces:

HeightAccessor, Pixmap<PX>, Pixmap.PixmapMutator<PX>, Pixmap.PixmapProperty<PX>, WidthAccessor

All Known Subinterfaces:

RgbPixmap.RgbPixmapBuilder

All Known Implementing Classes:

RgbPixmapBuilderImpl

Enclosing interface:

Pixmap<PX>

public static interface Pixmap.PixmapBuilder<PX,B extends Pixmap.PixmapBuilder<PX,B>>
extends Pixmap.PixmapProperty<PX>

Provides a builder method for a pixmap property returning the builder for applying multiple build operations.

Nested Class Summary

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.Pixmap

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

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
default void	mergeColorArrays(Pixmap<PX> aSourceColorArray)	Merge color arrays.
default void	mergeWith(B aSourcePixmap, int aSourcePosX, int aSourcePosY, boolean isWrapHorizontically, boolean isWrapVertically, int aDestionationPosX, int aDestionationPosY, int aWidth, int aHeight)	Merges this Pixmap with the provided source Pixmap.
default void	mergeWith(B aSourcePixmap, int aSourcePosX, int aSourcePosY, boolean isWrapHorizontically, boolean isWrapVertically, int aDestinationPosX, int aDestinationPosY, int aWidth, int aHeight, Color aTransparency)	Merges this Pixmap with the provided source Pixmap.
B	withPixelAt(PX aPixel, int aPosX, int aPosY)	Sets the pixmap for the pixmap property.
B	withPixels(PX[][] aPixels)	With pixels.

Methods inherited from interface org.refcodes.graphical.Pixmap

getHeight, getPixelAt, getPixels, getWidth, hasPixelAt

Methods inherited from interface org.refcodes.graphical.Pixmap.PixmapMutator

setPixelAt, setPixels

Methods inherited from interface org.refcodes.graphical.Pixmap.PixmapProperty

letPixels, letRgbAt

Method Detail

mergeWith

default void mergeWith(B aSourcePixmap,
                       int aSourcePosX,
                       int aSourcePosY,
                       boolean isWrapHorizontically,
                       boolean isWrapVertically,
                       int aDestionationPosX,
                       int aDestionationPosY,
                       int aWidth,
                       int aHeight)

Merges this Pixmap with the provided source Pixmap.

Parameters:

aSourcePixmap - The source Pixmap with which to merge.

aSourcePosX - The X position in the source Pixmap from which to start merging.

aSourcePosY - The Y position in the source Pixmap from which to start merging.

isWrapHorizontically - True in case merging is to be continued on the left when reaching the Pixmap bounds on the right.

isWrapVertically - True in case merging is to be continued on the top when reaching the Pixmap bounds on the bottom.

aDestionationPosX - the destionation pos X

aDestionationPosY - the destionation pos Y

aWidth - The merge window's width.

aHeight - The merge window's height.

mergeWith

default void mergeWith(B aSourcePixmap,
                       int aSourcePosX,
                       int aSourcePosY,
                       boolean isWrapHorizontically,
                       boolean isWrapVertically,
                       int aDestinationPosX,
                       int aDestinationPosY,
                       int aWidth,
                       int aHeight,
                       Color aTransparency)

Merges this Pixmap with the provided source Pixmap.

Parameters:

aSourcePixmap - The source Pixmap with which to merge.

aSourcePosX - The X position in the source Pixmap from which to start merging.

aSourcePosY - The Y position in the source Pixmap from which to start merging.

isWrapHorizontically - True in case merging is to be continued on the left when reaching the Pixmap bounds on the right.

isWrapVertically - True in case merging is to be continued on the top when reaching the Pixmap bounds on the bottom.

aDestinationPosX - The X position in the destination Pixmap from which to start merging.

aDestinationPosY - The Y position in the destination Pixmap from which to start merging.

aWidth - The merge window's width.

aHeight - The merge window's height.

aTransparency - The color indicating transparency, null when to be ignored.

mergeColorArrays

default void mergeColorArrays(Pixmap<PX> aSourceColorArray)

Merge color arrays.

Parameters:

aSourceColorArray - the source color array

withPixelAt

B withPixelAt(PX aPixel,
              int aPosX,
              int aPosY)
       throws IndexOutOfBoundsException

Sets the pixmap for the pixmap property.

Parameters:

aPixel - the pixel

aPosX - the pos X

aPosY - the pos Y

Returns:

The builder for applying multiple build operations.

Throws:

IndexOutOfBoundsException - in case the index is out of bounds.

withPixels

B withPixels(PX[][] aPixels)

With pixels.

Parameters:

aPixels - the pixels

Returns:

the b