org.pepsoft.worldpainter.heightMaps

Class CombiningHeightMap

java.lang.Object

org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

org.pepsoft.worldpainter.heightMaps.DelegatingHeightMap

org.pepsoft.worldpainter.heightMaps.CombiningHeightMap

All Implemented Interfaces:

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

Direct Known Subclasses:

DifferenceHeightMap, MaximisingHeightMap, MinimisingHeightMap, ProductHeightMap, SumHeightMap

public abstract class CombiningHeightMap
extends DelegatingHeightMap

An abstract base class for a height map which somehow combines two subordinate height maps.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HeightMap	heightMap1 Deprecated.
protected HeightMap	heightMap2 Deprecated.

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
CombiningHeightMap(HeightMap heightMap1, HeightMap heightMap2)
CombiningHeightMap(java.lang.String name, HeightMap heightMap1, HeightMap heightMap2)

Method Summary

Modifier and Type	Method and Description
abstract CombiningHeightMap	clone() Create a deep copy of the height map.
java.awt.Rectangle	getExtent() Get the extent of the height map, if any.
HeightMap	getHeightMap1()
HeightMap	getHeightMap2()
void	setHeightMap1(HeightMap heightMap1)
void	setHeightMap2(HeightMap heightMap2)

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

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

Field Detail

heightMap1

@Deprecated
protected HeightMap heightMap1

Deprecated.

heightMap2

@Deprecated
protected HeightMap heightMap2

Deprecated.

Constructor Detail

CombiningHeightMap

public CombiningHeightMap(HeightMap heightMap1,
                          HeightMap heightMap2)

CombiningHeightMap

public CombiningHeightMap(java.lang.String name,
                          HeightMap heightMap1,
                          HeightMap heightMap2)

Method Detail

getHeightMap1

public final HeightMap getHeightMap1()

getHeightMap2

public final HeightMap getHeightMap2()

setHeightMap1

public void setHeightMap1(HeightMap heightMap1)

setHeightMap2

public void setHeightMap2(HeightMap heightMap2)

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 abstract CombiningHeightMap 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.