Struct legion::storage::EntityLayout

pub struct EntityLayout { /* fields omitted */ }

Describes the component types which are attached to an entity.

Implementations

impl EntityLayout

pub fn new() -> Self

Constructs a new entity layout.

pub fn register_component<T: Component>(&mut self)

Adds a new component to the layout.

pub unsafe fn register_component_raw(
    &mut self,
    type_id: ComponentTypeId,
    f: fn() -> Box<dyn UnknownComponentStorage>
)

Adds a new component to the layout.

Safety

The storage returned from the storage constructor function must be capable of storing the component type identified by type_id.

pub fn component_types(&self) -> &[ComponentTypeId]

Returns a slice of component type IDs for the components inside the layout.

pub fn has_component<T: Component>(&self) -> bool

Returns true if the layout contains the given component type.

pub fn has_component_by_id(&self, type_id: ComponentTypeId) -> bool

Returns true if the layout contains the given component type.

Trait Implementations

impl Clone for EntityLayout

fn clone(&self) -> EntityLayout

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EntityLayout

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

Formats the value using the given formatter.

impl Default for EntityLayout

fn default() -> EntityLayout

Returns the “default value” for a type.

impl LayoutFilter for EntityLayout

fn matches_layout(&self, components: &[ComponentTypeId]) -> FilterResult

Calculates the filter’s result for the given entity layout.