1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

// Copyright (c) 2017 The Noise-rs Developers.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT
// or http://opensource.org/licenses/MIT>, at your option. All files in the
// project carrying such notice may not be copied, modified, or distributed
// except according to those terms.

use modules::NoiseModule;
use num_traits::Float;

/// Noise module that outputs a constant value.
///
/// This module takes a input, value, and returns that input for all points,
/// producing a constant-valued field.
///
/// This module is not very useful by itself, but can be used as a source
/// module for other noise modules.
#[derive(Clone, Copy, Debug)]
pub struct Constant<T: Float> {
    /// Constant value.
    pub value: T,
}

impl<T: Float> Constant<T> {
    pub fn new(value: T) -> Constant<T> {
        Constant { value: value }
    }
}

impl<T, U> NoiseModule<U> for Constant<T>
    where T: Float,
          U: Copy,
{
    type Output = T;

    fn get(&self, _point: U) -> Self::Output {
        self.value
    }
}