59fc4401f1
The commit also establishes a precedent of leaving off the `virtual` keyword in overrides. Although not strictly necessary, I believe this is good for readability because it makes it clear it is an override and not a pure virtual function, and it helps keep line lengths shorter. We should move towards eliminating the macro altogether, but the definition has been left in with a note on deprecation so that in-progress work will not suffer merge conflicts.
108 lines
3.0 KiB
C++
108 lines
3.0 KiB
C++
// Copyright (C) 2002-2012 Nikolaus Gebhardt
|
|
// This file is part of the "Irrlicht Engine".
|
|
// For conditions of distribution and use, see copyright notice in irrlicht.h
|
|
|
|
#ifndef __C_IRR_C_TIMER_H_INCLUDED__
|
|
#define __C_IRR_C_TIMER_H_INCLUDED__
|
|
|
|
#include "ITimer.h"
|
|
#include "os.h"
|
|
|
|
namespace irr
|
|
{
|
|
//! Device independent implementation of the timer
|
|
class CTimer : public ITimer
|
|
{
|
|
public:
|
|
|
|
CTimer(bool usePerformanceTimer=true)
|
|
{
|
|
os::Timer::initTimer(usePerformanceTimer);
|
|
}
|
|
|
|
//! Returns current real time in milliseconds of the system.
|
|
/** This value does not start with 0 when the application starts.
|
|
For example in one implementation the value returned could be the
|
|
amount of milliseconds which have elapsed since the system was started. */
|
|
u32 getRealTime() const override
|
|
{
|
|
return os::Timer::getRealTime();
|
|
}
|
|
|
|
//! Get current time and date in calendar form
|
|
RealTimeDate getRealTimeAndDate() const override
|
|
{
|
|
return os::Timer::getRealTimeAndDate();
|
|
}
|
|
|
|
//! Returns current virtual time in milliseconds.
|
|
/** This value starts with 0 and can be manipulated using setTime(), stopTimer(),
|
|
startTimer(), etc. This value depends on the set speed of the timer if the timer
|
|
is stopped, etc. If you need the system time, use getRealTime() */
|
|
u32 getTime() const override
|
|
{
|
|
return os::Timer::getTime();
|
|
}
|
|
|
|
//! sets current virtual time
|
|
void setTime(u32 time) override
|
|
{
|
|
os::Timer::setTime(time);
|
|
}
|
|
|
|
//! Stops the game timer.
|
|
/** The timer is reference counted, which means everything which calls
|
|
stopTimer() will also have to call startTimer(), otherwise the timer may not start/stop
|
|
corretly again. */
|
|
void stop() override
|
|
{
|
|
os::Timer::stopTimer();
|
|
}
|
|
|
|
//! Starts the game timer.
|
|
/** The timer is reference counted, which means everything which calls
|
|
stopTimer() will also have to call startTimer(), otherwise the timer may not start/stop
|
|
corretly again. */
|
|
void start() override
|
|
{
|
|
os::Timer::startTimer();
|
|
}
|
|
|
|
//! Sets the speed of the timer
|
|
/** The speed is the factor with which the time is running faster or slower then the
|
|
real system time. */
|
|
void setSpeed(f32 speed = 1.0f) override
|
|
{
|
|
os::Timer::setSpeed(speed);
|
|
}
|
|
|
|
//! Returns current speed of the timer
|
|
/** The speed is the factor with which the time is running faster or slower then the
|
|
real system time. */
|
|
f32 getSpeed() const override
|
|
{
|
|
return os::Timer::getSpeed();
|
|
}
|
|
|
|
//! Returns if game timer is currently stopped
|
|
bool isStopped() const override
|
|
{
|
|
bool ret = os::Timer::isStopped();
|
|
return ret;
|
|
}
|
|
|
|
//! Advances the virtual time
|
|
/** Makes the virtual timer update the time value based on the real time. This is
|
|
called automatically when calling IrrlichtDevice::run(), but you can call it manually
|
|
if you don't use this method. */
|
|
void tick() override
|
|
{
|
|
os::Timer::tick();
|
|
}
|
|
};
|
|
|
|
} // end namespace
|
|
|
|
#endif
|
|
|