Entity.h

/*

Copyright (c) 2018, Johnathan Corkery. (jcorkery@umich.edu)
All rights reserved.

This file is part of the Dynacoe project (https://github.com/jcorks/Dynacoe)
Dynacoe was released under the MIT License, as detailed below.



Permission is hereby granted, free of charge, to any person obtaining a copy 
of this software and associated documentation files (the "Software"), to deal 
in the Software without restriction, including without limitation the rights 
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
copies of the Software, and to permit persons to whom the Software is furnished 
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall
be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
DEALINGS IN THE SOFTWARE.



*/


#ifndef DWORLD_H_INCLUDED
#define DWORLD_H_INCLUDED

#include <Dynacoe/AssetID.h>
#include <Dynacoe/Variable.h>
#include <Dynacoe/Spatial.h>
#include <set>
#include <vector>
#include <unordered_map>
#include <unordered_set>
#include <stack>

namespace Dynacoe {
class Component;
class UintToID;
class Entity : public Spatial {

  public:
      class ID {
        public:
          ~ID();
          ID() : id(nullptr){};
          ID(const std::string & str);
          ID(uint64_t value);
          ID(const ID &);
          ID & operator=(const ID & other);

          bool operator==(const ID & other) const {
              return other.id == id;
          }
          bool operator!=(const ID & other) const {
              return other.id != id;
          }
          uint64_t Value() const { return (uint64_t)id; }

          Entity * Identify() const;
          
          const std::string & String() const;

          template<typename T>
          T * Query() {
              if (!Valid()) return nullptr;
              return Identify()->QueryComponent<T>();
          }


          friend bool operator<(const Entity::ID & l, const Entity::ID & r) {
              return l.id < r.id;
          }
          template<typename T>
          T * IdentifyAs() const { return dynamic_cast<T*>(Identify()); }

          bool Valid() const;

        private:
          void * id;

          friend class Entity;

      };


    using   Priority    = int64_t;




    const std::vector<Entity::ID> & GetChildren() const;


    std::vector<Entity::ID> GetAllSubEntities() const;

    bool Contains(Entity::ID);


    std::vector<Entity::ID> FindChildByName(const std::string &);

    void Step();

    void Draw();

    void Attach(Entity::ID);
    void Attach(Entity &);

    void Detach(Entity::ID);






    template<typename T>
    T * CreateChild() {
        T * out = new T();
        Attach(out->GetID());
        return out;
    }

    template<typename T>
    static Entity::ID Create() {
        T * out = new T();
        return out->GetID();
    }
    
    static Entity::ID Create() {
        return (new Entity)->GetID();
    }
    template<typename T>
    
    static T * CreateReference() {
        return new T;
    }


    int GetNumChildren();






    double StepDuration();

    double DrawDuration();















    void Watch(Variable v);

    Variable GetWatched(const std::string & name);

    std::vector<Variable> GetWatchedVars();

    void Unwatch(const std::string & varName);




    void SetPriority(Priority p);

    void SetPriorityLast();

    void SetPriorityFirst();

    Priority GetPriority();







    bool step;

    bool draw;


    bool IsStepping();

    bool IsDrawing();



    Entity & GetParent();

    bool HasParent();



    enum class UpdateClass {
        Before, 
        After   
    };



    template <typename T>
    T * AddComponent(UpdateClass when = UpdateClass::Before) {
        T * c = new T;
        AddComponentInternal(c, when);
        return c;
    }

    template<typename T>
    T * QueryComponent();


    const std::vector<Component *> & GetComponents() const;

    void RemoveComponent(const std::string & tag);

    void RemoveComponent(const Component *);




    void Remove();





    void SetName(const std::string & name);

    ID GetID();

    std::string GetName();



    static std::vector<Entity::ID> GetAll();



    virtual ~Entity();













  protected:

    Entity();
    Entity(const std::string &);





    virtual void OnEnter(){}

    virtual void OnDepart(){}


    virtual void OnRemove(){}


    virtual void OnPreStep(){}

    virtual void OnStep(){}


    virtual void OnPreDraw(){}

    virtual void OnDraw(){}


    void * operator new(std::size_t);
    void * operator new[](std::size_t);
    void operator delete(void * ptr);
    void operator delete[](void * ptr);


  private:




     void AddComponentInternal(Component * c, UpdateClass);
    friend class Engine;

     bool WasDetachedMidExecution(Entity::ID id);
     void priorityListQueueAdd(Entity::ID);
     void priorityListQueueRemove(Entity::ID);
     void priorityListAdd(Entity::ID);
     void priorityListRemove(int);
     void initBase();
     int getNewEntID();



     std::vector<Entity::ID> PriorityList;     // normal entity list




     std::set<Variable> watchList;

     Entity::ID id;
     std::string name;
     Entity * world;




     int64_t priority;



     void * idTable;
     bool protectd;
     bool removed;

     double stepTime;
     double drawTime;
     static uint64_t idPool;


     std::vector<Component *> componentsBefore;
     std::vector<Component *> componentsAfter;
     std::vector<Component *> components;
     friend void EntityErase(Entity * e);
};




template<typename T>
T * Entity::QueryComponent() {
    for(int i = 0; i < componentsBefore.size(); ++i) {
        if (dynamic_cast<T *>(componentsBefore[i])) {
            return static_cast<T *>(componentsBefore[i]);
        }
    }

    for(int i = 0; i < componentsAfter.size(); ++i) {
        if (dynamic_cast<T *>(componentsAfter[i])) {
            return static_cast<T *>(componentsAfter[i]);
        }
    }

    return nullptr;
}
void EntityErase(Entity * e);

};


#endif // DSPAWNED_H_INCLUDED