sparsey 0.13.3

Entity Component System based on sparse sets
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
61
62
63
64

use crate::component::{Component, ComponentData, GroupDescriptor, GroupLayout};
use crate::world::World;
use alloc::vec::Vec;

/// Builder struct for creating a [`World`].
#[must_use]
#[derive(Clone, Default, Debug)]
pub struct WorldBuilder {
    layout: GroupLayout,
    components: Vec<ComponentData>,
}

impl WorldBuilder {
    /// Sets a group `layout` for the world.
    #[inline]
    pub fn set_layout(&mut self, layout: GroupLayout) -> &mut Self {
        self.layout = layout;
        self
    }

    /// Adds a new component group to the world.
    pub fn add_group<G>(&mut self) -> &mut Self
    where
        G: GroupDescriptor,
    {
        self.add_group_dyn(G::COMPONENTS)
    }

    /// Adds a new component group to the world.
    #[inline]
    pub fn add_group_dyn(&mut self, components: &[ComponentData]) -> &mut Self {
        self.layout.add_group_dyn(components);
        self
    }

    /// Registers a new component type on the world.
    pub fn register<T>(&mut self) -> &mut Self
    where
        T: Component,
    {
        self.register_dyn(ComponentData::new::<T>())
    }

    /// Registers a new component type on the world.
    #[inline]
    pub fn register_dyn(&mut self, component: ComponentData) -> &mut Self {
        self.components.push(component);
        self
    }

    /// Buidls the world with the previously specified options.
    ///
    /// Returns the newly created world.
    #[must_use]
    pub fn build(&self) -> World {
        let mut world = World::new(&self.layout);

        for &component in &self.components {
            world.register_dyn(component);
        }

        world
    }
}