summaryrefslogtreecommitdiff
path: root/Frameworks/guichan.framework/Versions/A/Headers/guichan/genericinput.hpp
blob: 1a62ec0f72db99cb55d05e80468ec92be7176f63 (plain) (blame)
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
/*      _______   __   __   __   ______   __   __   _______   __   __
 *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
 *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
 *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
 *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
 *
 * Copyright (c) 2004 - 2008 Olof Naess�n and Per Larsson
 *
 *
 * 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_GENERICINPUT_HPP
#define GCN_GENERICINPUT_HPP

#include <queue>

#include "guichan/input.hpp"
#include "guichan/keyinput.hpp"
#include "guichan/mouseinput.hpp"
#include "guichan/platform.hpp"

namespace gcn
{
    class Key;
    
    /**
     * Implementation of a generic input which can be used with any 
     * back end.
     */
    class GCN_CORE_DECLSPEC GenericInput: public Input
    {
    public:

        /**
         * Constructor.
         */
        GenericInput();

        /**
         * Pushes a key pressed event.
         *
         * NOTE: If a special key is pressed, like the F1 key,
         *       the corresponding Guichan key value found
         *       in the enum in Key should be pushed as the
         *       unicode value.
         *
         * @param unicode The unicode value of the key. 
         */
        void pushKeyPressed(int unicode);

        /**
         * Pushes a key released event.
         *
         * NOTE: If a special key is pressed, like the F1 key,
         *       the corresponding Guichan key value found
         *       in the enum in Key should be pushed as the
         *       unicode value.
         *
         * @param unicode The unicode value of the key. 
         */
        void pushKeyReleased(int unicode);
        
        /**
         * Pushes a mouse button pressed event.
         *
         * @param x The x coordinate of the mouse event.
         * @param y The y coordinate of the mouse event.
         * @param button The button of the mouse event.
         */
        void pushMouseButtonPressed(int x, int y, int button);

        /**
         * Pushes a mouse button released event.
         *
         * @param x The x coordinate of the mouse event.
         * @param y The y coordinate of the mouse event.
         * @param button The button of the mouse event.
         */
        void pushMouseButtonReleased(int x, int y, int button);
        
        /**
         * Pushes a mouse wheel moved up event.
         *
         * @param x The x coordinate of the mouse event.
         * @param y The y coordinate of the mouse event.
         */
        void pushMouseWheelMovedUp(int x, int y);
        
        /**
         * Pushes a mouse wheel moved down event.
         *
         * @param x The x coordinate of the mouse event.
         * @param y The y coordinate of the mouse event.
         */
        void pushMouseWheelMovedDown(int x, int y);

        /**
         * Pushes a mouse moved event.
         *
         * @param x The x coordinate of the mouse event.
         * @param y The y coordinate of the mouse event.
         */
        void pushMouseMoved(int x, int y);

        
        // Inherited from Input

        virtual bool isKeyQueueEmpty();

        virtual KeyInput dequeueKeyInput();

        virtual bool isMouseQueueEmpty();

        virtual MouseInput dequeueMouseInput();

        virtual void _pollInput();

    protected:
        /**
         * Holds the key input queue.
         */
        std::queue<KeyInput> mKeyInputQueue;

        /**
         * Holds the mouse input queue.
         */
        std::queue<MouseInput> mMouseInputQueue;
    };
}

#endif // end GCN_INPUT_HPP