Timer.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2015 Jan Haller
// 
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
// 
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
// 
// 1. The origin of this software must not be misrepresented; you must not
//    claim that you wrote the original software. If you use this software
//    in a product, an acknowledgment in the product documentation would be
//    appreciated but is not required.
// 
// 2. Altered source versions must be plainly marked as such, and must not be
//    misrepresented as being the original software.
// 
// 3. This notice may not be removed or altered from any source distribution.
//


#ifndef THOR_TIMER_HPP
#define THOR_TIMER_HPP

#include <Thor/Time/StopWatch.hpp>
#include <Thor/Config.hpp>

#include <SFML/System/Time.hpp>


namespace thor
{


class THOR_API Timer
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
                                    Timer();

        virtual                     ~Timer();

        sf::Time                    getRemainingTime() const;

        bool                        isRunning() const;

        bool                        isExpired() const;

        void                        start();

        void                        stop();

        virtual void                reset(sf::Time timeLimit);

        virtual void                restart(sf::Time timeLimit);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        StopWatch                   mStopWatch;
        sf::Time                    mLimit;
};


} // namespace thor

#endif // THOR_TIMER_HPP