Timer.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

#ifndef _Timer_H__
#define _Timer_H__

#include "tools/ToolsPrereqs.h"
#include <functional>

#include "core/object/Listable.h"
#include "core/command/ExecutorPtr.h"

namespace orxonox
{
    unsigned int delay(float delay, const std::string& command);
    unsigned int delayreal(float delay, const std::string& command);

    unsigned int addDelayedCommand(Timer* timer, float delay, const std::string& command);
    void executeDelayedCommand(Timer* timer, const std::string& command);

    void killdelay(unsigned int handle);
    void killdelays();

    class _ToolsExport Timer : public Listable
    {
        public:
            Timer();

            Timer(float interval, bool bLoop, const ExecutorPtr& executor, bool bKillAfterCall = false);
            Timer(float interval, bool bLoop, std::function<void (void)> func, bool bKillAfterCall = false);

            void setTimer(float interval, bool bLoop, const ExecutorPtr& executor, bool bKillAfterCall = false);
            void setTimer(float interval, bool bLoop, std::function<void (void)> func, bool bKillAfterCall = false);

            void run();


            inline void startTimer()
                { this->bActive_ = true; this->time_ = this->interval_; }
            inline void stopTimer()
                { this->bActive_ = false; this->time_ = this->interval_; }
            inline void pauseTimer()
                { this->bActive_ = false; }
            inline void unpauseTimer()
                { this->bActive_ = true; }
            inline bool isActive() const
                { return this->bActive_; }
            inline float getRemainingTime() const
                { return static_cast<float>(this->time_ / 1000000.0f); }
            inline void addTime(float time)
                { if (time > 0.0f) this->time_ += static_cast<long long>(time * 1000000.0f); }
            inline void removeTime(float time)
                { if (time > 0.0f) this->time_ -= static_cast<long long>(time * 1000000.0f); }
            inline void setInterval(float interval)
                { this->interval_ = static_cast<long long>(interval * 1000000.0f); }
            inline void setLoop(bool bLoop)
                { this->bLoop_ = bLoop; }

            void tick(const Clock& time);

        protected:
            virtual float getTimeFactor();

        private:
            void init();

            ExecutorPtr executor_;  
            std::function<void (void)> function_;

            bool isStdFunction_;
            long long interval_;    
            bool bLoop_;            
            bool bActive_;          
            bool bKillAfterCall_;   

            long long time_;        
    };

    class _ToolsExport RealTimer : public Timer
    {
        public:
            RealTimer();
            RealTimer(float interval, bool bLoop, const ExecutorPtr& executor, bool bKillAfterCall = false);

        protected:
            virtual float getTimeFactor() override;
    };
}

#endif /* _Timer_H__ */