Struct orbtk::ComponentStore

pub struct ComponentStore { /* fields omitted */ }

The TypeComponentStore stores the components of all entities. It could be used to borrow the components of the entities.

Methods

impl TypeComponentStore

pub fn register<C>(&mut self, entity: Entity, component: C) where
    C: Component, 

Register a component for the given entity.

pub fn register_shared<C>(&mut self, target: Entity, source: Entity) where
    C: Component, 

Registers a sharing of the given component between the given entities.

pub fn register_shared_box(
    &mut self,
    target: impl Into<Entity>,
    source: SharedComponentBox
)

Registers a sharing of the given component between the given entities.

pub fn register_box(
    &mut self,
    entity: impl Into<Entity>,
    component_box: ComponentBox
)

Register a component_box for the given entity.

pub fn len(&self) -> usize

Returns the number of components in the store.

pub fn is_empty(&self) -> bool

Returns true if the components are empty.

pub fn contains_entity(&self, entity: Entity) -> bool

Returns true if the store contains the specific entity.

pub fn is_origin<C>(&self, entity: Entity) -> bool where
    C: Component, 

Returns true if entity is the origin of the requested component false.

pub fn get<C>(&self, entity: Entity) -> Result<&C, NotFound> where
    C: Component, 

Returns a reference of a component of type C from the given entity. If the entity does not exists or it doesn't have a component of type C NotFound will be returned.

pub fn get_mut<C>(&mut self, entity: Entity) -> Result<&mut C, NotFound> where
    C: Component, 

Returns a mutable reference of a component of type C from the given entity. If the entity does not exists or it doesn't have a component of type C NotFound will be returned.

Trait Implementations

impl Default for TypeComponentStore

fn default() -> TypeComponentStore

Returns the "default value" for a type.

impl ComponentStore for TypeComponentStore

type Components = (HashMap<TypeId, Box<dyn Any + 'static>, RandomState>, HashMap<TypeId, Entity, RandomState>)

fn append(
    &mut self,
    entity: Entity,
    components: <TypeComponentStore as ComponentStore>::Components
)

fn remove_entity(&mut self, entity: impl Into<Entity>)

Removes and entity from the store.

fn print_entity(&self, entity: impl Into<Entity>)

Print infos about the given entity.

impl Debug for TypeComponentStore

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.