org.pepsoft.worldpainter.heightMaps

Class DisplacementHeightMap

java.lang.Object

org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

org.pepsoft.worldpainter.heightMaps.DelegatingHeightMap

org.pepsoft.worldpainter.heightMaps.DisplacementHeightMap

All Implemented Interfaces:

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

public class DisplacementHeightMap
extends DelegatingHeightMap

See Also:

Serialized Form

Field Summary

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

children, constant, constantColour, constantValue

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

name, seed

Constructor Summary

Constructors

Constructor and Description
DisplacementHeightMap(HeightMap baseHeightMap, HeightMap angleMap, HeightMap distanceMap)
DisplacementHeightMap(java.lang.String name, HeightMap baseHeightMap, HeightMap angleMap, HeightMap distanceMap)

Method Summary

Modifier and Type	Method and Description
DisplacementHeightMap	clone() Create a deep copy of the height map.
protected int	doGetColour(int x, int y)
protected double	doGetHeight(float x, float y)
HeightMap	getAngleMap()
HeightMap	getBaseHeightMap()
HeightMap	getDistanceMap()
java.awt.Rectangle	getExtent() Get the extent of the height map, if any.
javax.swing.Icon	getIcon() Get a 16x16 icon representing this height map.
double[]	getRange() Get the range of this height map, i.e.
void	setAngleMap(HeightMap angleMap)
void	setBaseHeightMap(HeightMap baseHeightMap)
void	setDistanceMap(HeightMap distanceMap)

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

childrenChanged, determineConstant, doGetHeight, getColour, getConstantValue, getHeight, getHeight, getHeightMap, getHeightMap, getHeightMapCount, getIndex, getIndex, getRole, getSeed, isConstant, readResolve, recalculateConstantValue, replace, replace, setHeightMap, setHeightMap, setSeed

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

getBaseHeight, getName, getParent, setName

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

DisplacementHeightMap

public DisplacementHeightMap(HeightMap baseHeightMap,
                             HeightMap angleMap,
                             HeightMap distanceMap)

DisplacementHeightMap

public DisplacementHeightMap(java.lang.String name,
                             HeightMap baseHeightMap,
                             HeightMap angleMap,
                             HeightMap distanceMap)

Method Detail

getBaseHeightMap

public HeightMap getBaseHeightMap()

getAngleMap

public HeightMap getAngleMap()

getDistanceMap

public HeightMap getDistanceMap()

setAngleMap

public void setAngleMap(HeightMap angleMap)

setBaseHeightMap

public void setBaseHeightMap(HeightMap baseHeightMap)

setDistanceMap

public void setDistanceMap(HeightMap distanceMap)

doGetHeight

protected double doGetHeight(float x,
                             float y)

Overrides:

doGetHeight in class DelegatingHeightMap

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.

doGetColour

protected int doGetColour(int x,
                          int y)

Overrides:

doGetColour in class DelegatingHeightMap

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.

clone

public DisplacementHeightMap clone()

Description copied from interface: HeightMap

Create a deep copy of the height map.

Specified by:

clone in interface HeightMap

Overrides:

clone in class AbstractHeightMap

Returns:

A deep copy of the height map.