HeightMap

All Known Implementing Classes:

AbstractHeightMap, BandedHeightMap, BicubicHeightMap, BitmapHeightMap, CombiningHeightMap, ConstantHeightMap, DelegatingHeightMap, DifferenceHeightMap, DisplacementHeightMap, MandelbrotHeightMap, MaximisingHeightMap, MinimisingHeightMap, NinePatchHeightMap, NoiseHeightMap, ProductHeightMap, ShelvingHeightMap, SlopeHeightMap, SumHeightMap, TransformingHeightMap
```
public interface HeightMap
```
A height map.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default HeightMap`	`clamped(double min, double max)` Create a new height map that constrains the value of another height map to a given range.
`HeightMap`	`clone()` Create a deep copy of the height map.
`double`	`getBaseHeight()` Get the base height of this height map, in other words the lowest value it can have.
`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`	`getConstantValue()` If the height map is `constant`: returns the constant value that would be returned for any location from `getHeight(int, int)` and `getHeight(float, float)`.
`java.awt.Rectangle`	`getExtent()` Get the extent of the height map, if any.
`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.
`java.lang.String`	`getName()` Get the name of the height map.
`double[]`	`getRange()` Get the range of this height map, i.e.
`long`	`getSeed()` Get the seed of the height map.
`boolean`	`isConstant()` Indicate whether the height map is constant, i.e.
`default HeightMap`	`minus(double subtrahend)` Create a new height map which is the difference of this and a constant value.
`default HeightMap`	`minus(HeightMap subtrahend)` Create a new height map which is the difference of this and another height map.
`default HeightMap`	`plus(double addend)` Create a new height map which is the sum of this and a constant value.
`default HeightMap`	`plus(HeightMap addend)` Create a new height map which is the sum of this and another height map.
`default HeightMap`	`scaled(float scale)` Create a new height map that is another height map scaled up by a given factor.
`void`	`setSeed(long seed)` Set the seed of the height map.
`default HeightMap`	`smoothed()` Create a new height map which uses bicubic interpolation to interpolate values between the integer coordinates of another height map.
`default HeightMap`	`times(double factor)` Create a new height map which is the product of this and a constant value.
`default HeightMap`	`times(HeightMap subtrahend)` Create a new height map which is the product of this and another height map.

- Method Detail
  - getName
```
java.lang.String getName()
```
    Get the name of the height map.
    
    Returns:
    
    The name of the height map.
  - getSeed
```
long getSeed()
```
    Get the seed of the height map.
    
    Returns:
    
    The seed of the height map.
  - setSeed
```
void setSeed(long seed)
```
    Set the seed of the height map.
    
    Parameters:
    
    seed - The new seed of the height map.
  - getHeight
```
double getHeight(int x,
                 int y)
```
    Get the height of the height map at a particular location.
    
    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
```
double getHeight(float x,
                 float y)
```
    Get the height of the height map at a particular location.
    
    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.
  - getBaseHeight
```
double getBaseHeight()
```
    Get the base height of this height map, in other words the lowest value it can have.
    
    Returns:
    
    The base height of this height map.
  - clone
```
HeightMap clone()
```
    Create a deep copy of the height map.
    
    Returns:
    
    A deep copy of the height map.
  - getExtent
```
java.awt.Rectangle getExtent()
```
    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.
    
    Returns:
    
    The extent of the height map, or null if it is unbounded.
  - getColour
```
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.
    
    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.
  - isConstant
```
boolean isConstant()
```
    Indicate whether the height map is constant, i.e. it always returns the same value regardless of the location.
    
    Returns:
    
    true if the height map is constant.
  - getConstantValue
```
double getConstantValue()
```
    If the height map is constant: returns the constant value that would be returned for any location from getHeight(int, int) and getHeight(float, float). If the height map is not constant the behaviour is undefined.
    
    Returns:
    
    The constant value of this height map, providing that it is constant according to isConstant().
  - getIcon
```
javax.swing.Icon getIcon()
```
    Get a 16x16 icon representing this height map.
    
    Returns:
    
    A 16x16 icon representing this height map.
  - getRange
```
double[] getRange()
```
    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 getBaseHeight()) and the upper bound in index 1.
    
    Returns:
    
    The range of this height map.
  - plus
```
default HeightMap plus(HeightMap addend)
```
    Create a new height map which is the sum of this and another height map.
  - plus
```
default HeightMap plus(double addend)
```
    Create a new height map which is the sum of this and a constant value.
  - minus
```
default HeightMap minus(HeightMap subtrahend)
```
    Create a new height map which is the difference of this and another height map.
  - minus
```
default HeightMap minus(double subtrahend)
```
    Create a new height map which is the difference of this and a constant value.
  - times
```
default HeightMap times(HeightMap subtrahend)
```
    Create a new height map which is the product of this and another height map.
  - times
```
default HeightMap times(double factor)
```
    Create a new height map which is the product of this and a constant value.
  - smoothed
```
default HeightMap smoothed()
```
    Create a new height map which uses bicubic interpolation to interpolate values between the integer coordinates of another height map.
  - scaled
```
default HeightMap scaled(float scale)
```
    Create a new height map that is another height map scaled up by a given factor.
  - clamped
```
default HeightMap clamped(double min,
                          double max)
```
    Create a new height map that constrains the value of another height map to a given range.

Interface HeightMap

Method Summary

Method Detail

getName

getSeed

setSeed

getHeight

getHeight

getBaseHeight

clone

getExtent

getColour

isConstant

getConstantValue

getIcon

getRange

plus

plus

minus

minus

times

times

smoothed

scaled

clamped