Struct noise::Terrace

pub struct Terrace<Source, T> {
    pub source: Source,
    pub invert_terraces: bool,
    // some fields omitted
}

Noise module that maps the output value from the source module onto a terrace-forming curve.

This noise module maps the output value from the source module onto a terrace-forming curve. The start of the curve has a slode of zero; it's slope then smoothly increases. This curve also contains control points which resets the slope to zero at that point, producing a "terracing" effect.

To add control points to the curve, use the add_control_point method.

An application must add a minimum of two control points to the curve. If there are less than two control points, the get() method panics. The control points can have any value, although no two control points can have the same value. There is no limit to the number of control points that can be added to the curve.

The noise module clamps the output value from the source module if that value is less than the value of the lowest control point or greater than the value of the highest control point.

This noise module is often used to generate terrain features such as the stereotypical desert canyon.

Fields

source: Source

Outputs a value.

invert_terraces: bool

Determines if the terrace-forming curve between all control points is inverted.

Methods

impl<Source, T> Terrace<Source, T> where
    T: Float, 

fn new(source: Source) -> Terrace<Source, T>

fn add_control_point(self, control_point: T) -> Terrace<Source, T>

Adds a control point to the terrace-forming curve.

Two or more control points define the terrace-forming curve. The start of this curve has a slope of zero; its slope then smoothly increases. At the control points, its slope resets to zero.

It does not matter which order these points are added in.

fn invert_terraces(self, invert_terraces: bool) -> Terrace<Source, T>

Enables or disables the inversion of the terrain-forming curve between the control points.

Trait Implementations

impl<Source, T, U> NoiseModule<T> for Terrace<Source, U> where
    Source: NoiseModule<T, Output = U>,
    T: Copy,
    U: Float, 

type Output = U

fn get(&self, point: T) -> Self::Output