NLA SoC: Merge from 2.5
[blender.git] / source / gameengine / GameLogic / SCA_MouseSensor.h
1 /**
2  * Senses mouse events
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): José I. Romero (cleanup and fixes)
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #ifndef __KX_MOUSESENSOR
33 #define __KX_MOUSESENSOR
34
35 #include "SCA_ISensor.h"
36 #include "BoolValue.h"
37 #include "SCA_IInputDevice.h"
38
39 class SCA_MouseSensor : public SCA_ISensor
40 {
41         Py_Header;
42         class SCA_MouseManager* m_pMouseMgr;
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         static int UpdateHotkey(void *self, const PyAttributeDef*);
91         
92         SCA_MouseSensor(class SCA_MouseManager* keybdmgr,
93                                         int startx,int starty,
94                                    short int mousemode,
95                                    SCA_IObject* gameobj);
96
97         virtual ~SCA_MouseSensor();
98         virtual CValue* GetReplica();
99         virtual bool Evaluate();
100         virtual void Init();
101         virtual bool IsPositiveTrigger();
102         short int GetModeKey();
103         SCA_IInputDevice::KX_EnumInputs GetHotKey();
104         void setX(short x);
105         void setY(short y);
106         
107         /* --------------------------------------------------------------------- */
108         /* Python interface ---------------------------------------------------- */
109         /* --------------------------------------------------------------------- */
110
111         //Deprecated functions ----->
112         /* read x-coordinate */
113         KX_PYMETHOD_DOC_NOARGS(SCA_MouseSensor,GetXPosition);
114         /* read y-coordinate */
115         KX_PYMETHOD_DOC_NOARGS(SCA_MouseSensor,GetYPosition);
116         //<----- deprecated
117         
118         // get button status
119         KX_PYMETHOD_DOC_O(SCA_MouseSensor,getButtonStatus);
120
121 };
122
123 #endif //__KX_MOUSESENSOR
124