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

use crate::ecs::prelude::{Component, DenseVecStorage, Entity, FlaggedStorage};

pub use specs_hierarchy::HierarchyEvent;
use specs_hierarchy::{Hierarchy, Parent as HParent};

/// An alias to tie `specs-hierarchy` `Hierarchy` structure to our `Parent` component.
pub type ParentHierarchy = Hierarchy<Parent>;

/// Component for defining a parent entity.
///
/// The entity with this component *has* a parent, rather than *is* a parent.
///
/// If the parent entity contains a transform, then the child's transform
/// will be applied relative to the parent's transform. For example, if a
/// parent rotates 45 degrees around the Z axis, then the child's coordinate
/// system will start out also rotated by 45 degrees around the Z axis.
///
/// If the parent entity has its own parent (and so on) then the transforms
/// will all be applied in order from the oldest ancestor to the child.
#[derive(Debug, Clone, Eq, Ord, PartialEq, PartialOrd, new)]
pub struct Parent {
    /// The parent entity
    pub entity: Entity,
}

impl Component for Parent {
    type Storage = FlaggedStorage<Self, DenseVecStorage<Self>>;
}

impl HParent for Parent {
    fn parent_entity(&self) -> Entity {
        self.entity
    }
}