ch.hevs.gdx2d.components.bitmaps

Class BitmapImage

java.lang.Object

ch.hevs.gdx2d.components.bitmaps.BitmapImage

All Implemented Interfaces:

Disposable

public final class BitmapImage
extends Object
implements Disposable

An image encapsulation class. Allows to store an image and to use it for drawing.

Version:

1.11

Author:

Nils Chatton (chn), Pierre-André Mudry (mui)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	filePath
protected Texture	image
protected Pixmap	pixmap
protected TextureRegion	tRegion

Constructor Summary

Constructors

Constructor and Description
BitmapImage(String file)

Method Summary

Modifier and Type	Method and Description
void	dispose() Release the resources allocated by this BitmapImage, normally should be called automatically
protected void	finalize()
Color	getColor(int x, int y) Returns the current color of an image
Texture	getImage() Should normally not be used directly, use at your own risk
TextureRegion	getRegion() Should normally not be used directly, use at your own risk
boolean	isContained(int x, int y) Is a given pixel position contained in the image or not The pixel is given in image space (width x height)
boolean	isContained(Vector2 p)
void	mirrorLeftRight() Mirrors the image left <-> right
void	mirrorUpDown() Mirrors the image up <-> down
Vector2	pixelInScreenSpace(Vector2 pixelPosition, Vector2 imagePosition) To get the color of a pixel in an image, we must get translate screen coordinates to image coordinates This is the role of the following function.

Methods inherited from class java.lang.Object

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

Field Detail

image

protected Texture image

tRegion

protected TextureRegion tRegion

filePath

protected String filePath

pixmap

protected Pixmap pixmap

Constructor Detail

BitmapImage

public BitmapImage(String file)

Method Detail

getImage

public Texture getImage()

Should normally not be used directly, use at your own risk

Returns:

A texture

getRegion

public TextureRegion getRegion()

Should normally not be used directly, use at your own risk

Returns:

A #TextureRegion

mirrorLeftRight

public void mirrorLeftRight()

Mirrors the image left <-> right

mirrorUpDown

public void mirrorUpDown()

Mirrors the image up <-> down

isContained

public boolean isContained(Vector2 p)

Parameters:

p - The pixel position, in image space

Returns:

If the pixel can be contained in the image space

See Also:

isContained(int, int)

isContained

public boolean isContained(int x,
                           int y)

Is a given pixel position contained in the image or not The pixel is given in image space (width x height)

Parameters:

x - x-position of the pixel

y - y-position of the pixel

Returns:

if the pixel is contained inside the image

pixelInScreenSpace

public Vector2 pixelInScreenSpace(Vector2 pixelPosition,
                                  Vector2 imagePosition)

To get the color of a pixel in an image, we must get translate screen coordinates to image coordinates This is the role of the following function.

Parameters:

pixelPosition - The pixel we want to read, in screen coordinates

imagePosition - The current position of the image, in screen coordinates

Returns:

The pixel position in the image space coordinates

getColor

public Color getColor(int x,
                      int y)

Returns the current color of an image

Parameters:

x - The x position we want to read

y - The y position we want to read

Returns:

The color read

dispose

public void dispose()

Release the resources allocated by this BitmapImage, normally should be called automatically

Specified by:

dispose in interface Disposable

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable