org.pepsoft.worldpainter.heightMaps

Class ConstantHeightMap

java.lang.Object

org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

org.pepsoft.worldpainter.heightMaps.ConstantHeightMap

All Implemented Interfaces:

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

public final class ConstantHeightMap
extends AbstractHeightMap

See Also:

Serialized Form

Field Summary

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

name, seed

Constructor Summary

Constructors

Constructor and Description
ConstantHeightMap(double height)
ConstantHeightMap(java.lang.String name, double height)

Method Summary

Modifier and Type	Method and Description
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).
double	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.
double[]	getRange() Get the range of this height map, i.e.
boolean	isConstant() Indicate whether the height map is constant, i.e.

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

clone, getBaseHeight, getColour, getExtent, getName, getParent, getSeed, 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

Constructor Detail

ConstantHeightMap

public ConstantHeightMap(double height)

ConstantHeightMap

public ConstantHeightMap(java.lang.String name,
                         double height)

Method Detail

getHeight

public double getHeight()

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.

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

Overrides:

isConstant in class AbstractHeightMap

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

Overrides:

getConstantValue in class AbstractHeightMap

Returns:

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

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

Description copied from interface: HeightMap

Get the range of this height map, i.e. the lowest and highest values it can return, as a double array of size two, with the lower bound in index 0 (which must be equal to HeightMap.getBaseHeight()) and the upper bound in index 1.

Returns:

The range of this height map.