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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef ULTIMA4_CONTROLLERS_CONTROLLER_H
#define ULTIMA4_CONTROLLERS_CONTROLLER_H
#include "ultima/ultima4/metaengine.h"
namespace Ultima {
namespace Ultima4 {
/**
* A generic controller base class. Controllers are classes that
* contain the logic for responding to external events (e.g. keyboard,
* mouse, timers).
*/
class Controller {
public:
Controller(int timerInterval = 1);
virtual ~Controller();
/* methods for interacting with event manager */
virtual bool isCombatController() const {
return false;
}
/**
* The event manager will call this method to notify the active
* controller that a key has been pressed. The key will be passed on
* to the virtual keyPressed method.
*/
bool notifyKeyPressed(int key);
/**
* The event manager will call this method to notify that
* the left button was clicked
*/
bool notifyMousePress(const Common::Point &mousePos);
int getTimerInterval();
/**
* A simple adapter to make a timer callback into a controller method
* call.
*/
static void timerCallback(void *data);
/** control methods subclasses may want to override */
/**
* Called when a controller is made active
*/
virtual void setActive();
/**
* Key was pressed
*/
virtual bool keyPressed(int key) {
return false;
}
/**
* Mouse button was pressed
*/
virtual bool mousePressed(const Common::Point &mousePos) {
return false;
}
/**
* Handles keybinder actions
*/
virtual void keybinder(KeybindingAction action) {}
/**
* The default timerFired handler for a controller. By default,
* timers are ignored, but subclasses can override this method and it
* will be called every <interval> 1/4 seconds.
*/
virtual void timerFired();
/**
* Returns true if game should quit
*/
bool shouldQuit() const;
private:
int _timerInterval;
};
// helper functions for the waitable controller; they just avoid
// having eventhandler dependencies in this header file
void Controller_startWait();
void Controller_endWait();
/**
* Class template for controllers that can be "waited for".
* Subclasses should set the value variable and call doneWaiting when
* the controller has completed.
*/
template<class T>
class WaitableController : public Controller {
private:
bool _exitWhenDone;
T _defaultValue;
protected:
T _value;
void doneWaiting() {
if (_exitWhenDone)
Controller_endWait();
}
public:
WaitableController(T defaultValue) : _defaultValue(defaultValue),
_value(defaultValue), _exitWhenDone(false) {}
virtual T getValue() {
return shouldQuit() ? _defaultValue : _value;
}
virtual T waitFor() {
_exitWhenDone = true;
Controller_startWait();
return getValue();
}
/**
* Mouse button was pressed
*/
virtual bool mousePressed(const Common::Point &mousePos) {
// Treat mouse clicks as an abort
doneWaiting();
_value = _defaultValue;
return true;
}
};
class TurnCompleter {
public:
virtual ~TurnCompleter() {
}
virtual void finishTurn() = 0;
virtual void finishTurnAfterCombatEnds() {
finishTurn();
}
};
} // End of namespace Ultima4
} // End of namespace Ultima
#endif
|
