Struct noise::Terrace

pub struct Terrace<T, Source, const DIM: usize>
where
    Source: NoiseFn<T, DIM>,
{
    pub source: Source,
    pub invert_terraces: bool,
    /* private fields */
}

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

This noise function maps the output value from the source function 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 function clamps the output value from the source function 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 function 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.

Implementations

impl<T, Source, const DIM: usize> Terrace<T, Source, DIM>

where Source: NoiseFn<T, DIM>,

pub fn new(source: Source) -> Self

pub fn add_control_point(self, control_point: f64) -> Self

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.

pub fn invert_terraces(self, invert_terraces: bool) -> Self

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

Trait Implementations

impl<T: Clone, Source, const DIM: usize> Clone for Terrace<T, Source, DIM>

where Source: NoiseFn<T, DIM> + Clone,

fn clone(&self) -> Terrace<T, Source, DIM>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, Source, const DIM: usize> NoiseFn<T, DIM> for Terrace<T, Source, DIM>

where Source: NoiseFn<T, DIM>,

fn get(&self, point: [T; DIM]) -> f64