| 1 |
/*************************************************************************** |
| 2 |
* Copyright (C) 2005-2019 by the FIFE team * |
| 3 |
* http://www.fifengine.net * |
| 4 |
* This file is part of FIFE. * |
| 5 |
* * |
| 6 |
* FIFE is free software; you can redistribute it and/or * |
| 7 |
* modify it under the terms of the GNU Lesser General Public * |
| 8 |
* License as published by the Free Software Foundation; either * |
| 9 |
* version 2.1 of the License, or (at your option) any later version. * |
| 10 |
* * |
| 11 |
* This library is distributed in the hope that it will be useful, * |
| 12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of * |
| 13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * |
| 14 |
* Lesser General Public License for more details. * |
| 15 |
* * |
| 16 |
* You should have received a copy of the GNU Lesser General Public * |
| 17 |
* License along with this library; if not, write to the * |
| 18 |
* Free Software Foundation, Inc., * |
| 19 |
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * |
| 20 |
***************************************************************************/ |
| 21 |
|
| 22 |
#ifndef FIFE_TIME_PROVIDER_H |
| 23 |
#define FIFE_TIME_PROVIDER_H |
| 24 |
|
| 25 |
// Standard C++ library includes |
| 26 |
|
| 27 |
// 3rd party library includes |
| 28 |
|
| 29 |
// FIFE includes |
| 30 |
// These includes are split up in two parts, separated by one empty line |
| 31 |
// First block: files included from the FIFE root src directory |
| 32 |
// Second block: files included from the same folder |
| 33 |
#include "util/base/fife_stdint.h" |
| 34 |
#include "util/base/exception.h" |
| 35 |
|
| 36 |
namespace FIFE { |
| 37 |
|
| 38 |
/** Timeprovider is an utility providing time management functionality |
| 39 |
* You can have hierarchy of time providers, whose multiplier can be changed independently. |
| 40 |
* Changing providers upper in the hierarchy, changes also all subproviders with the same ratio |
| 41 |
*/ |
| 42 |
class TimeProvider { |
| 43 |
public: |
| 44 |
/** Constructor |
| 45 |
* In case there there is no provider master, you can use NULL |
| 46 |
*/ |
| 47 |
explicit TimeProvider(TimeProvider* master); |
| 48 |
~TimeProvider(); |
| 49 |
|
| 50 |
/** With multiplier, you can adjust the time speed. 0.5 means time runs half as slow, |
| 51 |
* while 2.0 means it runs twice as fast |
| 52 |
*/ |
| 53 |
void setMultiplier(float multiplier); |
| 54 |
|
| 55 |
/** @see setMultiplier. Returns mutliplier for this single provider |
| 56 |
*/ |
| 57 |
float getMultiplier() const; |
| 58 |
|
| 59 |
/** @see setMultiplier. Returns mutliplier for whole chain of timeproviders |
| 60 |
* E.g. if master has multiplier 2.0 and this has 0.5, end result = 1.0 |
| 61 |
*/ |
| 62 |
float getTotalMultiplier() const; |
| 63 |
|
| 64 |
/** Returns current game ticks, already scaled. |
| 65 |
*/ |
| 66 |
uint32_t getGameTime() const; |
| 67 |
|
| 68 |
private: |
| 69 |
TimeProvider* m_master; |
| 70 |
float m_multiplier; |
| 71 |
double m_time_static, m_time_scaled; |
| 72 |
|
| 73 |
/** Returns current game ticks, already scaled, more precise. |
| 74 |
*/ |
| 75 |
double getPreciseGameTime() const; |
| 76 |
}; |
| 77 |
|
| 78 |
/** Utility function to calculate time scaling. Mostly done to avoid littering other code |
| 79 |
* with related casting |
| 80 |
* @return multiplier * ticks |
| 81 |
*/ |
| 82 |
uint32_t scaleTime(float multiplier, uint32_t ticks); |
| 83 |
|
| 84 |
} //FIFE |
| 85 |
#endif |
| 86 |
|