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
|
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naess�n and Per Larsson
* Copyright (C) 2011-2012 The ManaPlus Developers
*
*
* Per Larsson a.k.a finalman
* Olof Naess�n a.k.a jansem/yakslem
*
* Visit: http://guichan.sourceforge.net
*
* License: (BSD)
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name of Guichan nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef GCN_MOUSEINPUT_HPP
#define GCN_MOUSEINPUT_HPP
#include "guichan/platform.hpp"
#include "localconsts.h"
namespace gcn
{
/**
* Internal class that represents mouse input. Generally you won't have to
* bother using this class unless you implement an Input class for
* a back end.
*
* @author Olof Naess�n
* @author Per Larsson
* @since 0.1.0
*/
class GCN_CORE_DECLSPEC MouseInput
{
public:
/**
* Constructor.
*/
MouseInput() :
mType(0),
mButton(0),
mTimeStamp(0),
mX(0),
mY(0)
{ };
/**
* Constructor.
*
* @param button The button pressed.
* @param type The type of mouse input.
* @param x The mouse x coordinate.
* @param y The mouse y coordinate.
* @param timeStamp The timestamp of the mouse input. Used to
* check for double clicks.
*/
MouseInput(const unsigned int button,
const unsigned int type,
const int x,
const int y,
const int timeStamp);
/**
* Sets the type of the mouse input.
*
* @param type The type of the mouse input. Should be a value from the
* mouse event type enum
* @see getType
* @since 0.1.0
*/
void setType(unsigned int type);
/**
* Gets the type of the mouse input.
*
* @return The type of the mouse input. A value from the mouse event
* type enum.
* @see setType
* @since 0.1.0
*/
unsigned int getType() const A_WARN_UNUSED;
/**
* Sets the button pressed.
*
* @param button The button pressed. Should be one of the values
* in the mouse event button enum.
* @see getButton.
* @since 0.1.0
*/
void setButton(unsigned int button);
/**
* Gets the button pressed.
*
* @return The button pressed. A value from the mouse event
* button enum.
* @see setButton
* @since 0.1.0
*/
unsigned int getButton() const A_WARN_UNUSED;
/**
* Sets the timestamp for the mouse input.
* Used to check for double clicks.
*
* @param timeStamp The timestamp of the mouse input.
* @see getTimeStamp
* @since 0.1.0
*/
void setTimeStamp(int timeStamp);
/**
* Gets the time stamp of the input.
* Used to check for double clicks.
*
* @return The time stamp of the mouse input.
* @see setTimeStamp
* @since 0.1.0
*/
int getTimeStamp() const A_WARN_UNUSED;
/**
* Sets the x coordinate of the mouse input.
*
* @param x The x coordinate of the mouse input.
* @see getX
* @since 0.6.0
*/
void setX(int x);
/**
* Gets the x coordinate of the mouse input.
*
* @return The x coordinate of the mouse input.
* @see setX
* @since 0.6.0
*/
int getX() const A_WARN_UNUSED;
/**
* Sets the y coordinate of the mouse input.
*
* @param y The y coordinate of the mouse input.
* @see getY
* @since 0.6.0
*/
void setY(int y);
/**
* Gets the y coordinate of the mouse input.
*
* @return The y coordinate of the mouse input.
* @see setY
* @since 0.6.0
*/
int getY() const A_WARN_UNUSED;
/**
* Mouse input event types. This enum partially corresponds
* to the enum with event types in MouseEvent for easy mapping.
*/
enum
{
MOVED = 0,
PRESSED,
RELEASED,
WHEEL_MOVED_DOWN,
WHEEL_MOVED_UP
};
/**
* Mouse button types.
*/
enum
{
EMPTY = 0,
LEFT,
RIGHT,
MIDDLE
};
protected:
/**
* Holds the type of the mouse input.
*/
unsigned int mType;
/**
* Holds the button of the mouse input.
*/
unsigned int mButton;
/**
* Holds the timestamp of the mouse input. Used to
* check for double clicks.
*/
int mTimeStamp;
/**
* Holds the x coordinate of the mouse input.
*/
int mX;
/**
* Holds the y coordinate of the mouse input.
*/
int mY;
};
}
#endif // end GCN_MOUSEINPUT_HPP
|
