90 lines
2.0 KiB
C++
90 lines
2.0 KiB
C++
//This file is part of Photon (http://photon.sourceforge.net)
|
|
//Copyright (C) 2004-2005 James Turk
|
|
//
|
|
// Author:
|
|
// James Turk (jpt2433@rit.edu)
|
|
//
|
|
// Version:
|
|
// $Id: Timer.hpp,v 1.2 2005/07/18 06:18:51 cozman Exp $
|
|
|
|
#ifndef PHOTON_UTIL_TIMER_HPP
|
|
#define PHOTON_UTIL_TIMER_HPP
|
|
|
|
#include "AppCore.hpp"
|
|
|
|
namespace photon
|
|
{
|
|
namespace util
|
|
{
|
|
|
|
|
|
// Class: Timer
|
|
// Class capable of keeping track of time.
|
|
// Time is returned in double format, in seconds.
|
|
class Timer
|
|
{
|
|
|
|
// Group: (Con/De)structors
|
|
public:
|
|
// Function: Timer
|
|
// Initializes timer, timer is running starting at it's creation.
|
|
// If this is not desired behavior call <reset> when you want it to start.
|
|
//
|
|
// Parameters:
|
|
// appTimeLinked - Option only available on creation of timer. When true
|
|
// timer will pause when the <Application::timer> is paused.
|
|
// [default: true]
|
|
Timer(bool appTimeLinked=true);
|
|
|
|
// Function: ~Timer
|
|
// Virtual destructor, does nothing, exists only to make Timer inheritance
|
|
// safe.
|
|
virtual ~Timer();
|
|
|
|
// Group: General
|
|
public:
|
|
// Function: reset
|
|
// Reset timer to 0, will unpause timer if paused.
|
|
void reset();
|
|
|
|
// Function: pause
|
|
// Pause timer.
|
|
void pause();
|
|
|
|
// Function: unpause
|
|
// Unpause timer if paused.
|
|
void unpause();
|
|
|
|
// Group: Accessors
|
|
public:
|
|
// Function: getTime
|
|
// Get time in seconds. (ie. A value of .001 means 1 millisecond.)
|
|
//
|
|
// Returns:
|
|
// Time on timer, in seconds.
|
|
double getTime() const;
|
|
|
|
// Function: isPaused
|
|
// Check paused/unpaused status of timer.
|
|
//
|
|
// Returns:
|
|
// True if timer is paused, false if timer is running.
|
|
bool isPaused() const;
|
|
|
|
private:
|
|
double getTimeInternal() const; // get time from source timer
|
|
|
|
// data members
|
|
private:
|
|
AppCore& appCore_;
|
|
bool appTimeLinked_;
|
|
bool paused_;
|
|
double pausedTime_;
|
|
double lastPause_;
|
|
};
|
|
|
|
}
|
|
}
|
|
|
|
#endif //PHOTON_UTIL_TIMER_HPP
|