Struct shard_ecs::descriptors::archetype_descriptor::ArchetypeDescriptor

pub struct ArchetypeDescriptor { /* fields omitted */ }

Represents a combination of components. Each component type MUST be unique (i.e. no duplicate component types). Length must be larger than 0 and lower or equal to MAX_COMPONENTS_PER_ENTITY. Use the ArchetypeDescriptor::is_valid function to check for validity. Any use of an invalid archetype descriptor is considered UB.

Implementations

impl ArchetypeDescriptor

pub const INVALID: ArchetypeDescriptor

The invalid archetype descriptor. Has 0 components and an ArchetypeId of 0.

pub const fn is_valid(&self) -> bool

Returns true if it is a valid archetype. A valid archetype has a length larger than 0 and smaller than MAX_COMPONENTS_PER_ENTITY. It also contains no duplicate components.

pub const fn new(
    archetype_id: ArchetypeId,
    len: u8,
    components: [ComponentDescriptor; 14]
) -> Self

Creates a new archetype descriptor with the given id, length and components.

pub const fn compute_archetype_id(
    descriptors: &[ComponentDescriptor]
) -> ArchetypeId

Computes an archetype ID, returns ArchetypeId::INVALID if given an invalid combination of components.

pub const fn contains_subset(&self, descriptor: &ArchetypeDescriptor) -> bool

Returns whether the descriptor provided is contained in self. (i.e. subset inclusion) Do not provide an invalid descriptor to this!

pub const fn excludes_subset(&self, descriptor: &ArchetypeDescriptor) -> bool

Returns whether the descriptor provided is excluded from self. (i.e. subset exclusion) Do not provide an invalid descriptor to this!

pub fn add_component_from<C: Component>(&self) -> Option<ArchetypeDescriptor>

Returns a new archetype with the given component type added to it. Returns none if the current archetype already contains the component type or it is full.

pub fn add_component(
    &self,
    component_descriptor: &ComponentDescriptor
) -> Option<ArchetypeDescriptor>

Returns a new archetype with the given component type added to it. Returns none if the current archetype already contains the component type or it is full.

pub fn remove_component(
    &self,
    component: ComponentTypeId
) -> Option<ArchetypeDescriptor>

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

Returns whether the archetype descriptor has a given component type.

pub const fn archetype_id(&self) -> ArchetypeId

Get a the archetype descriptor’s archetype id.

pub const fn len(&self) -> u8

Get the archetype descriptor’s component count.

pub const unsafe fn components_unchecked(&self) -> &[ComponentDescriptor; 14]

Get a reference to the archetype descriptor’s components. This version is const but unsafe, as length is NOT accounted for. Therefore any descriptor past the len is considered invalid or garbage data.

pub fn components(&self) -> &[ComponentDescriptor]

Get a reference to the archetype descriptor’s components.

Trait Implementations

impl Clone for ArchetypeDescriptor

fn clone(&self) -> ArchetypeDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArchetypeDescriptor

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

Formats the value using the given formatter.

impl Into<ArchetypeDescriptor> for &ComponentDescriptor

fn into(self) -> ArchetypeDescriptor

Performs the conversion.

impl Into<ArchetypeDescriptor> for ComponentDescriptor

fn into(self) -> ArchetypeDescriptor

Performs the conversion.