SystemDirector.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 <trManager/TimingStructure.h>
#include <trManager/DirectorBase.h>
#include <trManager/MessageBase.h>
#include <trUtil/RefStr.h>
#include <trUtil/Timer.h>

namespace trCore
{

    class TR_CORE_EXPORT SystemDirector : public trManager::DirectorBase
    {
    public:
        using BaseClass = trManager::DirectorBase;      

        const static trUtil::RefStr CLASS_TYPE;         

        const static double MAX_TIME_SCALE;             
        const static double MIN_TIME_SCALE;             

        SystemDirector(const std::string name = CLASS_TYPE);

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

        virtual void OnMessage(const trManager::MessageBase& msg);

        virtual void Run();

        virtual void RunOnce();

        virtual bool IsRunning();

        virtual void ShutDown();

        trManager::TimingStructure GetTimeStructure();

    protected:

        ~SystemDirector();

        virtual void UpdateTiming(trManager::TimingStructure& timeStruct, double dt);

        virtual void EventTraversal(const trManager::TimingStructure& timeStruct);

        virtual void PostEventTraversal(const trManager::TimingStructure& timeStruct);

        virtual void PreFrame(const trManager::TimingStructure& timeStruct);

        virtual void CameraSynch(const trManager::TimingStructure& timeStruct);

        virtual void FrameSynch(const trManager::TimingStructure& timeStruct);

        virtual void Frame(const trManager::TimingStructure& timeStruct);

        virtual void PostFrame(const trManager::TimingStructure& timeStruct);

        virtual void SetTimeScale(const double timeScale);

        virtual void IncrementTimeScale();

        virtual void DecrementTimeScale();

        virtual void CheckForShutdown();

    private:

        bool mIsRunning = false;
        bool mIsShuttingDown = false;
        bool mIsPaused = false;
        trUtil::Timer mSystemTimer;

        trManager::TimingStructure mTimeStruct;
    };
}