aboutsummaryrefslogtreecommitdiffstats
path: root/yage/engine/system.h
blob: 32d6fc340813b82b154f10c932572c665ec9e0b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/** ---------------------------------------------------------------------------
 * @file: system.h
 *
 * Copyright (c) 2017 Yann Herklotz Grave <ymherklotz@gmail.com>
 * MIT License, see LICENSE file for more details.
 * ----------------------------------------------------------------------------
 */

#ifndef YAGE_ENGINE_SYSTEM_H
#define YAGE_ENGINE_SYSTEM_H

namespace yage
{

/**
 * System interface for the different systems in the engine.
 */
class System
{
public:
    /**
     * Virtual destructor to destroy all the objects that implement this
     * properly.
     */
    virtual ~System() = 0;

    /**
     * Initializes the system. Good practice to have this function instead
     * using the constructor.
     */
    virtual void init() = 0;

    /**
     * Updates the system at each interval using the time step.
     *
     * @param dt The time difference between the previous frame and the current one.
     */
    virtual void update(double dt) = 0;
};

/**
 * Implement the default destructor, but leaving it as purely virtual in the
 * definition of the abstract class. This is so that the classes that implement
 * the abstract class have to implement a desctructor, but at the same time,
 * that there is no undefined behavious when the stack unwinds to the system and
 * calls the system destructor.
 */
inline System::~System() {}

} // namespace yage

#endif