Terrain (org.dayflower.pathtracer API)

java.lang.Object
- org.dayflower.pathtracer.scene.shape.Terrain

All Implemented Interfaces:

Shape
```
public final class Terrain
extends java.lang.Object
implements Shape
```
A Shape implementation that implements a noise-based terrain.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`RELATIVE_OFFSET_FREQUENCY` The relative offset of the Frequency parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_GAIN` The relative offset of the Gain parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_MAXIMUM` The relative offset of the Maximum parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_MINIMUM` The relative offset of the Minimum parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_OCTAVES` The relative offset of the Octaves parameter in the `float` array.
`static int`	`SIZE` The size of a `Terrain` in the `float` array.
`static int`	`TYPE` The type number associated with a `Terrain`.

Constructor Summary

Constructors
Constructor and Description

Terrain(float frequency, float gain, float minimum, float maximum, int octaves)
Constructs a new Terrain instance.

Constructors
Constructor and Description
`Terrain(float frequency, float gain, float minimum, float maximum, int octaves)` Constructs a new `Terrain` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)` Compares `object` to this `Terrain` instance for equality.
`float`	`getFrequency()` Returns the frequency of this `Terrain` instance.
`float`	`getGain()` Returns the gain of this `Terrain` instance.
`float`	`getMaximum()` Returns the maximum of this `Terrain` instance.
`float`	`getMinimum()` Returns the minimum of this `Terrain` instance.
`int`	`getOctaves()` Returns the octaves of this `Terrain` instance.
`int`	`getSize()` Returns the size of this `Terrain` instance.
`int`	`getType()` Returns the type of this `Terrain` instance.
`int`	`hashCode()` Returns a hash code for this `Terrain` instance.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RELATIVE_OFFSET_FREQUENCY
```
public static final int RELATIVE_OFFSET_FREQUENCY
```
    The relative offset of the Frequency parameter in the float array. The value is 0.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_GAIN
```
public static final int RELATIVE_OFFSET_GAIN
```
    The relative offset of the Gain parameter in the float array. The value is 1.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_MAXIMUM
```
public static final int RELATIVE_OFFSET_MAXIMUM
```
    The relative offset of the Maximum parameter in the float array. The value is 3.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_MINIMUM
```
public static final int RELATIVE_OFFSET_MINIMUM
```
    The relative offset of the Minimum parameter in the float array. The value is 2.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_OCTAVES
```
public static final int RELATIVE_OFFSET_OCTAVES
```
    The relative offset of the Octaves parameter in the float array. The value is 4.
    
    See Also:
    
    Constant Field Values
  - SIZE
```
public static final int SIZE
```
    The size of a Terrain in the float array. The size is 5.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final int TYPE
```
    The type number associated with a Terrain. The number is 4.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Terrain
```
public Terrain(float frequency,
               float gain,
               float minimum,
               float maximum,
               int octaves)
```
    Constructs a new Terrain instance.
    
    Parameters:
    
    frequency - the frequency to use
    
    gain - the gain to use
    
    minimum - the minimum to use
    
    maximum - the maximum to use
    
    octaves - the octaves to use
- Method Detail
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares object to this Terrain instance for equality.
    Returns true if, and only if, object is an instance of Terrain, and their respective values are equal, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the Object to compare to this Terrain instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of Terrain, and their respective values are equal, false otherwise
  - getFrequency
```
public float getFrequency()
```
    Returns the frequency of this Terrain instance.
    
    Returns:
    
    the frequency of this Terrain instance
  - getGain
```
public float getGain()
```
    Returns the gain of this Terrain instance.
    
    Returns:
    
    the gain of this Terrain instance
  - getMaximum
```
public float getMaximum()
```
    Returns the maximum of this Terrain instance.
    
    Returns:
    
    the maximum of this Terrain instance
  - getMinimum
```
public float getMinimum()
```
    Returns the minimum of this Terrain instance.
    
    Returns:
    
    the minimum of this Terrain instance
  - getOctaves
```
public int getOctaves()
```
    Returns the octaves of this Terrain instance.
    
    Returns:
    
    the octaves of this Terrain instance
  - getSize
```
public int getSize()
```
    Returns the size of this Terrain instance.
    
    Specified by:
    
    getSize in interface Shape
    
    Returns:
    
    the size of this Terrain instance
  - getType
```
public int getType()
```
    Returns the type of this Terrain instance.
    
    Specified by:
    
    getType in interface Shape
    
    Returns:
    
    the type of this Terrain instance
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this Terrain instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this Terrain instance

Class Terrain

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RELATIVE_OFFSET_FREQUENCY

RELATIVE_OFFSET_GAIN

RELATIVE_OFFSET_MAXIMUM

RELATIVE_OFFSET_MINIMUM

RELATIVE_OFFSET_OCTAVES

SIZE

TYPE

Constructor Detail

Terrain

Method Detail

equals

getFrequency

getGain

getMaximum

getMinimum

getOctaves

getSize

getType

hashCode