Bromeon
Time/TriggeringTimer.hpp
Go to the documentation of this file.
00001 
00002 //
00003 // Thor C++ Library
00004 // Copyright (c) 2011-2012 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 #include <SFML/System/Time.hpp>
00037 
00038 
00039 namespace thor
00040 {
00041 
00044 
00048 class THOR_API TriggeringTimer : public Timer
00049 {   
00050     // ---------------------------------------------------------------------------------------------------------------------------
00051     // Public types
00052     public:
00055         typedef std::tr1::function< void(TriggeringTimer&) >    Listener;
00056 
00057 
00058     // ---------------------------------------------------------------------------------------------------------------------------
00059     // Public member functions
00060     public:
00063                                     TriggeringTimer();
00064     
00068         explicit                    TriggeringTimer(sf::Time timeLimit, bool initiallyRunning = false);
00069         
00070         virtual void                Reset(sf::Time timeLimit, bool restart = false);
00071 
00076         void                        Update();
00077         
00082         Connection                  Connect(const Listener& listener);
00083             
00086         void                        ClearConnections();
00087     
00088     
00089     // ---------------------------------------------------------------------------------------------------------------------------
00090     // Private types
00091     private:
00092         typedef detail::ListenerSequence< TriggeringTimer& >        ListenerCtr;
00093         
00094 
00095     // ---------------------------------------------------------------------------------------------------------------------------
00096     // Private variables
00097     private:
00098         ListenerCtr                 mListeners;
00099         bool                        mJustExpired;
00100 };
00101 
00103 
00104 } // namespace thor
00105 
00106 #endif // THOR_TRIGGERINGTIMER_HPP