tb_game_timer.h

#ifndef _TurtleBrains_GameTimer_h_
#define _TurtleBrains_GameTimer_h_

#include "../core/tb_types.h"

namespace TurtleBrains
{
    namespace Game
    {

        class GameTimer
        {
        public:
            typedef tbCore::uint32 Milliseconds;

            static GameTimer kZero;

            GameTimer(void);

            explicit GameTimer(const Milliseconds& valueMilliseconds);

            GameTimer(const GameTimer& other);

            ~GameTimer(void);

            GameTimer& operator=(const GameTimer& other);

            bool DecrementStep(void);

            void IncrementStep(void);

            bool IsZero(void) const;

            const Milliseconds& GetElapsedTime(void) const;

            const Milliseconds& GetRemainingTime(void) const;

            float GetPercentageOf(const GameTimer& timeValue) const;

            static float ToSeconds(const Milliseconds& valueMilliseconds);

            static Milliseconds ToMilliseconds(const float& valueSeconds);

            static void SetMillisecondsPerStep(const Milliseconds& millisecondsPerStep);

            static Milliseconds GetMillisecondsPerStep(void);

            static float GetSecondsPerStep(void);

        private:
            Milliseconds mMillisecondTimer;
            static Milliseconds sMillisecondsPerStep;
        };

    }; /* namespace Game */
}; /* namespace TurtleBrains */

namespace tbGame = TurtleBrains::Game;

#endif /* _TurtleBrains_GameTimer_h_ */