com.github.brunothg.game.engine.image

Class NinePatchImage

java.lang.Object

com.github.brunothg.game.engine.image.NinePatchImage

All Implemented Interfaces:

Image

public class NinePatchImage
extends Object
implements Image

This class represents a nine pitch image. Such an image contains a 1px border. Black pixel(Color.BLACK ) at the left or top border indicate the stretch regions. Relative size of multiple regions will be kept.

Author:

Marvin Bruns

Constructor Summary

Constructors

Constructor and Description
NinePatchImage(BufferedImage src) Crates a new stretchable image from a nine patch image.

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics2D g, int width, int height) Draws the image on a given Graphics2D object
BufferedImage	getImage(int width, int height)
Insets	getInsets() Get the Insets specified by the underlying nine patch source image.
Size	getNaturalSize() Get the natural minimum size of this image.
int	getQuality() Get the used interpolation quality.
Size	getSize() Get the original size of the image
Size	getSourceSize() Get the source size of this image.
boolean	isHorizontalStretachable() Get the capability to stretch this image in horizontal direction.
boolean	isVerticalStretachable() Get the capability to stretch this image in vertical direction.
void	setQuality(int quality) Set the interpolation quality values from 0 to 2 are allowed.

Methods inherited from class java.lang.Object

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

Constructor Detail

NinePatchImage

public NinePatchImage(BufferedImage src)

Crates a new stretchable image from a nine patch image. The data array is shared (consider creating a copy of the image).

Parameters:

src - The shared source image

See Also:

BufferedImage.getSubimage(int, int, int, int)

Method Detail

draw

public void draw(Graphics2D g,
                 int width,
                 int height)

Description copied from interface: Image

Draws the image on a given Graphics2D object

Specified by:

draw in interface Image

Parameters:

g - The graphics object to draw the image on

width - The width to use for drawing

height - The height to use for drawing

getImage

public BufferedImage getImage(int width,
                              int height)

isHorizontalStretachable

public boolean isHorizontalStretachable()

Get the capability to stretch this image in horizontal direction.

Returns:

true, if this image can be stretched in horizontal direction

isVerticalStretachable

public boolean isVerticalStretachable()

Get the capability to stretch this image in vertical direction.

Returns:

true, if this image can be stretched in vertical direction

getNaturalSize

public Size getNaturalSize()

Get the natural minimum size of this image. Natural means the pixel of the image, that aren't marked as stretch area.

Returns:

The natural minimum size

getInsets

public Insets getInsets()

Get the Insets specified by the underlying nine patch source image.

Returns:

The Insets specified by the nine patch source image

getSourceSize

public Size getSourceSize()

Get the source size of this image. The source size is the size the underlying image provides without the patch indicator border. This results in the a size of:

src.getWidth() - 2, src.getHeight() - 2

As the insets are returned as absolute values calculated with the source size you can calculate the relative insets with the source size.

Returns:

The source size of this image

getSize

public Size getSize()

Description copied from interface: Image

Get the original size of the image

Specified by:

getSize in interface Image

Returns:

The original size of the image

See Also:

getSourceSize(), Image.getSize()

getQuality

public int getQuality()

Get the used interpolation quality.

Returns:

The used interpolation quality

setQuality

public void setQuality(int quality)

Set the interpolation quality values from 0 to 2 are allowed. Values out of the range will be increased/decreased to fit the range.

Parameters:

quality - Interpolation quality