org.pepsoft.worldpainter.heightMaps

Class AbstractHeightMap

java.lang.Object

org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

All Implemented Interfaces:

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

Direct Known Subclasses:

BandedHeightMap, BitmapHeightMap, ConstantHeightMap, DelegatingHeightMap, MandelbrotHeightMap, NinePatchHeightMap, NoiseHeightMap

public abstract class AbstractHeightMap
extends java.lang.Object
implements HeightMap, java.lang.Cloneable, java.io.Serializable

An abstract base class for height maps which provides default implementations of most methods. To implement you must at the very least:

• Override one or both of getHeight(int, int) and getHeight(float, float).
• Implement HeightMap.getRange()
• Implement HeightMap.getIcon()

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
protected long	seed

Constructor Summary

Constructors

Constructor and Description
AbstractHeightMap()
AbstractHeightMap(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
AbstractHeightMap	clone() Create a deep copy of the height map.
double	getBaseHeight() Get the base height of this height map, in other words the lowest value it can have.
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.
double	getConstantValue() If the height map is constant: returns the constant value that would be returned for any location from HeightMap.getHeight(int, int) and HeightMap.getHeight(float, float).
java.awt.Rectangle	getExtent() Get the extent of the height map, if any.
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.
java.lang.String	getName() Get the name of the height map.
DelegatingHeightMap	getParent()
long	getSeed() Get the seed of the height map.
boolean	isConstant() Indicate whether the height map is constant, i.e.
void	setName(java.lang.String name)
void	setSeed(long seed) Set the seed of the height map.

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, getIcon, getRange, minus, minus, plus, plus, scaled, smoothed, times, times

Field Detail

name

protected java.lang.String name

seed

protected long seed

Constructor Detail

AbstractHeightMap

public AbstractHeightMap()

AbstractHeightMap

public AbstractHeightMap(java.lang.String name)

Method Detail

getParent

public DelegatingHeightMap getParent()

getName

public java.lang.String getName()

Description copied from interface: HeightMap

Get the name of the height map.

Specified by:

getName in interface HeightMap

Returns:

The name of the height map.

setName

public void setName(java.lang.String name)

getSeed

public long getSeed()

Description copied from interface: HeightMap

Get the seed of the height map.

Specified by:

getSeed in interface HeightMap

Returns:

The seed of the height map.

setSeed

public void setSeed(long seed)

Description copied from interface: HeightMap

Set the seed of the height map.

Specified by:

setSeed in interface HeightMap

Parameters:

seed - The new seed of the height map.

clone

public AbstractHeightMap clone()

Description copied from interface: HeightMap

Create a deep copy of the height map.

Specified by:

clone in interface HeightMap

Overrides:

clone in class java.lang.Object

Returns:

A deep copy of the height map.

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

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

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.

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

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(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

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.

isConstant

public boolean isConstant()

Description copied from interface: HeightMap

Indicate whether the height map is constant, i.e. it always returns the same value regardless of the location.

Specified by:

isConstant in interface HeightMap

Returns:

true if the height map is constant.

getConstantValue

public double getConstantValue()

Description copied from interface: HeightMap

If the height map is constant: returns the constant value that would be returned for any location from HeightMap.getHeight(int, int) and HeightMap.getHeight(float, float). If the height map is not constant the behaviour is undefined.

Specified by:

getConstantValue in interface HeightMap

Returns:

The constant value of this height map, providing that it is constant according to HeightMap.isConstant().

getBaseHeight

public double getBaseHeight()

Description copied from interface: HeightMap

Get the base height of this height map, in other words the lowest value it can have.

Specified by:

getBaseHeight in interface HeightMap

Returns:

The base height of this height map.