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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
// -----------------------------------------------------------------------------
// This file is part of Broken Sword 2.5
// Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsd�rfer
//
// Broken Sword 2.5 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 2 of the License, or
// (at your option) any later version.
//
// Broken Sword 2.5 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 Broken Sword 2.5; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
// -----------------------------------------------------------------------------
/**
BS_InputEngine
-------------
Dies ist das Inputengine Interface, dass alle Methoden enth�lt, die eine Inputengine implementieren muss.
Implementationen der Inputengine m�ssen von dieser Klasse abgeleitet werden.
Autor: Alex Arnst
**/
#ifndef SWORD25_INPUTENGINE_H
#define SWORD25_INPUTENGINE_H
/// Includes
#include "sword25/kernel/common.h"
#include "sword25/kernel/service.h"
#include "sword25/kernel/persistable.h"
/// Klassendefinition
class BS_InputEngine : public BS_Service, public BS_Persistable
{
public:
BS_InputEngine(BS_Kernel* pKernel);
virtual ~BS_InputEngine(){};
// ACHTUNG: Diese Codes werden in inputengine_script.cpp beim Skript-Service registriert. Bei �nderungen an diesem Enum muss auch diese
// Datei angepasst werden.
enum KEY_CODES
{
KEY_BACKSPACE = 0x08,
KEY_TAB = 0x09,
KEY_CLEAR = 0x0C,
KEY_RETURN = 0x0D,
KEY_PAUSE = 0x13,
KEY_CAPSLOCK = 0x14,
KEY_ESCAPE = 0x1B,
KEY_SPACE = 0x20,
KEY_PAGEUP = 0x21,
KEY_PAGEDOWN = 0x22,
KEY_END = 0x23,
KEY_HOME = 0x24,
KEY_LEFT = 0x25,
KEY_UP = 0x26,
KEY_RIGHT = 0x27,
KEY_DOWN = 0x28,
KEY_PRINTSCREEN = 0x2C,
KEY_INSERT = 0x2D,
KEY_DELETE = 0x2E,
KEY_0 = 0x30,
KEY_1 = 0x31,
KEY_2 = 0x32,
KEY_3 = 0x33,
KEY_4 = 0x34,
KEY_5 = 0x35,
KEY_6 = 0x36,
KEY_7 = 0x37,
KEY_8 = 0x38,
KEY_9 = 0x39,
KEY_A = 0x41,
KEY_B = 0x42,
KEY_C = 0x43,
KEY_D = 0x44,
KEY_E = 0x45,
KEY_F = 0x46,
KEY_G = 0x47,
KEY_H = 0x48,
KEY_I = 0x49,
KEY_J = 0x4A,
KEY_K = 0x4B,
KEY_L = 0x4C,
KEY_M = 0x4D,
KEY_N = 0x4E,
KEY_O = 0x4F,
KEY_P = 0x50,
KEY_Q = 0x51,
KEY_R = 0x52,
KEY_S = 0x53,
KEY_T = 0x54,
KEY_U = 0x55,
KEY_V = 0x56,
KEY_W = 0x57,
KEY_X = 0x58,
KEY_Y = 0x59,
KEY_Z = 0x5A,
KEY_NUMPAD0 = 0x60,
KEY_NUMPAD1 = 0x61,
KEY_NUMPAD2 = 0x62,
KEY_NUMPAD3 = 0x63,
KEY_NUMPAD4 = 0x64,
KEY_NUMPAD5 = 0x65,
KEY_NUMPAD6 = 0x66,
KEY_NUMPAD7 = 0x67,
KEY_NUMPAD8 = 0x68,
KEY_NUMPAD9 = 0x69,
KEY_MULTIPLY = 0x6A,
KEY_ADD = 0x6B,
KEY_SEPARATOR = 0x6C,
KEY_SUBTRACT = 0x6D,
KEY_DECIMAL = 0x6E,
KEY_DIVIDE = 0x6F,
KEY_F1 = 0x70,
KEY_F2 = 0x71,
KEY_F3 = 0x72,
KEY_F4 = 0x73,
KEY_F5 = 0x74,
KEY_F6 = 0x75,
KEY_F7 = 0x76,
KEY_F8 = 0x77,
KEY_F9 = 0x78,
KEY_F10 = 0x79,
KEY_F11 = 0x7A,
KEY_F12 = 0x7B,
KEY_NUMLOCK = 0x90,
KEY_SCROLL = 0x91,
KEY_LSHIFT = 0xA0,
KEY_RSHIFT = 0xA1,
KEY_LCONTROL = 0xA2,
KEY_RCONTROL = 0xA3
};
// ACHTUNG: Diese Codes werden in inputengine_script.cpp beim Skript-Service registriert. Bei �nderungen an diesem Enum muss auch diese
// Datei angepasst werden.
enum KEY_COMMANDS
{
KEY_COMMAND_ENTER = 1,
KEY_COMMAND_LEFT = 2,
KEY_COMMAND_RIGHT = 3,
KEY_COMMAND_HOME = 4,
KEY_COMMAND_END = 5,
KEY_COMMAND_BACKSPACE = 6,
KEY_COMMAND_TAB = 7,
KEY_COMMAND_INSERT = 8,
KEY_COMMAND_DELETE = 9
};
/// --------------------------------------------------------------
/// DIESE METHODEN M�SSEN VON DER INPUTENGINE IMPLEMENTIERT WERDEN
/// --------------------------------------------------------------
/**
@brief Initialisiert die Inputengine
@return Gibt bei Erfolg true zur�ck, ansonsten false.
*/
virtual bool Init() = 0;
/**
@brief F�hrt einen "Tick" der Input-Engine aus
Diese Methode sollte mindestens ein mal pro Frame aufgerufen werden. Sie dient dazu Implementationen der
Input-Engine zu erm�glichen, die nicht in einem eigenen Thread laufen oder zus�tzliche Verwaltungsaufgaben
durchf�hren m�ssen.
*/
virtual void Update() = 0;
/**
@brief Gibt true zur�ck, wenn die linke Maustaste gedr�ckt ist.
*/
virtual bool IsLeftMouseDown() = 0;
/**
@brief Gibt true zur�ck, wenn die rechte Maustaste gedr�ckt ist.
*/
virtual bool IsRightMouseDown() = 0;
/**
@brief Gibt true zur�ck, wenn die linke Maustaste gedr�ckt und losgelassen wurde.
Der Unterschied zu IsLeftMouseDown() besteht darin, dass erst true zur�ckgegegen wird, wenn der Tastendruck beendet ist, die Taste also
wieder losgelassen wurde.
*/
virtual bool WasLeftMouseDown() = 0;
/**
@brief Gibt true zur�ck, wenn die linke Maustaste gedr�ckt und losgelassen wurde.
Der Unterschied zu IsRightMouseDown() besteht darin, dass erst true zur�ckgegegen wird, wenn der Tastendruck beendet ist, die Taste also
wieder losgelassen wurde.
*/
virtual bool WasRightMouseDown() = 0;
/**
@brief Gibt true zur�ck wenn mit der linken Maustaste ein Doppelklick ausgel�st wurde.
*/
virtual bool IsLeftDoubleClick() = 0;
/**
@brief Gibt die Position des Mauszeigers auf der X-Achse in Pixeln zur�ck.
*/
virtual int GetMouseX() = 0;
/**
@brief Gibt die Position des Mauszeigers auf der Y-Achse in Pixeln zur�ck.
*/
virtual int GetMouseY() = 0;
/**
@brief Setzt die Position des Mauszeigers auf der X-Achse in Pixeln.
*/
virtual void SetMouseX(int PosX) = 0;
/**
@brief Setzt die Position des Mauszeigers auf der Y-Achse in Pixeln.
*/
virtual void SetMouseY(int PosY) = 0;
/**
@brief Gibt true zur�ck wenn eine bestimmte Taste gedr�ckt ist.
@param KeyCode der Key-Code der zu testenden Taste
@return Gibt true zur�ck, wenn die Taste mit dem �bergebenen Key-Code gedr�ckt ist, ansonsten false.
*/
virtual bool IsKeyDown(unsigned int KeyCode) = 0;
/**
@brief Gibt true zur�ck wenn eine bestimmte Taste ger�ckt und losgelassen wurde.
Der Unterschied zu IsKeyDown() besteht darin, dass erst true zur�ckgegegen wird, wenn der Tastendruck beendet ist, die Taste also
wieder losgelassen wurde. Diese Methode erleichtert das Abfragen von Funktionstasten und das Einlesen von Zeichenketten, die vom
Benutzer getippt werden.
@param KeyCode der Key-Code der zu testenden Taste
*/
virtual bool WasKeyDown(unsigned int KeyCode) = 0;
typedef void (*CharacterCallback)(unsigned char Character);
/**
@brief Registriert eine Callbackfunktion f�r die Eingabe von Buchstaben.
Die Callbacks, die mit dieser Funktion registriert werden, werden immer dann aufgerufen, wenn der Input-Service eine Buchstabeneingabe
feststellt. Eine Buchstabeneingabe unterscheidet sich von der Abfrage mittels der Methoden IsKeyDown() und WasKeyDown() in der Hinsicht,
dass statt Scan-Coded tats�chliche Buchstaben behandelt werden. Dabei wurden unter anderem Ber�cksichtigt:des Tastaturlayout, der Zustand
der Shift und Caps Lock Tasten und die Wiederholung durch l�ngeres Halten der Taste.<br>
Die Eingabe von Zeichenketten durch den Benutzer sollte durch Benutzung dieses Callbacks realisiert werden.
@return Gibt true zur�ck, wenn die Funktion registriert werden konnte, ansonsten false.
*/
virtual bool RegisterCharacterCallback(CharacterCallback Callback) = 0;
/**
@brief Deregistriert eine Callbackfunktion f�r die Eingabe von Buchstaben.
@return Gibt true zur�ck, wenn die Funktion deregistriert werden konnte, ansonsten false.
*/
virtual bool UnregisterCharacterCallback(CharacterCallback Callback) = 0;
typedef void (*CommandCallback)(KEY_COMMANDS Command);
/**
@brief Registriert eine Callbackfunktion f�r die Eingabe von Kommandos, die auf die Zeichenketteneingabe Einfluss haben k�nnen.
Die Callbacks, die mit dieser Funktion registriert werden , werden immer dann aufgerufen, wenn der Input-Service einen Tastendruck
feststellt, der die Zeichenketteneingabe beeinflussen kann. Dies k�nnten folgende Tasten sein: Enter, Pos 1, Ende, Links, Rechts, ...<br>
Die Eingabe von Zeichenketten durch den Benutzer sollte durch Benutzung dieses Callbacks realisiert werden.
@return Gibt true zur�ck, wenn die Funktion registriert werden konnte, ansonsten false.
*/
virtual bool RegisterCommandCallback(CommandCallback Callback) = 0;
/**
@brief Deregistriert eine Callbackfunktion f�r die Eingabe von Kommandos, die auf die Zeichenketteneingabe Einfluss haben k�nnen.
@return Gibt true zur�ck, wenn die Funktion deregistriert werden konnte, ansonsten false.
*/
virtual bool UnregisterCommandCallback(CommandCallback Callback) = 0;
virtual void ReportCharacter(unsigned char Character) = 0;
virtual void ReportCommand(KEY_COMMANDS Command) = 0;
private:
bool _RegisterScriptBindings();
};
#endif
|