boids 0.1.0

A fast boids library for Rust
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
48
49
50
51
52
53
54
55
56
57
58
59
60

use cgmath::{num_traits::Float, BaseNum, Vector3};
#[cfg(feature = "rayon")]
use rayon::prelude::*;

use crate::boids::Boid;

#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Flock<T: Boid<T, U>, U: BaseNum + Float> {
    pub boids: Vec<T>,
    pub goal_separation: U,
    pub goal_alignment: U,
    pub goal_cohesion: U,
    pub target: Option<Vector3<U>>,
}

impl<T: Boid<T, U> + Clone, U: BaseNum + Float> Flock<T, U>
where
    T: std::marker::Send,
    T: std::marker::Sync,
    U: std::marker::Sync,
{
    /// Update all boids in the flock
    pub fn update(&mut self) {
        #[cfg(feature = "puffin")]
        puffin::profile_function!();

        // Handle weather we are running parallel or single-thread
        cfg_if::cfg_if! {
            if #[cfg(feature = "rayon")] {
                self.boids = self.boids
                    .par_iter()
                    .map(|boid| boid.update(&self.clone()))
                    .collect();
            } else {
                self.boids = self.boids
                    .iter()
                    .map(|boid| boid.update(&self.clone()))
                    .collect();
            }
        }
    }

    /// Set a target for the flock to follow
    pub fn set_target(&mut self, target: Option<Vector3<U>>) {
        self.target = target;
    }
}

impl<T: Boid<T, U>, U: BaseNum + Float> Default for Flock<T, U> {
    fn default() -> Self {
        Self {
            boids: Vec::new(),
            goal_separation: U::from(25.0).unwrap(),
            goal_alignment: U::from(50.0).unwrap(),
            goal_cohesion: U::from(50.0).unwrap(),
            target: None
        }
    }
}