MessageTick.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/RefStr.h>
#include <trBase/UniqueId.h>
#include <trManager/MessageBase.h>
#include <trManager/TimingStructure.h>

#include <string>

namespace trManager
{
    class TR_MANAGER_EXPORT MessageTick : public trManager::MessageBase
    {
    public:
        using BaseClass = trManager::MessageBase;           

        const static trUtil::RefStr MESSAGE_TYPE;           

        MessageTick(const trBase::UniqueId* fromActorID, const trManager::TimingStructure& timeStruct);

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

        const int& GetFrameNumber(void) const       { return(*mFrameNumber); }

        const double& GetDeltaSimTime(void) const           { return(*mDeltaSimTime); }

        const double& GetDeltaRealTime(void) const          { return(*mDeltaRealTime); }

        const double& GetSimTime(void) const    { return(*mSimTime); }

        const double& GetRealTime(void) const       { return(*mRealTime); }

        const double& GetTimeScale(void) const      { return(*mTimeScale); }

    protected:

        ~MessageTick();

    private:

        const int* mFrameNumber;       //Holds the current frame number.
        const double* mDeltaSimTime;   //Scaled Time between frames in seconds.
        const double* mDeltaRealTime;  //Non-scaled Time between frames.
        const double* mSimTime;        //Scaled time of the current simulation run.
        const double* mRealTime;       //Non-scaled time of the current simulation run.
        const double* mTimeScale;      //Time scaler

    };
}