Fixed a bug in deleteAllEntities beeing stuck with shouldBeKeeped ent…

…ities and added a safeDelete function

README.md

@@ -155,6 +155,13 @@ bool deleteEntity(const internal::ID &entityID);
 ```
 > **INFO**: For this and the following functions please see the [documentation](#documentation) or the [examples](#examples) for details on how to use them.
 
+If you are in an applyToEach loop or if you are iterating on entities better use safeDeleteEntity:
+```cpp
+void safeDeleteEntity(const internal::ID &entityID);
+```
+> **INFO**: For this and the following functions please see the [documentation](#documentation) or the [examples](#examples) for details on how to use them.
+> **INFO**: You will need to call in a safe spot (like your main loop the function `applySafeDelete` to take effects of safeDelete)
+
 The function used to retrieve an entity by its identifiers are as follow:
 ```cpp
 EntityHandler getEntityByID(const internal::ID &entityID);

sources/Entity.cpp

@@ -22,6 +22,7 @@ jf::entities::Entity::~Entity()
 {
  for (auto &i : _components) {
  delete i.second;
+ i.second = nullptr;
  }
  events::EventManager::getInstance().emit<events::EntityDestroyedEvent>({this});
 }

sources/EntityManager.cpp

@@ -17,7 +17,7 @@ jf::entities::EntityManager &jf::entities::EntityManager::getInstance()
 }
 
 jf::entities::EntityManager::EntityManager()
- : _maxId(0), _entities(), _freeIDs()
+ : _maxId(0), _entities(), _freeIDs(), _toDestroyIDs()
 {
 
 }
@@ -111,8 +111,26 @@ std::vector<jf::entities::EntityHandler> jf::entities::EntityManager::getEntitie
 
 void jf::entities::EntityManager::deleteAllEntities()
 {
- while (!_entities.empty()) {
- if (!_entities.begin()->second->shouldBeKeeped())
- deleteEntity(_entities.begin()->first);
+ auto entity = std::find_if(_entities.begin(), _entities.end(), [](const std::pair<internal::ID, Entity *> &pair) {
+ return !pair.second->shouldBeKeeped();
+ });
+ while (entity != _entities.end()) {
+ deleteEntity(entity->first);
+ entity = std::find_if(_entities.begin(), _entities.end(), [](const std::pair<internal::ID, Entity *> &pair) {
+ return !pair.second->shouldBeKeeped();
+ });
  }
-}
+}
+
+void jf::entities::EntityManager::safeDeleteEntity(const jf::internal::ID &entityID)
+{
+ _toDestroyIDs.push_back(entityID);
+}
+
+void jf::entities::EntityManager::applySafeDelete()
+{
+ for (auto &id : _toDestroyIDs) {
+ unregisterEntity(id);
+ }
+ _toDestroyIDs.clear();
+}

sources/EntityManager.hpp

@@ -79,12 +79,23 @@ namespace jf {
  * @return true if the entity existed and was deleted false otherwise
  */
  bool deleteEntity(const internal::ID &entityID);
+ /*!
+ * @brief Delete an entity given it's id
+ * @param entityID The id of the entity to delete
+ * @return true if the entity existed and was deleted false otherwise
+ */
+ void safeDeleteEntity(const internal::ID &entityID);
 
  /*!
  * @brief Delete all the existing entities except the ones marked as shouldBeKeeped
  */
  void deleteAllEntities();
 
+ /*!
+ * @brief Delete entities that have been marked for safe delete.
+ */
+ void applySafeDelete();
+
  /*!
  * @brief Get an entity given an ID
  * @param entityID The id of the entity to get
@@ -150,6 +161,7 @@ namespace jf {
  uint64_t _maxId; /*!< The last biggest existing entity */
  std::unordered_map<internal::ID, Entity *> _entities; /*!< A map containing all the existing entities */
  std::queue<internal::ID> _freeIDs; /*!< Ids destroyed and not used */
+ std::vector<internal::ID> _toDestroyIDs; /*!< Ids of entities to destroy */
  };
 
  template<typename C, typename... Others>