OpenWalnut  1.4.0
WRealtimeTimer.h
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 WREALTIMETIMER_H
00026 #define WREALTIMETIMER_H
00027 
00028 #include <boost/shared_ptr.hpp>
00029 
00030 #include <osg/Timer>
00031 
00032 #include "WTimer.h"
00033 
00034 
00035 
00036 /**
00037  * Realtime timing. Internally, this uses an osg::Timer.
00038  */
00039 class WRealtimeTimer: public WTimer
00040 {
00041 public:
00042     /**
00043      * Convenience typedef for a shared_ptr
00044      */
00045     typedef boost::shared_ptr< WRealtimeTimer > SPtr;
00046 
00047     /**
00048      * Convenience typedef for a const shared_ptr.
00049      */
00050     typedef boost::shared_ptr< const WRealtimeTimer > ConstSPtr;
00051 
00052     /**
00053      * Constructs a realtime animation timer.
00054      */
00055     WRealtimeTimer();
00056 
00057     /**
00058      * Destructor.
00059      */
00060     virtual ~WRealtimeTimer();
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 private:
00075     /**
00076      * The osg timer is used here.
00077      */
00078     osg::Timer m_timer;
00079 };
00080 
00081 #endif  // WREALTIMETIMER_H