EntityGroup.h

// Copyright QED Software 2023.
 
#ifndef GRAIL_ENTITY_GROUP_H
#define GRAIL_ENTITY_GROUP_H
 
#include "AIEntity.hh"
#include "Blackboard.hh"
 
#include <string>
#include <vector>
 
namespace grail
{
    //REVIEW: this is an internal struct, but consider at least dox comment for us about its purpose
    struct EntityEntry
    {
        std::shared_ptr<AIEntity> entity;
        int relativePriority;
 
        EntityEntry(const std::shared_ptr<AIEntity>& entity, int relativePriority);
    };
 
    class EntityGroup
    {
    public:
        EntityGroup(const std::string& name);
        EntityGroup(const std::string& name, const std::vector<EntityEntry>& entityEntries);
 
        const std::string& GetName() const;
 
        void SetId(size_t id);
        size_t GetId() const;
 
        void AddEntityEntry(const std::shared_ptr<AIEntity>& entity, int relativePriority);
        void RemoveEntityEntry(const AIEntity& entity);
        void AddGroupBlackboard(const std::string& name, const std::shared_ptr<Blackboard>& blackboard);
        void AddGlobalBlackboardMapping(std::shared_ptr<AIEntity> entity,
                                        const std::vector<std::string>& blackboardNames);
 
        std::shared_ptr<AIEntity> GetEntity(const std::string& name) const;
        const std::vector<EntityEntry>& GetEntityEntries() const;
        const std::vector<std::pair<std::string, std::shared_ptr<Blackboard>>>& GetGroupBlackboards() const;
        const std::vector<std::pair<std::shared_ptr<AIEntity>, std::vector<std::string>>>&
        GetGlobalBlackboardMapping() const;
    private:
        std::string name{};
        size_t id = std::numeric_limits<size_t>::max();
        std::vector<EntityEntry> entityEntries{};
        std::vector<std::pair<std::string, std::shared_ptr<Blackboard>>> groupBlackboards{};
        std::vector<std::pair<std::shared_ptr<AIEntity>, std::vector<std::string>>> globalBlackboardMapping{};
    };
}
 
#endif