diff options
| author | cutealien <cutealien@dfc29bdd-3216-0410-991c-e03cc46cb475> | 2020-01-03 19:05:16 +0000 |
|---|---|---|
| committer | cutealien <cutealien@dfc29bdd-3216-0410-991c-e03cc46cb475> | 2020-01-03 19:05:16 +0000 |
| commit | 2ae2a551a6290f46734307bbfdafea4b1a2cf2ba (patch) | |
| tree | ba2f0b468640e44899fed3df2d4cc58795f4a003 /include/ITimer.h | |
| download | irrlicht-2ae2a551a6290f46734307bbfdafea4b1a2cf2ba.tar.xz | |
Merging r5975 through r6036 from trunk to ogl-es branch.
GLES drivers adapted, but only did make compile-tests.
git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/branches/ogl-es@6038 dfc29bdd-3216-0410-991c-e03cc46cb475
Diffstat (limited to 'include/ITimer.h')
| -rw-r--r-- | include/ITimer.h | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/include/ITimer.h b/include/ITimer.h new file mode 100644 index 0000000..709db97 --- /dev/null +++ b/include/ITimer.h @@ -0,0 +1,103 @@ +// 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 __I_TIMER_H_INCLUDED__
+#define __I_TIMER_H_INCLUDED__
+
+#include "IReferenceCounted.h"
+
+namespace irr
+{
+
+//! Interface for getting and manipulating the virtual time
+class ITimer : public virtual IReferenceCounted
+{
+public:
+ //! 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.
+ */
+ virtual u32 getRealTime() const = 0;
+
+ enum EWeekday
+ {
+ EWD_SUNDAY=0,
+ EWD_MONDAY,
+ EWD_TUESDAY,
+ EWD_WEDNESDAY,
+ EWD_THURSDAY,
+ EWD_FRIDAY,
+ EWD_SATURDAY
+ };
+
+ struct RealTimeDate
+ {
+ // Hour of the day, from 0 to 23
+ u32 Hour;
+ // Minute of the hour, from 0 to 59
+ u32 Minute;
+ // Second of the minute, due to extra seconds from 0 to 61
+ u32 Second;
+ // Year of the Gregorian calender
+ s32 Year;
+ // Month of the year, from 1 to 12
+ u32 Month;
+ // Day of the month, from 1 to 31
+ u32 Day;
+ // Weekday for the current day
+ EWeekday Weekday;
+ // Day of the year, from 1 to 366
+ u32 Yearday;
+ // Whether daylight saving is on
+ bool IsDST;
+ };
+
+ virtual RealTimeDate getRealTimeAndDate() const = 0;
+
+ //! 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() */
+ virtual u32 getTime() const = 0;
+
+ //! sets current virtual time
+ virtual void setTime(u32 time) = 0;
+
+ //! Stops the virtual timer.
+ /** The timer is reference counted, which means everything which calls
+ stop() will also have to call start(), otherwise the timer may not
+ start/stop correctly again. */
+ virtual void stop() = 0;
+
+ //! Starts the virtual timer.
+ /** The timer is reference counted, which means everything which calls
+ stop() will also have to call start(), otherwise the timer may not
+ start/stop correctly again. */
+ virtual void start() = 0;
+
+ //! 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. */
+ virtual void setSpeed(f32 speed = 1.0f) = 0;
+
+ //! 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. */
+ virtual f32 getSpeed() const = 0;
+
+ //! Returns if the virtual timer is currently stopped
+ virtual bool isStopped() const = 0;
+
+ //! 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. */
+ virtual void tick() = 0;
+};
+
+} // end namespace irr
+
+#endif
|