org.pepsoft.worldpainter.heightMaps

Class NoiseHeightMap

java.lang.Object

org.pepsoft.worldpainter.heightMaps.AbstractHeightMap

org.pepsoft.worldpainter.heightMaps.NoiseHeightMap

All Implemented Interfaces:

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

public final class NoiseHeightMap
extends AbstractHeightMap

See Also:

Serialized Form

Field Summary

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

name, seed

Constructor Summary

Constructors

Constructor and Description
NoiseHeightMap(double height, double scale, int octaves)
NoiseHeightMap(double height, double scale, int octaves, long seedOffset)
NoiseHeightMap(NoiseSettings noiseSettings)
NoiseHeightMap(NoiseSettings noiseSettings, long seedOffset)
NoiseHeightMap(java.lang.String name, double height, double scale, int octaves)
NoiseHeightMap(java.lang.String name, double height, double scale, int octaves, long seedOffset)
NoiseHeightMap(java.lang.String name, NoiseSettings noiseSettings)
NoiseHeightMap(java.lang.String name, NoiseSettings noiseSettings, long seedOffset)

Method Summary

Modifier and Type	Method and Description
NoiseHeightMap	clone() Create a deep copy of the height map.
int	getColour(int x, int y) Get the colour of the height map at a particular location as a combined RGB value consisting of the red component in bits 16-23, the green component in bits 8-15, and the blue component in bits 0-7.
double	getHeight()
double	getHeight(float x, float y) Get the height of the height map at a particular location.
double	getHeight(int x, int 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	getOctaves()
double[]	getRange() Get the range of this height map, i.e.
double	getScale()
long	getSeedOffset()
double	getValue(double x)
double	getValue(double x, double y)
double	getValue(double x, double y, double z)
void	setSeed(long seed) Set the seed of the height map.

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

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

NoiseHeightMap

public NoiseHeightMap(NoiseSettings noiseSettings)

NoiseHeightMap

public NoiseHeightMap(NoiseSettings noiseSettings,
                      long seedOffset)

NoiseHeightMap

public NoiseHeightMap(java.lang.String name,
                      NoiseSettings noiseSettings)

NoiseHeightMap

public NoiseHeightMap(java.lang.String name,
                      NoiseSettings noiseSettings,
                      long seedOffset)

NoiseHeightMap

public NoiseHeightMap(double height,
                      double scale,
                      int octaves)

NoiseHeightMap

public NoiseHeightMap(double height,
                      double scale,
                      int octaves,
                      long seedOffset)

NoiseHeightMap

public NoiseHeightMap(java.lang.String name,
                      double height,
                      double scale,
                      int octaves)

NoiseHeightMap

public NoiseHeightMap(java.lang.String name,
                      double height,
                      double scale,
                      int octaves,
                      long seedOffset)

Method Detail

getHeight

public double getHeight()

getScale

public double getScale()

getOctaves

public int getOctaves()

getSeedOffset

public long getSeedOffset()

setSeed

public void setSeed(long seed)

Description copied from interface: HeightMap

Set the seed of the height map.

Specified by:

setSeed in interface HeightMap

Overrides:

setSeed in class AbstractHeightMap

Parameters:

seed - The new seed of the height map.

getHeight

public double getHeight(int x,
                        int 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.

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.

getColour

public int getColour(int x,
                     int y)

Description copied from interface: HeightMap

Get the colour of the height map at a particular location as a combined RGB value consisting of the red component in bits 16-23, the green component in bits 8-15, and the blue component in bits 0-7.

Specified by:

getColour in interface HeightMap

Overrides:

getColour in class AbstractHeightMap

Parameters:

x - The X coordinate of the location of which to get the colour.

y - The Y coordinate of the location of which to get the colour.

Returns:

The colour at the specified location.

getValue

public double getValue(double x)

getValue

public double getValue(double x,
                       double y)

getValue

public double getValue(double x,
                       double y,
                       double z)

clone

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