code cleanup: make header defines more consistent, JOYSENSOR header guard had a typo...
[blender-staging.git] / source / gameengine / GameLogic / SCA_MouseSensor.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): José I. Romero (cleanup and fixes)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file SCA_MouseSensor.h
29  *  \ingroup gamelogic
30  *  \brief Senses mouse events
31  */
32
33 #ifndef __SCA_MOUSESENSOR_H__
34 #define __SCA_MOUSESENSOR_H__
35
36 #include "SCA_ISensor.h"
37 #include "BoolValue.h"
38 #include "SCA_IInputDevice.h"
39
40 class SCA_MouseSensor : public SCA_ISensor
41 {
42         Py_Header
43         
44         /**
45          * Use SCA_IInputDevice values to encode the mouse mode for now.
46          */
47         short int m_mousemode;
48         /**
49          * Triggermode true means all mouse events trigger. Useful mainly
50          * for button presses.
51          */
52         bool m_triggermode;
53         /**
54          * Remember the last state update 
55          */
56         int m_val;
57
58         SCA_IInputDevice::KX_EnumInputs m_hotkey;
59         
60         /**
61          * valid x coordinate, MUST be followed by y coordinate
62          */
63         short m_x;
64
65         /**
66          * valid y coordinate
67          */
68         short m_y;
69         
70  public:
71         /**
72          * Allowable modes for the trigger status of the mouse sensor.
73          */
74         enum KX_MOUSESENSORMODE {
75                 KX_MOUSESENSORMODE_NODEF = 0,
76                 KX_MOUSESENSORMODE_LEFTBUTTON,
77                 KX_MOUSESENSORMODE_MIDDLEBUTTON,
78                 KX_MOUSESENSORMODE_RIGHTBUTTON,
79                 KX_MOUSESENSORMODE_WHEELUP,
80                 KX_MOUSESENSORMODE_WHEELDOWN,
81                 KX_MOUSESENSORMODE_POSITION,
82                 KX_MOUSESENSORMODE_POSITIONX,
83                 KX_MOUSESENSORMODE_POSITIONY,
84                 KX_MOUSESENSORMODE_MOVEMENT,
85                 KX_MOUSESENSORMODE_MAX
86         };
87
88         bool isValid(KX_MOUSESENSORMODE);
89         
90         SCA_MouseSensor(class SCA_MouseManager* keybdmgr,
91                         int startx,int starty,
92                         short int mousemode,
93                         SCA_IObject* gameobj);
94
95         virtual ~SCA_MouseSensor();
96         virtual CValue* GetReplica();
97         virtual bool Evaluate();
98         virtual void Init();
99         virtual bool IsPositiveTrigger();
100         short int GetModeKey();
101         SCA_IInputDevice::KX_EnumInputs GetHotKey();
102         void setX(short x);
103         void setY(short y);
104
105         static void UpdateHotkey(void *self);
106
107
108 #ifdef WITH_PYTHON
109         /* --------------------------------------------------------------------- */
110         /* Python interface ---------------------------------------------------- */
111         /* --------------------------------------------------------------------- */
112         
113         static int UpdateHotkeyPy(void *self, const PyAttributeDef *);
114
115         // get button status
116         KX_PYMETHOD_DOC_O(SCA_MouseSensor,getButtonStatus);
117 #endif
118 };
119
120 #endif  /* __SCA_MOUSESENSOR_H__ */