ITimer.h

Go to the documentation of this file.

// 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
{

class ITimer : public virtual IReferenceCounted
{
public:

    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;


    virtual u32 getTime() const = 0;

    virtual void setTime(u32 time) = 0;


    virtual void stop() = 0;


    virtual void start() = 0;


    virtual void setSpeed(f32 speed = 1.0f) = 0;


    virtual f32 getSpeed() const = 0;

    virtual bool isStopped() const = 0;


    virtual void tick() = 0;
};

} // end namespace irr

#endif