Resource holding all the Registry entities. More...

#include <Entities.hpp>

Inheritance diagram for ecstasy::Entities:

Collaboration diagram for ecstasy::Entities:

[legend]

Classes
class	Builder
	Entities builder to add multiple component to an entity on creation. More...

Public Types
using	QueryData = Entity
	QueryableObject constraint

using	ConstQueryData = QueryData
	ConstQueryableObject constraint

Public Member Functions
	Entities ()
	Construct a new Entities resource without any entity.

Entity	create (bool alive=true)
	Create a new entity, alive or not.

Builder	builder ()
	Create a new entity builder.

Entity	get (Entity::Index id) const noexcept
	Retrieve an entity from its identifier.

bool	erase (Entity entity)
	Erase (delete) the entity when called.

size_t	erase (std::span< Entity > entities)
	Erase multiple entities when called.

bool	kill (Entity entity)
	Mark en entity for deletion.

bool	isAlive (Entity entity) const
	Tests if an entity is alive.

constexpr const util::BitSet &	getMask () const noexcept
	Get the Alive entities mask.

Entity	getQueryData (Entity::Index index) const
	Get the entity from its index.

std::vector< Entity >	maintain ()
	Effectively erase the entities marked for deletion (using kill()).

Public Member Functions inherited from ecstasy::IResource
virtual	~IResource ()=default
	Default destructor.

Private Attributes
std::vector< Entity::Generation >	_generations
	List of entity generations.

util::BitSet	_alive
	Mask of alive entities.

util::BitSet	_killed
	Mask of entities marked for deletion.

Detailed Description

Resource holding all the Registry entities.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-18)

Definition at line 30 of file Entities.hpp.

Member Typedef Documentation

◆ ConstQueryData

using ecstasy::Entities::ConstQueryData = QueryData

ConstQueryableObject constraint

Definition at line 164 of file Entities.hpp.

◆ QueryData

using ecstasy::Entities::QueryData = Entity

QueryableObject constraint

Definition at line 162 of file Entities.hpp.

Constructor & Destructor Documentation

◆ Entities()

ecstasy::Entities::Entities ( )

Construct a new Entities resource without any entity.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-18)

Add sentinel to allow use of firstUnset/firstSet

Definition at line 36 of file Entities.cpp.

    {
        _alive.push(false);
        _killed.push(true);
    }

Member Function Documentation

◆ builder()

Entities::Builder ecstasy::Entities::builder ( )

Create a new entity builder.

Returns: Builder Newly created builder.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-19)

Definition at line 65 of file Entities.cpp.

    {
        return Builder(*this, create(false));
    }

◆ create()

Entity ecstasy::Entities::create ( bool alive = true )

Create a new entity, alive or not.

Parameters

[in] alive Whether the entity must be created alive or not.

Returns: Entity Newly created entity.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-18)

No index available, need to add one at the end

Always add a sentinel bit

One index available, use it

Remove deletion marker

Definition at line 43 of file Entities.cpp.

    {
        size_t firstDead = _alive.firstUnset();
 
        if (firstDead == _generations.size()) {
            _generations.push_back(1);
            _alive[firstDead] = alive;
            _alive.push(false);
 
            return Entity(firstDead, 1);
        }
        _generations[firstDead]++;
        _alive[firstDead] = alive;
        if (firstDead < _killed.size() - 1)
            _killed[firstDead] = false;
        return Entity(firstDead, _generations[firstDead]);
    }

◆ erase() [1/2]

bool ecstasy::Entities::erase ( Entity entity )

Erase (delete) the entity when called.

Note: Entity is considered erased if it was alive.

Parameters

[in] entity Entity to erase.

Returns: bool Whether the entity was erased or not.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-18)

Definition at line 77 of file Entities.cpp.

    {
        Entity::Index id = entity.getIndex();
 
        if (id >= _generations.size() || entity.getGeneration() != _generations[id] || !_alive[id])
            return false;
        _alive[id] = false;
        return true;
    }

◆ erase() [2/2]

size_t ecstasy::Entities::erase ( std::span< Entity > entities )

Erase multiple entities when called.

Note: An entity is considered erased if it was alive before.

