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 Zero(void);

            static GameTimer Infinity(void);

            GameTimer(void);

            GameTimer(const Milliseconds& valueMilliseconds);

            GameTimer(const GameTimer& other);

            ~GameTimer(void);

            GameTimer& operator=(const GameTimer& other);

            bool DecrementStep(void);

            bool IncrementStep(const GameTimer& maximumValue = Infinity());

            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);

            TurtleBrains::Game::GameTimer operator+(const TurtleBrains::Game::GameTimer& right) const;
            TurtleBrains::Game::GameTimer& operator+=(const TurtleBrains::Game::GameTimer& right);
            TurtleBrains::Game::GameTimer operator-(const TurtleBrains::Game::GameTimer& right) const;
            TurtleBrains::Game::GameTimer& operator-=(const TurtleBrains::Game::GameTimer& right);

        private:
            Milliseconds mMillisecondTimer;
            static Milliseconds sMillisecondsPerStep;
        };

        inline bool operator==(const TurtleBrains::Game::GameTimer& left, const TurtleBrains::Game::GameTimer& right)
        {
            return (left.GetElapsedTime() == right.GetElapsedTime()) ? true : false;
        }

        inline bool operator!=(const TurtleBrains::Game::GameTimer& left, const TurtleBrains::Game::GameTimer& right)
        {
            return (left.GetElapsedTime() != right.GetElapsedTime()) ? true : false;
        }

        inline bool operator>=(const TurtleBrains::Game::GameTimer& left, const TurtleBrains::Game::GameTimer& right)
        {
            return (left.GetElapsedTime() >= right.GetElapsedTime()) ? true : false;
        }

        inline bool operator<=(const TurtleBrains::Game::GameTimer& left, const TurtleBrains::Game::GameTimer& right)
        {
            return (left.GetElapsedTime() <= right.GetElapsedTime()) ? true : false;
        }

        inline bool operator>(const TurtleBrains::Game::GameTimer& left, const TurtleBrains::Game::GameTimer& right)
        {
            return (left.GetElapsedTime() > right.GetElapsedTime()) ? true : false;
        }

        inline bool operator<(const TurtleBrains::Game::GameTimer& left, const TurtleBrains::Game::GameTimer& right)
        {
            return (left.GetElapsedTime() < right.GetElapsedTime()) ? true : false;
        }

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

namespace tbGame = TurtleBrains::Game;

#endif /* _TurtleBrains_GameTimer_h_ */