alecthomas / entityx

EntityX - A fast, type-safe C++ Entity-Component system
MIT License
2.23k stars 295 forks source link

UUIDCollisionResolver #227

Open NukeBird opened 5 years ago

NukeBird commented 5 years ago

I'm trying to integrate cereal serialization library with entityx

Also I have read https://github.com/alecthomas/entityx/issues/117, https://github.com/alecthomas/entityx/issues/14 and https://github.com/alecthomas/entityx/issues/25

I got four basic ideas:

  1. We should use custom UUID component instead of Entity id
  2. For serialization we should check manually if entity has specific components (and, well, iterate through all of them)
  3. (because of 2) We should manually decide what components should be registered and how components should be serialized/deserialized
  4. To iterate over all alive entities we must use entities_for_debugging(). It marked "not very fast, so should only be used for debugging", but well I don't see any other alternatives for serialization

My big question is: how elegantly implement UUIDCollisionResolver? I mean, UUIDGenerator automatically attaches UUID component for every new Entity, and when we try to deserialize some entities from external file here is high probability that UUIDs of that entities are already taken

Also, some components can store UUID in themselves, so UUID must be replaced with a correct one too

To be more specific, lets say we have such components:

struct UUID
{
    //UUID(...) {...}

    uint32_t value;
};

struct TreeNode
{
    //TreeNode(...) {...}

    std::string name;
};

struct Transform
{
    //Transform(...) {...}

    glm::vec3 position;
    glm::vec3 scale;
    glm::vec3 rotation;

    bool is_dirty;
    glm::mat4 cache;

    UUID parent;
    std::list<UUID> childs; 
};
NukeBird commented 5 years ago

I have such idea:

  1. Create an DeserializationStarted and DeserializationEnded events
  2. When DeserializationStarted emits, UUIDGenerator will stop automatically attach new UUIDs + all new entities will be stored in temporal buffer
  3. When DeserializationEnded emits, temporal buffer should be merged with "global id buffer" with collision resolving step (we can use std::map which will map UUID to the "corrected UUID" (they are the same if here is no collisions))
NukeBird commented 5 years ago

But, well, I think here must be another way to do exactly same thing