Bromeon
Time/TriggeringTimer.hpp
Go to the documentation of this file.
00001 
00002 //
00003 // Thor C++ Library
00004 // Copyright (c) 2011 Jan Haller
00005 // 
00006 // This software is provided 'as-is', without any express or implied
00007 // warranty. In no event will the authors be held liable for any damages
00008 // arising from the use of this software.
00009 // 
00010 // Permission is granted to anyone to use this software for any purpose,
00011 // including commercial applications, and to alter it and redistribute it
00012 // freely, subject to the following restrictions:
00013 // 
00014 // 1. The origin of this software must not be misrepresented; you must not
00015 //    claim that you wrote the original software. If you use this software
00016 //    in a product, an acknowledgment in the product documentation would be
00017 //    appreciated but is not required.
00018 // 
00019 // 2. Altered source versions must be plainly marked as such, and must not be
00020 //    misrepresented as being the original software.
00021 // 
00022 // 3. This notice may not be removed or altered from any source distribution.
00023 //
00025 
00028 
00029 #ifndef THOR_TRIGGERINGTIMER_HPP
00030 #define THOR_TRIGGERINGTIMER_HPP
00031 
00032 #include <Thor/Time/Timer.hpp>
00033 #include <Thor/Detail/EventListener.hpp>
00034 #include <Thor/Config.hpp>
00035 
00036 
00037 namespace thor
00038 {
00039 
00042 
00046 class THOR_API TriggeringTimer : public Timer
00047 {   
00048     // ---------------------------------------------------------------------------------------------------------------------------
00049     // Public types
00050     public:
00053         typedef std::tr1::function< void(TriggeringTimer&) >    Listener;
00054 
00055 
00056     // ---------------------------------------------------------------------------------------------------------------------------
00057     // Public member functions
00058     public:
00061                                     TriggeringTimer();
00062     
00066         explicit                    TriggeringTimer(float timeLimit, bool initiallyRunning = false);
00067         
00071         virtual void                Reset(float timeLimit, bool continueRunning = false);
00072 
00077         void                        Update();
00078         
00083         Connection                  Connect(const Listener& listener);
00084             
00087         void                        ClearConnections();
00088     
00089     
00090     // ---------------------------------------------------------------------------------------------------------------------------
00091     // Private types
00092     private:
00093         typedef detail::ListenerSequence< TriggeringTimer& >        ListenerCtr;
00094         
00095 
00096     // ---------------------------------------------------------------------------------------------------------------------------
00097     // Private variables
00098     private:
00099         ListenerCtr                 mListeners;
00100         bool                        mJustExpired;
00101 };
00102 
00104 
00105 } // namespace thor
00106 
00107 #endif // THOR_TRIGGERINGTIMER_HPP