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

* 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_SDLINPUT_HPP
45 #define GCN_SDLINPUT_HPP
46
47 #include <queue>
48
49 #include "SDL.h"
50
51 #include "guichan/input.hpp"
52 #include "guichan/keyinput.hpp"
53 #include "guichan/mouseinput.hpp"
54 #include "guichan/platform.hpp"
55
56 namespace gcn
57 {
58 class Key;
59
60 /**
61 * SDL implementation of Input.
62 */
63 class GCN_EXTENSION_DECLSPEC SDLInput : public Input
64 {
65 public:
66
67 /**
68 * Constructor.
69 */
70 SDLInput();
71
72 /**
73 * Pushes an SDL event. It should be called at least once per frame to
74 * update input with user input.
75 *
76 * @param event an event from SDL.
77 */
78 virtual void pushInput(SDL_Event event);
79
80 /**
81 * Polls all input. It exists for input driver compatibility. If you
82 * only use SDL and plan sticking with SDL you can safely ignore this
83 * function as it in the SDL case does nothing.
84 */
85 virtual void _pollInput() { }
86
87
88 // Inherited from Input
89
90 virtual bool isKeyQueueEmpty();
91
92 virtual KeyInput dequeueKeyInput();
93
94 virtual bool isMouseQueueEmpty();
95
96 virtual MouseInput dequeueMouseInput();
97
98 protected:
99 /**
100 * Converts a mouse button from SDL to a Guichan mouse button
101 * representation.
102 *
103 * @param button an SDL mouse button.
104 * @return a Guichan mouse button.
105 */
106 int convertMouseButton(int button);
107
108 /**
109 * Converts an SDL event to a Guichan key value.
110 *
111 * @param keysym The SDL event to convert.
112 * @return A Guichan key value. -1 if no conversion took place.
113 * @see Key
114 */
115 int convertSDLEventToGuichanKeyValue(SDL_Event event);
116
117 std::queue<KeyInput> mKeyInputQueue;
118 std::queue<MouseInput> mMouseInputQueue;
119
120 bool mMouseDown;
121 bool mMouseInWindow;
122 };
123 }
124
125 #endif // end GCN_SDLINPUT_HPP