org.pepsoft.worldpainter.heightMaps

Class NinePatchHeightMap

java.lang.Object

org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

org.pepsoft.worldpainter.heightMaps.NinePatchHeightMap

All Implemented Interfaces:

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

public final class NinePatchHeightMap
extends AbstractHeightMap

A heightmap creating a square with rounded corners, with a smoothly descending border on the outside.

The innerSize is the inner size of the square (from the centre, so half the actual width) without the rounded corners.
The borderSize is the radius of the rounded corners.
The coastSize is the distance over which the height decreases to zero outside the border.
The height is the height of the part described by innerSize + borderSize. From there the height sinuously decreases to zero over coastSize pixels.

By setting the innerSize to zero you can create a completely circular shape. The two constructors that take only two ints are convenience constructors to do that.

To have entirely sharp, perpendicular corners, set the borderSize to zero.

See Also:

Serialized Form

Field Summary

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

name, seed

Constructor Summary

Constructors

Constructor and Description
NinePatchHeightMap(int innerRadius, int coastSize, double height)
NinePatchHeightMap(int innerSize, int borderSize, int coastSize, double height)
NinePatchHeightMap(java.lang.String name, int innerRadius, int coastSize, double height)
NinePatchHeightMap(java.lang.String name, int innerSize, int borderSize, int coastSize, double height)

Method Summary

Modifier and Type	Method and Description
int	getBorderSize()
int	getCoastSize()
double	getHeight()
double	getHeight(float x, float y) Get the height of the height map at a particular location.
javax.swing.Icon	getIcon() Get a 16x16 icon representing this height map.
int	getInnerSizeX()
int	getInnerSizeY()
double[]	getRange() Get the range of this height map, i.e.

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

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

NinePatchHeightMap

public NinePatchHeightMap(int innerRadius,
                          int coastSize,
                          double height)

NinePatchHeightMap

public NinePatchHeightMap(int innerSize,
                          int borderSize,
                          int coastSize,
                          double height)

NinePatchHeightMap

public NinePatchHeightMap(java.lang.String name,
                          int innerRadius,
                          int coastSize,
                          double height)

NinePatchHeightMap

public NinePatchHeightMap(java.lang.String name,
                          int innerSize,
                          int borderSize,
                          int coastSize,
                          double height)

Method Detail

getInnerSizeX

public int getInnerSizeX()

getInnerSizeY

public int getInnerSizeY()

getBorderSize

public int getBorderSize()

getCoastSize

public int getCoastSize()

getHeight

public double getHeight()

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.

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.