Initial revision
[blender.git] / source / gameengine / GamePlayer / common / GPC_MouseDevice.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32
33 #ifndef __GPC_MOUSE_DEVICE_H
34 #define __GPC_MOUSE_DEVICE_H
35
36 #ifdef WIN32
37 #pragma warning (disable : 4786)
38 #endif // WIN32
39
40 #include "SCA_IInputDevice.h"
41
42
43 /**
44  * Generic Ketsji mouse device.
45  * @see SCA_IInputDevice
46  */
47 class GPC_MouseDevice : public SCA_IInputDevice
48 {
49 public:
50         /**
51          * Button identifier.
52          */
53         typedef enum {
54                 buttonLeft,
55                 buttonMiddle,
56                 buttonRight
57         } TButtonId;
58
59         GPC_MouseDevice();
60         virtual ~GPC_MouseDevice(void);
61
62         virtual bool IsPressed(SCA_IInputDevice::KX_EnumInputs inputcode);
63         virtual void NextFrame();
64
65         /**
66          * Call this routine to update the mouse device when a button state changes.
67          * @param button        Which button state changes.
68          * @param isDown        The new state of the button.
69          * @param x                     Position x-coordinate of the cursor at the time of the state change.
70          * @param y                     Position y-coordinate of the cursor at the time of the state change.
71          * @return Indication as to whether the event was processed.
72          */
73         virtual bool ConvertButtonEvent(TButtonId button, bool isDown);
74
75         /**
76          * Call this routine to update the mouse device when a button state and
77          * cursor position changes at the same time (e.g. in Win32 messages).
78          * @param button        Which button state changes.
79          * @param isDown        The new state of the button.
80          * @param x                     Position x-coordinate of the cursor at the time of the state change.
81          * @param y                     Position y-coordinate of the cursor at the time of the state change.
82          * @return Indication as to whether the event was processed.
83          */
84         virtual bool ConvertButtonEvent(TButtonId button, bool isDown, int x, int y);
85
86         /**
87          * Call this routine to update the mouse device when the cursor has moved.
88          * @param x                     Position x-coordinate of the cursor.
89          * @param y                     Position y-coordinate of the cursor.
90          * @return Indication as to whether the event was processed.
91          */
92         virtual bool ConvertMoveEvent(int x, int y);
93
94 protected:
95         /**
96          * This routine converts a single mouse event to a Ketsji mouse event.
97          * @param kxevent       Ketsji event code.
98          * @param eventval      Value for this event.
99          * @return Indication as to whether the event was processed.
100          */
101         virtual bool ConvertEvent(KX_EnumInputs kxevent, int eventval);
102 };
103
104
105 #endif  // __GPC_MOUSE_DEVICE_H