shura 0.6.0

A fast cross-plattform 2D component-based game framework
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

use crate::ArenaIndex;
use core::hash::Hash;

#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub(crate) struct ComponentIndex(pub(crate) ArenaIndex);
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
/// Unique identifier of a group
pub struct GroupHandle(pub(crate) ArenaIndex);
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub(crate) struct TypeIndex(pub(crate) ArenaIndex);

impl GroupHandle {
    pub const INVALID: Self = GroupHandle(ArenaIndex::INVALID);
    pub const DEFAULT_GROUP: Self = GroupHandle(ArenaIndex::FIRST);
}

impl ComponentIndex {
    pub const INVALID: Self = ComponentIndex(ArenaIndex::INVALID);
}

impl Default for GroupHandle {
    fn default() -> Self {
        Self::DEFAULT_GROUP
    }
}

/// Handle for a component. Through these handles components can be easily be fetched every frame
/// with a specific type through the [component](crate::ComponentManager::get) or
/// [component_mut](crate::ComponentManager::get_mut) method or without a specific type through the
/// [boxed_component](crate::ComponentManager::get_boxed) or
/// [boxed_component_mut](crate::ComponentManager::get_boxed_mut) method from the [context](crate::Context)
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ComponentHandle {
    component_index: ComponentIndex,
    type_index: TypeIndex,
    group_handle: GroupHandle,
}

impl ComponentHandle {
    pub const INVALID: Self = ComponentHandle {
        component_index: ComponentIndex(ArenaIndex::INVALID),
        type_index: TypeIndex(ArenaIndex::INVALID),
        group_handle: GroupHandle(ArenaIndex::INVALID),
    };
}

impl Default for ComponentHandle {
    fn default() -> Self {
        Self::INVALID
    }
}

impl ComponentHandle {
    pub(crate) const fn new(
        component_index: ComponentIndex,
        type_index: TypeIndex,
        group_handle: GroupHandle,
    ) -> Self {
        Self {
            component_index,
            type_index,
            group_handle,
        }
    }

    pub(crate) fn type_index(&self) -> TypeIndex {
        self.type_index
    }

    pub fn group_handle(&self) -> GroupHandle {
        self.group_handle
    }

    pub(crate) fn component_index(&self) -> ComponentIndex {
        self.component_index
    }

    pub fn index(&self) -> usize {
        self.component_index.0.index()
    }
}