Mercurial > fife-parpg

comparison engine/core/model/metamodel/timeprovider.h @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children 90005975cdbb
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE Team *
3 * http://www.fifengine.de *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program 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 *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin St, 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/exception.h"
34
35 namespace FIFE {
36
37 /** Timeprovider is an utility providing time management functionality
38 * You can have hierarchy of time providers, whose multiplier can be changed independently.
39 * Changing providers upper in the hierarchy, changes also all subproviders with the same ratio
40 */
41 class TimeProvider {
42 public:
43 /** Constructor
44 * In case there there is no provider master, you can use NULL
45 */
46 TimeProvider(TimeProvider* master);
47 ~TimeProvider();
48
49 /** With multiplier, you can adjust the time speed. 0.5 means time runs half as slow,
50 * while 2.0 means it runs twice as fast
51 */
52 void setMultiplier(float multiplier);
53
54 /** @see setMultiplier. Returns mutliplier for this single provider
55 */
56 float getMultiplier() const;
57
58 /** @see setMultiplier. Returns mutliplier for whole chain of timeproviders
59 * E.g. if master has multiplier 2.0 and this has 0.5, end result = 1.0
60 */
61 float getTotalMultiplier() const;
62
63 /** Returns current game ticks. Fetched from furthest master to reduce system calls.
64 */
65 unsigned int getGameTicks() const;
66
67 private:
68 TimeProvider* m_master;
69 float m_multiplier;
70 };
71
72 /** Utility function to calculate time scaling. Mostly done to avoid littering other code
73 * with related casting
74 * @return multiplier * ticks
75 */
76 unsigned int scaleTime(float multiplier, unsigned int ticks);
77
78 } //FIFE
79 #endif
80