Struct noise::Worley

source ·
pub struct Worley {
    pub distance_function: Rc<dyn Fn(&[f64], &[f64]) -> f64>,
    pub return_type: ReturnType,
    pub frequency: f64,
    /* private fields */
}
Expand description

Noise function that outputs Worley noise.

Fields§

§distance_function: Rc<dyn Fn(&[f64], &[f64]) -> f64>

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

§return_type: ReturnType

Signifies whether the distance from the borders of the cell should be returned, or the value for the cell.

§frequency: f64

Frequency of the seed points.

Implementations§

source§

impl Worley

source

pub const DEFAULT_SEED: u32 = 0u32

source

pub const DEFAULT_FREQUENCY: f64 = 1f64

source

pub fn new(seed: u32) -> Self

source

pub fn set_distance_function<F>(self, function: F) -> Self
where F: Fn(&[f64], &[f64]) -> f64 + 'static,

Sets the distance function used by the Worley cells.

source

pub fn set_return_type(self, return_type: ReturnType) -> Self

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

source

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

Sets the frequency of the seed points.

Trait Implementations§

source§

impl Clone for Worley

source§

fn clone(&self) -> Worley

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for Worley

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl NoiseFn<f64, 2> for Worley

source§

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

source§

impl NoiseFn<f64, 3> for Worley

source§

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

source§

impl NoiseFn<f64, 4> for Worley

source§

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

source§

impl Seedable for Worley

source§

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

Sets the seed value used by the Worley cells.

source§

fn seed(&self) -> u32

Getter to retrieve the seed from the function

Auto Trait Implementations§

§

impl Freeze for Worley

§

impl !RefUnwindSafe for Worley

§

impl !Send for Worley

§

impl !Sync for Worley

§

impl Unpin for Worley

§

impl !UnwindSafe for Worley

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.