poisson 0.10.1

Poisson-disk distribution generator.
Documentation 
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
41
42
43
44
45
46
47

//! Module that contains traits that describe poisson-disk distribution generating algorithms.

use crate::{Builder, Float, Vector};

use rand::Rng;

use std::fmt::Debug;

pub use self::bridson::Bridson;
pub use self::ebeida::Ebeida;

mod bridson;
mod ebeida;

/// Constructs new instance of the algorithm.
pub trait Creator<F, V>: Copy + Debug
where
    F: Float,
    V: Vector<F>,
{
    /// Algorithm instance associated with the trait
    type Algo: Algorithm<F, V>;

    /// Creates new and empty algorithm instance.
    fn create(_: &Builder<F, V>) -> Self::Algo;
}

/// Trait that describes poisson-disk distribution generating algorithm.
pub trait Algorithm<F, V>
where
    F: Float,
    V: Vector<F>,
{
    /// Generates new sample advancing the algorithm.
    fn next<R>(&mut self, _: &mut Builder<F, V>, _: &mut R) -> Option<V>
    where
        R: Rng;

    /// Returns lower and upper bound of the amount of samples remaining for the algorithm to generate.
    fn size_hint(&self, _: &Builder<F, V>) -> (usize, Option<usize>);

    /// Restricts the algorithm with an arbitary sample.
    fn restrict(&mut self, _: V);

    /// Checks if a sample is valid for the poisson-disk distribution generated thus far by the algorithm.
    fn stays_legal(&self, _: &Builder<F, V>, _: V) -> bool;
}