maple_engine 0.3.0

Engine implementation of maple engine
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

//! containers are used to store data within the scene they can store any clonable item. this
//! since you cant add fields to pre defined nodes containers can be used to store relevent data.
//!
//! think of it as a Node that wraps around a non-node
//!
//! # Example
//! ```rust
//! use maple::nodes::Container;
//! let container = Container::new(15.0);
//!
//! assert_eq!(*container.get_item(), 15.0);
//! ```

use super::Node;
use super::node_builder::{Builder, NodePrototype};
use crate::components::NodeTransform;

/// containers can store arbitrary data with the scene
pub struct Container<T> {
    item: T,
    transform: NodeTransform,
}

impl<T> Container<T> {
    /// create a container with a contained item
    pub fn new(item: T) -> Container<T>
    where
        T: Clone,
    {
        Container {
            item,
            transform: NodeTransform::default(),
        }
    }

    /// get the stored item
    pub fn get_item(&self) -> &T {
        &self.item
    }

    /// get the stored item mut
    pub fn get_item_mut(&mut self) -> &mut T {
        &mut self.item
    }

    /// to use in the container Builder
    ///
    /// most of the time this is overboard. use [`Container::new()`]
    pub fn builder(item: T) -> ContainerBuilder<T> {
        ContainerBuilder {
            item,
            prototype: NodePrototype::default(),
        }
    }
}

impl<T> Node for Container<T>
where
    T: Clone + Send + Sync + 'static,
{
    fn get_transform(&mut self) -> &mut NodeTransform {
        &mut self.transform
    }
}

/// builder implementation for container
///
/// Most of the time a builder is overkill for a container but is implemented for consistancy
pub struct ContainerBuilder<T> {
    item: T,
    prototype: NodePrototype,
}

impl<T: Clone + Send + Sync + 'static> Builder for ContainerBuilder<T> {
    type Node = Container<T>;

    fn prototype(&mut self) -> &mut super::node_builder::NodePrototype {
        &mut self.prototype
    }

    fn build(self) -> Self::Node {
        Container {
            transform: self.prototype.transform,
            item: self.item.clone(),
        }
    }
}

impl<T> ContainerBuilder<T> {
    /// set the item stored in the container
    pub fn item(&mut self, item: T) -> &mut Self {
        self.item = item;
        self
    }
}

#[cfg(test)]
mod test {
    use crate::nodes::Container;

    #[test]
    fn test_container() {
        let container = Container::new(13);
        assert!(container.item == 13);
    }
}