EntityBase.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 3.0 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author Maxim Serebrennik
*/

#pragma once

#include "Export.h"

#include <trUtil/EnumerationNumeric.h>
#include <trManager/EntityType.h>
#include <trManager/Invokable.h>
#include <trUtil/HashMap.h>
#include <trBase/ObsrvrPtr.h>
#include <trBase/SmrtPtr.h>
#include <trBase/Base.h>

#include <vector>

namespace trManager
{
    class SystemManager;

    class  TR_MANAGER_EXPORT EntityBase : public trBase::Base
    {
    public:

        using BaseClass = trBase::Base;                         

        const static trUtil::RefStr CLASS_TYPE;                 

        const static trUtil::RefStr ON_MESSAGE_INVOKABLE;               
        const static trUtil::RefStr ON_TICK_INVOKABLE;                  
        const static trUtil::RefStr ON_TICK_REMOTE_INVOKABLE;           

        EntityBase(const std::string& name = CLASS_TYPE);

        virtual const std::string& GetType() const override = 0;

        const EntityType& GetEntityType();

        virtual void SetSystemManager(trManager::SystemManager *sysMan);

        virtual void OnAddedToSysMan() {/*Meant for user to overwrite*/ };

        virtual void OnRemovedFromSysMan() {/*Meant for user to overwrite*/ };

        virtual const bool& IsRegistered();

        virtual void SetRegistration(bool isRegistered);

        virtual void AddInvokable(trManager::Invokable &newInvokable);

        virtual void RemoveInvokable(trManager::Invokable *invokable);

        virtual void RemoveInvokable(const std::string &invokableName);

        trManager::Invokable* GetInvokable(const std::string &name);

        void GetInvokables(std::vector<trManager::Invokable*> &toFill);

        void GetInvokables(std::vector<const trManager::Invokable*> &toFill) const;

        virtual void OnTick(const trManager::MessageBase &msg) = 0;

        virtual void OnTickRemote(const trManager::MessageBase &msg) = 0;

        virtual bool AddChild(trManager::EntityBase &child);

        virtual bool RemoveChild(trManager::EntityBase &child);

        virtual bool RemoveAllChildren();

        virtual std::vector<trBase::SmrtPtr<trManager::EntityBase>>* GetChildren();

        virtual const std::vector<trBase::SmrtPtr<trManager::EntityBase>>* GetChildren() const;

        virtual const trManager::EntityBase* FindChild(const trBase::UniqueId& childId);

        virtual int GetNumOfChildren();

        virtual void SetParent(trManager::EntityBase &parent);

        virtual void ForgetParent();

        trManager::EntityBase* GetParent();

        const trManager::EntityBase* GetParent() const;

        virtual void OnParentRemoved(trManager::EntityBase &parent);

        virtual void OnParentSet(trManager::EntityBase &parent);


        virtual void Emancipate();

        virtual bool RemoveFromHierarchy();

    protected:

        trBase::ObsrvrPtr<trManager::SystemManager> mSysMan;
        trUtil::EnumerationPointer<const trManager::EntityType> mEntityType;
        trUtil::HashMap<std::string, trBase::SmrtPtr<trManager::Invokable>> mInvokables;  //<invokable name, invokable>

        ~EntityBase();

    private:

        bool mIsRegistered = false;
        std::vector<trBase::SmrtPtr<trManager::EntityBase>> mChildren;
        trBase::SmrtPtr<trManager::EntityBase> mParent;

    };
}