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