org.pepsoft.worldpainter.heightMaps

Class SlopeHeightMap

java.lang.Object

org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

org.pepsoft.worldpainter.heightMaps.DelegatingHeightMap

org.pepsoft.worldpainter.heightMaps.SlopeHeightMap

All Implemented Interfaces:

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

public class SlopeHeightMap
extends DelegatingHeightMap

A height map which calculates the slope of an underlying height map, in degrees from 0 to 90.

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
SlopeHeightMap(HeightMap baseHeightMap)
SlopeHeightMap(HeightMap baseHeightMap, float verticalScaling)
SlopeHeightMap(HeightMap baseHeightMap, float verticalScaling, java.lang.String name)
SlopeHeightMap(HeightMap baseHeightMap, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
SlopeHeightMap	clone() Create a deep copy of the height map.
protected double	doGetHeight(float x, float y)
HeightMap	getBaseHeightMap()
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.
float	getVerticalScaling()
void	setBaseHeightMap(HeightMap baseHeightMap)
void	setVerticalScaling(float verticalScaling)

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

childrenChanged, determineConstant, doGetColour, 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

SlopeHeightMap

public SlopeHeightMap(HeightMap baseHeightMap)

SlopeHeightMap

public SlopeHeightMap(HeightMap baseHeightMap,
                      java.lang.String name)

SlopeHeightMap

public SlopeHeightMap(HeightMap baseHeightMap,
                      float verticalScaling)

SlopeHeightMap

public SlopeHeightMap(HeightMap baseHeightMap,
                      float verticalScaling,
                      java.lang.String name)

Method Detail

getBaseHeightMap

public HeightMap getBaseHeightMap()

setBaseHeightMap

public void setBaseHeightMap(HeightMap baseHeightMap)

getVerticalScaling

public float getVerticalScaling()

setVerticalScaling

public void setVerticalScaling(float verticalScaling)

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.

clone

public SlopeHeightMap 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.

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.