/
scheduler.h
73 lines (61 loc) · 2.28 KB
/
scheduler.h
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/** @file scheduler.h Scheduler for scripts and timelines.
*
* @authors Copyright (c) 2017 Jaakko Keränen <jaakko.keranen@iki.fi>
*
* @par License
* LGPL: http://www.gnu.org/licenses/lgpl.html
*
* <small>This program 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. This program 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 this program; if not, see:
* http://www.gnu.org/licenses</small>
*/
#ifndef LIBDENG2_SCHEDULER_H
#define LIBDENG2_SCHEDULER_H
#include "../Timeline"
namespace de {
/**
* Scheduler for scripts and timelines.
*/
class DENG2_PUBLIC Scheduler
{
public:
Scheduler();
void clear();
/**
* Starts executing a timeline. The timeline object will be deleted when the
* finished. The timeline's context is used for execution.
*
* @param timeline Timeline object. Scheduler takes ownership.
* @param name Name for the started timeline. If empty, a unique name will
* be generated.
* @return Name of the started timeline.
*/
String start(Timeline *timeline, String const &name = String());
/**
* Starts executing a shared timeline.
*
* @param sharedTimeline Timeline object. Scheduler does not take ownership.
* @param context Context where to execute the timeline.
* @param name Name for the started timeline instance. If empty, a unique
* name will be generated.
* @return Name of the started timeline.
*/
String start(Timeline const &sharedTimeline, Record *context, String const &name = String());
/**
* Stops a running timeline.
*
* @param name Timeline name.
*/
void stop(String const &name);
void advanceTime(TimeDelta const &elapsed);
private:
DENG2_PRIVATE(d)
};
} // namespace de
#endif // LIBDENG2_SCHEDULER_H