rollback_doc/entity_8h_source.html

#pragma once


#include <cstdint>

#include <vector>

#include <limits>


namespace core

{

using Entity = std::uint32_t;

using EntityMask = std::uint32_t;

constexpr Entity INVALID_ENTITY = std::numeric_limits<Entity>::max();

constexpr EntityMask INVALID_ENTITY_MASK = 0u;

class EntityManager

{

public:

    EntityManager();

    EntityManager(std::size_t reservedSize);

    Entity CreateEntity();

    void DestroyEntity(Entity entity);

    void AddComponent(Entity entity, EntityMask mask);

    void RemoveComponent(Entity entity, EntityMask mask);

    [[nodiscard]] bool HasComponent(Entity entity, EntityMask mask) const;

    [[nodiscard]] bool EntityExists(Entity entity) const;

    [[nodiscard]] std::size_t GetEntitiesSize() const;


private:

    std::vector<EntityMask> entityMasks_;

};


} // namespace core

core::EntityManager
Manages the entities in an array using bitwise operations to know if it has components.
Definition: entity.h:35

core::EntityManager::DestroyEntity
void DestroyEntity(Entity entity)
DestroyEntity is a method that will erase all Component from the EntityMask. It means that EntityExis...
Definition: entity.cpp:44

core::EntityManager::GetEntitiesSize
std::size_t GetEntitiesSize() const
GetEntitiesSize is a method that returns the size of the EntityMask array.
Definition: entity.cpp:69

core::EntityManager::CreateEntity
Entity CreateEntity()
CreateEntity is a method that will return the next available Entity index. It will look at the intern...
Definition: entity.cpp:19

core::EntityManager::AddComponent
void AddComponent(Entity entity, EntityMask mask)
AddComponent is a method that adds the bitwise entity mask to the entity mask. It is normally called ...
Definition: entity.cpp:50

core::EntityManager::EntityExists
bool EntityExists(Entity entity) const
EntityExists is a method that check if a certain Entity has any Component and thus do exist.
Definition: entity.cpp:63

core::EntityManager::RemoveComponent
void RemoveComponent(Entity entity, EntityMask mask)
RemoveComponent is a method that removes the bitwise entity mask to the entity mask.
Definition: entity.cpp:56

core::EntityManager::HasComponent
bool HasComponent(Entity entity, EntityMask mask) const
HasComponent is a method that check if a certain Entity has a EntityMask on.
Definition: entity.cpp:74

core::EntityMask
std::uint32_t EntityMask
EntityMask is the type used to define the bitwise mask of an Entity. It is used to know what Componen...
Definition: entity.h:22

core::INVALID_ENTITY
constexpr Entity INVALID_ENTITY
INVALID_ENTITY is a constant that define an invalid Entity.
Definition: entity.h:26

core::INVALID_ENTITY_MASK
constexpr EntityMask INVALID_ENTITY_MASK
INVALID_ENTITY_MASK is a constant that define an invalid or empty entity mask.
Definition: entity.h:30

core::Entity
std::uint32_t Entity
Entity is the type used to define an game world entity. An Entity is just an index,...
Definition: entity.h:17