main/include/UniversalClock.h

/*
This file is part of Caelum.
See http://www.ogre3d.org/wiki/index.php/Caelum 

Copyright (c) 2006-2008 Caelum team. See Contributors.txt for details.

Caelum is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Caelum is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with Caelum. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef UNIVERSALCLOCK_H
#define UNIVERSALCLOCK_H

#include "CaelumPrerequisites.h"

namespace caelum {

class CAELUM_EXPORT UniversalClock
{
    private:
        LongReal mJulianDayBase;

        LongReal mCurrentTime;

        LongReal mLastUpdateTime;

        Ogre::Real mTimeSinceLastUpdate;

        Ogre::Real mUpdateRate;

        Ogre::Real mTimeScale;

        void forceUpdate();

// Methods --------------------------------------------------------------------
    public:
        static const LongReal SECONDS_PER_DAY;

        UniversalClock ();

        void setTimeScale (const Ogre::Real scale);

        Ogre::Real getTimeScale () const;

        void setUpdateRate (const Ogre::Real rate);

        Ogre::Real getUpdateRate () const;

        bool update (const Ogre::Real time);

        void setJulianDay(LongReal value);

        // Set the current time as a gregorian date.
        // This is here as an easy to use function.
        void setGregorianDateTime(
                int year, int month, int day,
                int hour, int minute, double second);

        LongReal getJulianDay() const;

        LongReal getJulianDayDifference() const;

        LongReal getJulianSecond() const;

        LongReal getJulianSecondDifference() const;
};

} // namespace caelum

#endif //UNIVERSALCLOCK_H

---