Struct orbtk::StringComponentStore

pub struct StringComponentStore { /* fields omitted */ }

The StringComponentStore stores the components of entities and uses strings as component keys. It could be used to borrow the components of the entities.

Methods

impl StringComponentStore

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

Register a component for the given entity.

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

Registers a sharing of the given component between the given entities. Uses as source key the component key.

pub fn register_shared_by_source_key<C>(
    &mut self,
    key: &str,
    source_key: &str,
    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,
    key: &str,
    target: Entity,
    source: SharedComponentBox
)

Registers a sharing of the given component between the given entities. Uses as source key the component key.

pub fn register_shared_box_by_source_key(
    &mut self,
    key: &str,
    source_key: &str,
    target: Entity,
    source: SharedComponentBox
)

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

pub fn register_box(
    &mut self,
    key: &str,
    entity: 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, key: &str, entity: Entity) -> bool where
    C: Component, 

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

pub fn get<C>(&self, key: &str, 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,
    key: &str,
    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 StringComponentStore

fn default() -> StringComponentStore

Returns the "default value" for a type.

impl ComponentStore for StringComponentStore

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

fn append(
    &mut self,
    entity: Entity,
    components: <StringComponentStore 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 StringComponentStore

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

Formats the value using the given formatter.

impl System<Tree, StringComponentStore> for RenderSystem

fn run(&self, ecm: &mut EntityComponentManager<Tree, StringComponentStore>)

impl System<Tree, StringComponentStore> for EventStateSystem

fn run(&self, ecm: &mut EntityComponentManager<Tree, StringComponentStore>)

impl System<Tree, StringComponentStore> for LayoutSystem

fn run(&self, ecm: &mut EntityComponentManager<Tree, StringComponentStore>)

impl System<Tree, StringComponentStore> for InitSystem

fn run(&self, ecm: &mut EntityComponentManager<Tree, StringComponentStore>)

impl System<Tree, StringComponentStore> for PostLayoutStateSystem

fn run(&self, ecm: &mut EntityComponentManager<Tree, StringComponentStore>)