Initial revision
[blender.git] / source / gameengine / GameLogic / SCA_MouseSensor.h
1 /**
2  * Senses mouse events
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL/BL DUAL 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. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34
35 #ifndef __KX_MOUSESENSOR
36 #define __KX_MOUSESENSOR
37
38 #include "SCA_ISensor.h"
39 #include "BoolValue.h"
40 #include "SCA_IInputDevice.h"
41
42 class SCA_MouseSensor : public SCA_ISensor
43 {
44         Py_Header;
45         class SCA_MouseManager* m_pMouseMgr;
46         
47         /**
48          * Use SCA_IInputDevice values to encode the mouse mode for now.
49          */
50         short int m_mousemode;
51         /**
52          * Triggermode true means all mouse events trigger. Useful mainly
53          * for button presses.
54          */
55         bool m_triggermode;
56         /**
57          * Remember the last state update 
58          */
59         int m_val;
60
61         SCA_IInputDevice::KX_EnumInputs m_hotkey;
62         
63         /**
64          * valid x coordinate
65          */
66         short m_x;
67
68         /**
69          * valid y coordinate
70          */
71         short m_y;
72         
73  public:
74         /**
75          * Allowable modes for the trigger status of the mouse sensor.
76          */
77         enum KX_MOUSESENSORMODE {
78                 KX_MOUSESENSORMODE_NODEF = 0,
79                 KX_MOUSESENSORMODE_LEFTBUTTON,
80                 KX_MOUSESENSORMODE_MIDDLEBUTTON,
81                 KX_MOUSESENSORMODE_RIGHTBUTTON,
82                 KX_MOUSESENSORMODE_POSITION,
83                 KX_MOUSESENSORMODE_POSITIONX,
84                 KX_MOUSESENSORMODE_POSITIONY,
85                 KX_MOUSESENSORMODE_MOVEMENT,
86                 KX_MOUSESENSORMODE_MAX
87         };
88
89         bool isValid(KX_MOUSESENSORMODE);
90         
91         SCA_MouseSensor(class SCA_MouseManager* keybdmgr,
92                                         int startx,int starty,
93                                    short int mousemode,
94                                    SCA_IObject* gameobj,
95                                    PyTypeObject* T=&Type );
96
97         virtual ~SCA_MouseSensor();
98         virtual CValue* GetReplica();
99         virtual bool Evaluate(CValue* event);
100
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         virtual PyObject*  _getattr(char *attr);
112
113         /* read x-coordinate */
114         KX_PYMETHOD_DOC(SCA_MouseSensor,GetXPosition);
115         /* read y-coordinate */
116         KX_PYMETHOD_DOC(SCA_MouseSensor,GetYPosition);
117
118 };
119
120 #endif //__KX_MOUSESENSOR