org.pepsoft.worldpainter.heightMaps

Class BitmapHeightMap

java.lang.Object

org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

org.pepsoft.worldpainter.heightMaps.BitmapHeightMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, HeightMap

public final class BitmapHeightMap
extends AbstractHeightMap

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BitmapHeightMap.BitmapHeightMapBuilder

Field Summary

Fields inherited from class org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

name, seed

Method Summary

Modifier and Type	Method and Description
static BitmapHeightMap.BitmapHeightMapBuilder	build()
int	getBitDepth()
int	getChannel()
int	getColour(int x, int y) Get the colour of the height map at a particular location as a combined RGB value consisting of the red component in bits 16-23, the green component in bits 8-15, and the blue component in bits 0-7.
java.awt.Rectangle	getExtent() Get the extent of the height map, if any.
int	getHeight()
double	getHeight(float x, float y) Get the height of the height map at a particular location.
double	getHeight(int x, int y) Get the height of the height map at a particular location.
javax.swing.Icon	getIcon() Get a 16x16 icon representing this height map.
java.awt.image.BufferedImage	getImage()
java.io.File	getImageFile()
double	getMaxHeight() Get the theoretical maximum value as determined by the image format, regardless of the actual maximum value.
double	getMinHeight() Get the theoretical minimum value as determined by the image format, regardless of the actual minimum value.
double[]	getRange() Get the actual minimum and maximum values contained in the image data.
int	getWidth()
boolean	hasAlpha()
boolean	isFloatingPoint()
boolean	isRepeat()
boolean	isSigned()

Methods inherited from class org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

clone, getBaseHeight, getConstantValue, getName, getParent, getSeed, isConstant, setName, setSeed

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepsoft.worldpainter.HeightMap

clamped, minus, minus, plus, plus, scaled, smoothed, times, times

Method Detail

getImage

public java.awt.image.BufferedImage getImage()

getChannel

public int getChannel()

isRepeat

public boolean isRepeat()

getWidth

public int getWidth()

getHeight

public int getHeight()

getMinHeight

public double getMinHeight()

Get the theoretical minimum value as determined by the image format, regardless of the actual minimum value.

getMaxHeight

public double getMaxHeight()

Get the theoretical maximum value as determined by the image format, regardless of the actual maximum value.

isFloatingPoint

public boolean isFloatingPoint()

getBitDepth

public int getBitDepth()

hasAlpha

public boolean hasAlpha()

isSigned

public boolean isSigned()

getHeight

public double getHeight(int x,
                        int y)

Description copied from interface: HeightMap

Get the height of the height map at a particular location.

Specified by:

getHeight in interface HeightMap

Overrides:

getHeight in class AbstractHeightMap

Parameters:

x - The X coordinate of the location of which to get the height.

y - The Y coordinate of the location of which to get the height.

Returns:

The height at the specified location.

getHeight

public double getHeight(float x,
                        float y)

Description copied from interface: HeightMap

Get the height of the height map at a particular location.

Specified by:

getHeight in interface HeightMap

Overrides:

getHeight in class AbstractHeightMap

Parameters:

x - The X coordinate of the location of which to get the height.

y - The Y coordinate of the location of which to get the height.

Returns:

The height at the specified location.

getExtent

public java.awt.Rectangle getExtent()

Description copied from interface: HeightMap

Get the extent of the height map, if any. The extent is the area it covers and for which it can return meaningful values. A height map may be unbounded in which case this should return null.

Specified by:

getExtent in interface HeightMap

Overrides:

getExtent in class AbstractHeightMap

Returns:

The extent of the height map, or null if it is unbounded.

getColour

public int getColour(int x,
                     int y)

Description copied from interface: HeightMap

Get the colour of the height map at a particular location as a combined RGB value consisting of the red component in bits 16-23, the green component in bits 8-15, and the blue component in bits 0-7.

Specified by:

getColour in interface HeightMap

Overrides:

getColour in class AbstractHeightMap

Parameters:

x - The X coordinate of the location of which to get the colour.

y - The Y coordinate of the location of which to get the colour.

Returns:

The colour at the specified location.

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: HeightMap

Get a 16x16 icon representing this height map.

Returns:

A 16x16 icon representing this height map.

getRange

public double[] getRange()

Get the actual minimum and maximum values contained in the image data.

Returns:

The range of this height map.

getImageFile

public java.io.File getImageFile()

build

public static BitmapHeightMap.BitmapHeightMapBuilder build()