OpenWalnut
1.4.0
|
00001 //--------------------------------------------------------------------------- 00002 // 00003 // Project: OpenWalnut ( http://www.openwalnut.org ) 00004 // 00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS 00006 // For more information see http://www.openwalnut.org/copying 00007 // 00008 // This file is part of OpenWalnut. 00009 // 00010 // OpenWalnut is free software: you can redistribute it and/or modify 00011 // it under the terms of the GNU Lesser General Public License as published by 00012 // the Free Software Foundation, either version 3 of the License, or 00013 // (at your option) any later version. 00014 // 00015 // OpenWalnut is distributed in the hope that it will be useful, 00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00018 // GNU Lesser General Public License for more details. 00019 // 00020 // You should have received a copy of the GNU Lesser General Public License 00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>. 00022 // 00023 //--------------------------------------------------------------------------- 00024 00025 #ifndef WGEANIMATIONFRAMETIMER_H 00026 #define WGEANIMATIONFRAMETIMER_H 00027 00028 #include <boost/shared_ptr.hpp> 00029 00030 #include "../../common/WTimer.h" 00031 00032 00033 00034 /** 00035 * Frame-based animation timing. 00036 */ 00037 class WGEAnimationFrameTimer: public WTimer 00038 { 00039 public: 00040 /** 00041 * Convenience typedef for a shared_ptr 00042 */ 00043 typedef boost::shared_ptr< WGEAnimationFrameTimer > SPtr; 00044 00045 /** 00046 * Convenience typedef for a const shared_ptr. 00047 */ 00048 typedef boost::shared_ptr< const WGEAnimationFrameTimer > ConstSPtr; 00049 00050 /** 00051 * Constructs a frame based animation timer. The specified number of frames is used to convert the number of frames to a time. 00052 * 00053 * \param framesPerSecond frames per second. 00054 */ 00055 explicit WGEAnimationFrameTimer( float framesPerSecond = 24.0 ); 00056 00057 /** 00058 * Destructor. 00059 */ 00060 virtual ~WGEAnimationFrameTimer(); 00061 00062 /** 00063 * Resets the start-tick. 00064 */ 00065 virtual void reset(); 00066 00067 /** 00068 * Returns the elapsed time since the last reset in seconds with milliseconds precision. 00069 * 00070 * \return elapsed time in seconds with millisecond precision. 00071 */ 00072 virtual double elapsed() const; 00073 00074 /** 00075 * Increments frame count. 00076 */ 00077 virtual void tick(); 00078 00079 private: 00080 /** 00081 * The current tick value. 00082 */ 00083 size_t m_tick; 00084 00085 /** 00086 * The number of frames per second. 00087 */ 00088 double m_framesPerSecond; 00089 }; 00090 00091 #endif // WGEANIMATIONFRAMETIMER_H