dces 0.3.1

DCES entity component system
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

use core::cell::Cell;
use core::ops::Drop;

use crate::{
    component::*,
    entity::*,
    system::{System, SystemStore, SystemStoreBuilder},
};

/// The `World` struct represents the main interface of the library. It used
/// as storage of entities, components and systems.
pub struct World<E, Ctx>
where
    E: EntityStore,
{
    entity_component_manager: EntityComponentManager<E>,
    system_store: SystemStore<E, Ctx>,
    system_counter: u32,
    first_run: bool,
}

impl<E, Ctx> Drop for World<E, Ctx>
where
    E: EntityStore,
{
    fn drop(&mut self) {
        if let Some(cleanup_system) = self.system_store.borrow_cleanup_system() {
            cleanup_system
                .system
                .run(&mut self.entity_component_manager);
        }
    }
}

unsafe impl<E, Ctx> Send for World<E, Ctx> where E: EntityStore {}

impl<E, Ctx> World<E, Ctx>
where
    E: EntityStore,
{
    /// Creates a new world from the given entity store.
    pub fn from_entity_store(entity_store: E) -> Self {
        World {
            entity_component_manager: EntityComponentManager::new(entity_store),
            system_counter: 0,
            system_store: SystemStore::new(),
            first_run: true,
        }
    }

    /// Creates a new entity and returns a returns an `TypeEntityBuilder`.
    pub fn create_entity(&mut self) -> EntityBuilder<'_, E> {
        self.entity_component_manager.create_entity()
    }

    /// Deletes the given `entity`.
    pub fn remove_entity(&mut self, entity: impl Into<Entity>) {
        self.entity_component_manager.remove_entity(entity);
    }

    /// Registers the init system.
    pub fn register_init_system(&mut self, init_system: impl System<E, Ctx>) {
        self.system_store.register_init_system(init_system);
    }

    /// Registers the cleanup system.
    pub fn register_cleanup_system(&mut self, cleanup_system: impl System<E, Ctx>) {
        self.system_store.register_cleanup_system(cleanup_system);
    }

    /// Creates a new entity system and returns a returns an `SystemStoreBuilder`.
    pub fn create_system(&mut self, system: impl System<E, Ctx>) -> SystemStoreBuilder<'_, E, Ctx> {
        let entity_system_id = self.system_counter;
        self.system_store.register_system(system, entity_system_id);
        self.system_counter += 1;

        SystemStoreBuilder {
            system_store: &mut self.system_store,
            entity_system_id,
            priority: Cell::new(0),
        }
    }

    /// Removes the given `entity`.
    pub fn remove_system(&mut self, system_id: u32) {
        self.system_store.remove_system(system_id);
    }

    /// Borrows mutable the entity component manager.
    pub fn entity_component_manager(&mut self) -> &mut EntityComponentManager<E> {
        &mut self.entity_component_manager
    }

    /// Print infos about the given entity.
    pub fn print_entity(&self, entity: impl Into<Entity>) {
        self.entity_component_manager
            .component_store()
            .print_entity(entity);
    }

    /// Run all systems of the world.
    pub fn run(&mut self) {
        if self.first_run {
            if let Some(init_system) = self.system_store.borrow_init_system() {
                init_system.system.run(&mut self.entity_component_manager);
            }
            self.first_run = false;
        }

        let priorities = &self.system_store.priorities;
        for priority in priorities.values() {
            for system in priority {
                self.system_store
                    .borrow_entity_system(*system)
                    .unwrap()
                    .system
                    .run(&mut self.entity_component_manager);
            }
        }
    }

    /// Run all systems of the world and calls `run_with_context` of the systems with the given context.
    pub fn run_with_context(&mut self, ctx: &mut Ctx) {
        if self.first_run {
            if let Some(init_system) = self.system_store.borrow_init_system() {
                init_system
                    .system
                    .run_with_context(&mut self.entity_component_manager, ctx);
            }
            self.first_run = false;
        }

        let priorities = &self.system_store.priorities;
        for priority in priorities.values() {
            for system in priority {
                self.system_store
                    .borrow_entity_system(*system)
                    .unwrap()
                    .system
                    .run_with_context(&mut self.entity_component_manager, ctx);
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::entity::{Entity, VecEntityStore};
    use crate::system::PhantomContext;

    #[derive(Default)]
    struct TestSystem;

    impl System<VecEntityStore, PhantomContext> for TestSystem {
        fn run(&self, _ecm: &mut EntityComponentManager<VecEntityStore>) {}
    }

    #[test]
    fn create_entity() {
        let mut world: World<VecEntityStore, PhantomContext> =
            World::from_entity_store(VecEntityStore::default());
        assert_eq!(Entity(0), world.create_entity().build());
        assert_eq!(Entity(1), world.create_entity().build());
    }

    #[test]
    fn create_system() {
        let mut world = World::from_entity_store(VecEntityStore::default());
        assert_eq!(0, world.create_system(TestSystem).build());
        assert_eq!(1, world.create_system(TestSystem).build());
    }
}