amethyst_core 0.15.3

Amethyst core
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

//! ECS transform bundle

use amethyst_error::Error;
use specs_hierarchy::HierarchySystem;

use crate::{
    bundle::SystemBundle,
    ecs::prelude::{DispatcherBuilder, World},
    transform::*,
    SystemDesc,
};

/// Transform bundle
///
/// Will register transform components, and the `TransformSystem`.
/// `TransformSystem` will be registered with name "transform_system".
///
/// ## Errors
///
/// No errors will be returned by this bundle.
///
/// ## Panics
///
/// Panics in `TransformSystem` registration if the bundle is applied twice in the same dispatcher.
///
#[derive(Debug, Default)]
pub struct TransformBundle<'a> {
    dep: &'a [&'a str],
}

impl<'a> TransformBundle<'a> {
    /// Create a new transform bundle
    pub fn new() -> Self {
        TransformBundle {
            dep: Default::default(),
        }
    }

    /// Set dependencies for the `TransformSystem`
    pub fn with_dep(mut self, dep: &'a [&'a str]) -> Self {
        self.dep = dep;
        self
    }
}

impl<'a, 'b, 'c> SystemBundle<'a, 'b> for TransformBundle<'c> {
    fn build(
        self,
        world: &mut World,
        builder: &mut DispatcherBuilder<'a, 'b>,
    ) -> Result<(), Error> {
        builder.add(
            HierarchySystem::<Parent>::new(world),
            "parent_hierarchy_system",
            self.dep,
        );
        builder.add(
            TransformSystemDesc::default().build(world),
            "transform_system",
            &["parent_hierarchy_system"],
        );
        Ok(())
    }
}