Parameters

[in] entities entities to erase.

Returns: size_t Number of entities erased.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-21)

Definition at line 87 of file Entities.cpp.

    {
        size_t res = 0;
 
        for (Entity entity : entities)
            res += erase(entity);
        return res;
    }

◆ get()

Entity ecstasy::Entities::get ( Entity::Index id ) const

noexcept

Retrieve an entity from its identifier.

Parameters

[in] id Index of the entity.

Returns: Entity

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-18)

Definition at line 70 of file Entities.cpp.

    {
        if (id >= _generations.size())
            return Entity(id, 0);
        return Entity(id, _generations[id]);
    }

◆ getMask()

constexpr const util::BitSet & ecstasy::Entities::getMask ( ) const

inlineconstexprnoexcept

Get the Alive entities mask.

Returns: const util::BitSet& alive entities mask.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-20)

Definition at line 269 of file Entities.hpp.

        {
            return _alive;
        }

◆ getQueryData()

Entity ecstasy::Entities::getQueryData ( Entity::Index index ) const

Get the entity from its index.

Note: QueryableObject constraints.

Returns: const Entity Entity at index index.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-20)

Definition at line 113 of file Entities.cpp.

    {
        return get(index);
    }

◆ isAlive()

bool ecstasy::Entities::isAlive ( Entity entity ) const

Tests if an entity is alive.

Parameters

[in] entity entity to test.

Returns: bool If the entity is alive.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-18)

Definition at line 108 of file Entities.cpp.

    {
        return entity.getGeneration() != 0 && entity.getIndex() < _generations.size() && _alive[entity.getIndex()];
    }

◆ kill()

bool ecstasy::Entities::kill ( Entity entity )

Mark en entity for deletion.

The entity is alive until a call to ecstasy::Entities::maintain() is made.

Parameters

[in] entity Entity to kill.

Returns: bool Whether or not the entity is marked for deletion.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-21)

Definition at line 96 of file Entities.cpp.

    {
        Entity::Index id = entity.getIndex();
 
        if (id >= _generations.size() || !_alive[id] || entity.getGeneration() != _generations[id])
            return false;
        if (id > _killed.size() - 1)
            _killed.resizeSentinel(id + 1, true);
        _killed[id] = true;
        return true;
    }

◆ maintain()

std::vector< Entity > ecstasy::Entities::maintain ( )

Effectively erase the entities marked for deletion (using kill()).

Note: Invalidate iterators.

Warning: This function doesn't delete the entities components, see Registry::maintain() instead.

Returns: std::vector<Entity> List of deleted entities.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-21)

Cannot emplace_back because constructor is private in the vector context :/

Definition at line 118 of file Entities.cpp.

    {
        std::vector<Entity> deleted;
        size_t firstKilled = _killed.firstSet();
 
        while (firstKilled != _killed.size() - 1) {
            _alive[firstKilled] = false;
            _killed[firstKilled] = false;
            deleted.push_back(Entity(firstKilled, _generations[firstKilled]));
            firstKilled = _killed.firstSet(firstKilled);
        }
        return deleted;
    }

Member Data Documentation

◆ _alive

util::BitSet ecstasy::Entities::_alive

private

Mask of alive entities.

Definition at line 303 of file Entities.hpp.

◆ _generations

std::vector<Entity::Generation> ecstasy::Entities::_generations

private

List of entity generations.

Definition at line 301 of file Entities.hpp.

◆ _killed

util::BitSet ecstasy::Entities::_killed

private

Mask of entities marked for deletion.

Definition at line 305 of file Entities.hpp.

The documentation for this class was generated from the following files:

src/ecstasy/resources/entity/Entities.hpp
src/ecstasy/resources/entity/Entities.cpp

Classes

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ConstQueryData

◆ QueryData

Constructor & Destructor Documentation

◆ Entities()

Member Function Documentation

◆ builder()

◆ create()

◆ erase() [1/2]

◆ erase() [2/2]

◆ get()

◆ getMask()

◆ getQueryData()

◆ isAlive()

◆ kill()

◆ maintain()

Member Data Documentation

◆ _alive

◆ _generations

◆ _killed