Mercurial > fife-parpg

comparison ext/guichan-0.8.1/include/guichan/genericinput.hpp @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /* _______ __ __ __ ______ __ __ _______ __ __
2 * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3 * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4 * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5 * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8 *
9 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
10 *
11 *
12 * Per Larsson a.k.a finalman
13 * Olof Naessén a.k.a jansem/yakslem
14 *
15 * Visit: http://guichan.sourceforge.net
16 *
17 * License: (BSD)
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
20 * are met:
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in
25 * the documentation and/or other materials provided with the
26 * distribution.
27 * 3. Neither the name of Guichan nor the names of its contributors may
28 * be used to endorse or promote products derived from this software
29 * without specific prior written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
37 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
38 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
40 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 #ifndef GCN_GENERICINPUT_HPP
45 #define GCN_GENERICINPUT_HPP
46
47 #include <queue>
48
49 #include "guichan/input.hpp"
50 #include "guichan/keyinput.hpp"
51 #include "guichan/mouseinput.hpp"
52 #include "guichan/platform.hpp"
53
54 namespace gcn
55 {
56 class Key;
57
58 /**
59 * Implementation of a generic input which can be used with any
60 * back end.
61 */
62 class GCN_CORE_DECLSPEC GenericInput: public Input
63 {
64 public:
65
66 /**
67 * Constructor.
68 */
69 GenericInput();
70
71 /**
72 * Pushes a key pressed event.
73 *
74 * NOTE: If a special key is pressed, like the F1 key,
75 * the corresponding Guichan key value found
76 * in the enum in Key should be pushed as the
77 * unicode value.
78 *
79 * @param unicode The unicode value of the key.
80 */
81 void pushKeyPressed(int unicode);
82
83 /**
84 * Pushes a key released event.
85 *
86 * NOTE: If a special key is pressed, like the F1 key,
87 * the corresponding Guichan key value found
88 * in the enum in Key should be pushed as the
89 * unicode value.
90 *
91 * @param unicode The unicode value of the key.
92 */
93 void pushKeyReleased(int unicode);
94
95 /**
96 * Pushes a mouse button pressed event.
97 *
98 * @param x The x coordinate of the mouse event.
99 * @param y The y coordinate of the mouse event.
100 * @param button The button of the mouse event.
101 */
102 void pushMouseButtonPressed(int x, int y, int button);
103
104 /**
105 * Pushes a mouse button released event.
106 *
107 * @param x The x coordinate of the mouse event.
108 * @param y The y coordinate of the mouse event.
109 * @param button The button of the mouse event.
110 */
111 void pushMouseButtonReleased(int x, int y, int button);
112
113 /**
114 * Pushes a mouse wheel moved up event.
115 *
116 * @param x The x coordinate of the mouse event.
117 * @param y The y coordinate of the mouse event.
118 */
119 void pushMouseWheelMovedUp(int x, int y);
120
121 /**
122 * Pushes a mouse wheel moved down event.
123 *
124 * @param x The x coordinate of the mouse event.
125 * @param y The y coordinate of the mouse event.
126 */
127 void pushMouseWheelMovedDown(int x, int y);
128
129 /**
130 * Pushes a mouse moved event.
131 *
132 * @param x The x coordinate of the mouse event.
133 * @param y The y coordinate of the mouse event.
134 */
135 void pushMouseMoved(int x, int y);
136
137
138 // Inherited from Input
139
140 virtual bool isKeyQueueEmpty();
141
142 virtual KeyInput dequeueKeyInput();
143
144 virtual bool isMouseQueueEmpty();
145
146 virtual MouseInput dequeueMouseInput();
147
148 virtual void _pollInput();
149
150 protected:
151 /**
152 * Holds the key input queue.
153 */
154 std::queue<KeyInput> mKeyInputQueue;
155
156 /**
157 * Holds the mouse input queue.
158 */
159 std::queue<MouseInput> mMouseInputQueue;
160 };
161 }
162
163 #endif // end GCN_INPUT_HPP