Struct noise::Worley

pub struct Worley {
    pub range_function: RangeFunction,
    pub enable_range: bool,
    pub frequency: f64,
    pub displacement: f64,
    /* private fields */
}

Noise function that outputs Worley noise.

Fields

range_function: RangeFunction

Specifies the range function to use when calculating the boundaries of the cell.

enable_range: bool

Determines if the distance from the nearest seed point is applied to the output value.

frequency: f64

Frequency of the seed points.

displacement: f64

Scale of the random displacement to apply to each cell.

The noise function assigns each Worley cell a random constant value from a value noise function. The displacement value controls the range random values to assign to each cell. The range of random values is +/- the displacement value.

Implementations

impl Worley

pub const DEFAULT_SEED: u32 = 0u32

pub const DEFAULT_RANGEFUNCTION: RangeFunction = RangeFunction::Euclidean

pub const DEFAULT_FREQUENCY: f64 = 1f64

pub const DEFAULT_DISPLACEMENT: f64 = 1f64

pub fn new() -> Self

pub fn set_range_function(self, range_function: RangeFunction) -> Self

Sets the range function used by the Worley cells.

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

Enables or disables applying the distance from the nearest seed point to the output value.

pub fn set_frequency(self, frequency: f64) -> Self

Sets the frequency of the seed points.

pub fn set_displacement(self, displacement: f64) -> Self

Trait Implementations

impl Clone for Worley

fn clone(&self) -> Worley

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Worley

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Worley

fn default() -> Self

Returns the “default value” for a type.

impl NoiseFn<[f64; 2]> for Worley

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

impl NoiseFn<[f64; 3]> for Worley

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

impl NoiseFn<[f64; 4]> for Worley

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

impl Seedable for Worley

fn set_seed(self, seed: u32) -> Self

Sets the seed value used by the Worley cells.

fn seed(&self) -> u32

Getter to retrieve the seed from the function

impl Copy for Worley