regecs 2.0.0-alpha-1

Rust Extended Generic ECS (REGECS)
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

// Copyright (c) 2021, BlockProject 3D
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright notice,
//       this list of conditions and the following disclaimer in the documentation
//       and/or other materials provided with the distribution.
//     * Neither the name of BlockProject 3D nor the names of its contributors
//       may be used to endorse or promote products derived from this software
//       without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use crate::event::Event;
use crate::object::Factory;
use crate::scene::EventInfo;

/// Type alias for object references
///
/// *serves also as entry point into REGECS entity layer*
pub type ObjectRef = u32;

pub trait Context : Sized + crate::system::Context
{
    type SystemManager;

    fn systems(&self) -> &Self::SystemManager;
    fn systems_mut(&mut self) -> &mut Self::SystemManager;
    fn remove_object(&mut self, info: EventInfo);
    fn spawn_object(&mut self, info: EventInfo, factory: Factory<Self>);
}

pub trait Index
{
    fn index(&self) -> ObjectRef;
}

/// Low-level object interface to represent all dynamic objects managed by a scene
pub trait Object<C: Context>
{
    fn on_event(&mut self, ctx: &mut C, state: &C::AppState, event: &Event<C::Event>);
    fn on_remove(&mut self, ctx: &mut C, state: &C::AppState);
    fn on_update(&mut self, ctx: &mut C, state: &C::AppState);
    fn class(&self) -> &str;
}

pub trait New<C: Context>: 'static + Sized + Object<C> {
    type Properties: 'static;

    const UPDATES: bool;

    fn new(ctx: &mut C, state: &C::AppState, props: Self::Properties, this_ref: ObjectRef) -> Self;

    fn create(props: Self::Properties) -> Factory<C> {
        Factory::new_static(move |ctx, state, this_ref| Self::new(ctx, state, props, this_ref))
            .set_updates(Self::UPDATES)
    }
}

/*/// High-level object interface
pub trait Object<C: Context>
{
    type EventType: Any;

    fn handle_event<R: Any>(
        &mut self,
        ctx: &mut C,
        state: &C::AppState,
        event: &Self::EventType,
        sender: Option<ObjectRef>
    ) -> Option<R>;
    /// Return true to enable updates on this object
    fn init(&mut self, ctx: &mut C, state: &C::AppState) -> bool;
    fn remove(&mut self, ctx: &mut C, state: &C::AppState);
    fn update(&mut self, ctx: &mut C, state: &C::AppState);
}

impl<
        C: Context,
        E: Any,
        O: Object<C, EventType = E> + Index
    > CoreObject<C> for O
{
    fn on_event(
        &mut self,
        ctx: &mut C,
        state: &C::AppState,
        event: &Box<dyn Any>,
        sender: Option<ObjectRef>
    ) -> Option<Box<dyn Any>>
    {
        if let Some(ev) = event.downcast_ref::<E>() {
            return self.handle_event(ctx, state, ev, sender);
        }
        return None;
    }

    fn on_init(&mut self, ctx: &mut C, state: &C::AppState) -> bool
    {
        return self.init(ctx, state);
    }

    fn on_remove(&mut self, ctx: &mut C, state: &C::AppState)
    {
        ctx.components_mut().clear(self.index());
        self.remove(ctx, state);
    }

    fn on_update(&mut self, ctx: &mut C, state: &C::AppState)
    {
        self.update(ctx, state);
    }

    fn class(&self) -> &str
    {
        //Not yet connected to reflection system
        return "Generic";
    }
}*/