jecs 0.1.0

A simple but functional ECS
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

use crate::entities::query::Query;
use crate::entities::Entities;
use crate::resources::Resources;
use eyre::Result;
use std::any::Any;

mod entities;
pub mod errors;
mod resources;

#[derive(Default, Debug)]
pub struct World {
    resources: Resources,
    entities: Entities,
}

impl World {
    pub fn new() -> Self {
        Self::default()
    }

    /**
    Adds a resource to the world.
    The only restriction is that the resource type implements the Any trait.

    # Examples

    ```
    use jecs::World;
    let mut world = World::new();
    world.add_resource(10_u32);
    # assert_eq!(*world.get_resource::<u32>().unwrap(), 10);
    ```
     */
    pub fn add_resource(&mut self, resource_data: impl Any) {
        self.resources.add(resource_data);
    }

    /**
    Queries for a resource and gets a reference to it.

    # Examples

    ```
    use jecs::World;

    let mut world = World::new();
    world.add_resource(10_u32);

    let resource = world.get_resource::<u32>().unwrap();
    # assert_eq!(*resource, 10);
    ```
     */
    pub fn get_resource<T: Any>(&self) -> Option<&T> {
        self.resources.get_ref::<T>()
    }

    /**
    Queries for a resource and gets a mutable reference to it.

    # Examples

    ```
    use jecs::World;

    let mut world = World::new();
    world.add_resource(10_u32);

    {
        let resource = world.get_resource_mut::<u32>().unwrap();
        *resource += 10;
    }

    let resource = world.get_resource::<u32>().unwrap();
    # assert_eq!(*resource, 20);
    ```
    */
    pub fn get_resource_mut<T: Any>(&mut self) -> Option<&mut T> {
        self.resources.get_mut::<T>()
    }

    ///Removes a resource from the world.
    pub fn delete_resource<T: Any>(&mut self) {
        self.resources.remove::<T>();
    }

    /// Registers a new empty component
    pub fn register_component<T: Any>(&mut self) {
        self.entities.register_component::<T>();
    }

    /**
    Creates an entity.\
    To pass components during the creation, use the `with_component` builder.\
    To add components to an entity, they have to be registered first using `register_component`.

    # Examples

    ```
    # use eyre::Result;
    use jecs::World;
    # fn try_main() -> Result<()> {
    let mut world = World::new();
    world.register_component::<u32>();
    world.register_component::<f32>();
    world
        .create_entity()
        .with_component(100_u32)?
        .with_component(16.0_f32)?;
    #    Ok(())
    # }
    # fn main() {
    #     try_main().unwrap();
    # }
    ```
    */

    pub fn create_entity(&mut self) -> &mut Entities {
        self.entities.create_entity()
    }

    pub fn query(&self) -> Query {
        Query::new(&self.entities)
    }

    pub fn delete_component_by_entity_id<T: Any>(&mut self, index: usize) -> Result<()> {
        self.entities.delete_component_by_entity_id::<T>(index)
    }

    pub fn add_component_by_entity_id(&mut self, data: impl Any, index: usize) -> Result<()> {
        self.entities.add_component_by_entity_id(data, index)
    }

    pub fn delete_entity_by_id(&mut self, index: usize) -> Result<()> {
        self.entities.delete_entity_by_id(index)
    }
}

#[cfg(test)]
mod tests {}