org.pepsoft.worldpainter.heightMaps

Class TransformingHeightMap

java.lang.Object

org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

org.pepsoft.worldpainter.heightMaps.DelegatingHeightMap

org.pepsoft.worldpainter.heightMaps.TransformingHeightMap

All Implemented Interfaces:

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

public class TransformingHeightMap
extends DelegatingHeightMap

A height map which scales and/or translates another height map

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransformingHeightMap.TransformingHeightMapBuilder

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
TransformingHeightMap(java.lang.String name, HeightMap baseHeightMap, float scaleX, float scaleY, int offsetX, int offsetY, float rotation)

Method Summary

Modifier and Type	Method and Description
static TransformingHeightMap.TransformingHeightMapBuilder	build()
int	doGetColour(int x, int y)
double	doGetHeight(float x, float y)
double	doGetHeight(int x, int 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.
int	getOffsetX()
int	getOffsetY()
double[]	getRange() Get the range of this height map, i.e.
float	getRotation()
float	getScaleX()
float	getScaleY()
void	setBaseHeightMap(HeightMap baseHeightMap)

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

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

clone, 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

TransformingHeightMap

public TransformingHeightMap(java.lang.String name,
                             HeightMap baseHeightMap,
                             float scaleX,
                             float scaleY,
                             int offsetX,
                             int offsetY,
                             float rotation)

Method Detail

getBaseHeightMap

public HeightMap getBaseHeightMap()

setBaseHeightMap

public void setBaseHeightMap(HeightMap baseHeightMap)

getOffsetX

public int getOffsetX()

getOffsetY

public int getOffsetY()

getScaleX

public float getScaleX()

getScaleY

public float getScaleY()

getRotation

public float getRotation()

doGetHeight

public double doGetHeight(int x,
                          int y)

Overrides:

doGetHeight in class DelegatingHeightMap

doGetHeight

public double doGetHeight(float x,
                          float y)

Overrides:

doGetHeight in class DelegatingHeightMap

doGetColour

public int doGetColour(int x,
                       int y)

Overrides:

doGetColour 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.

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.

build

public static TransformingHeightMap.TransformingHeightMapBuilder build()