rename and negate DISABLE_PYTHON --> WITH_PYTHON
[blender.git] / source / gameengine / GameLogic / SCA_KeyboardSensor.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL 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.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * Sensor for keyboard input
29  */
30
31 #ifndef __KX_KEYBOARDSENSOR
32 #define __KX_KEYBOARDSENSOR
33
34 #include "SCA_ISensor.h"
35 #include "BoolValue.h"
36 #include <list>
37
38 /**
39  * The keyboard sensor listens to the keyboard, and passes on events
40  * on selected keystrokes. It has an alternate mode in which it logs
41  * keypresses to a property. Note that these modes are not mutually
42  * exclusive.  */
43 class SCA_KeyboardSensor : public SCA_ISensor
44 {
45         Py_Header;
46
47         /**
48          * the key this sensor is sensing for
49          */
50         int                                                     m_hotkey;
51         short int                                       m_qual,m_qual2;
52         short int                                       m_val;
53         /**
54          * If this toggle is true, all incoming key events generate a
55          * response.
56          */
57         bool                                            m_bAllKeys;
58
59         /**
60          * The name of the property to which logged text is appended. If
61          * this property is not defined, no logging takes place.
62          */
63         STR_String      m_targetprop;
64         /**
65          * The property that indicates whether or not to log text when in
66          * loggin mode. If the property equals 0, no loggin is done. For
67          * all other values, logging is active. Logging can only become
68          * active if there is a property to log to. Logging is independant
69          * from hotkey settings. */
70         STR_String      m_toggleprop;
71
72         /**
73          * Log the keystrokes from the current input buffer.
74          */
75         void LogKeystrokes(void);
76         
77         /**
78          * Adds this key-code to the target prop.
79          */
80         void AddToTargetProp(int keyIndex);
81
82         /**
83          * Tests whether shift is pressed.
84          */
85         bool IsShifted(void);
86         
87 public:
88         SCA_KeyboardSensor(class SCA_KeyboardManager* keybdmgr,
89                                            short int hotkey,
90                                            short int qual,
91                                            short int qual2,
92                                            bool bAllKeys,
93                                            const STR_String& targetProp,
94                                            const STR_String& toggleProp,
95                                            SCA_IObject* gameobj);
96         virtual ~SCA_KeyboardSensor();
97         virtual CValue* GetReplica();
98         virtual void Init();
99
100
101         short int GetHotkey();
102         virtual bool Evaluate();
103         virtual bool IsPositiveTrigger();
104         bool    TriggerOnAllKeys();
105
106 #ifdef WITH_PYTHON
107         /* --------------------------------------------------------------------- */
108         /* Python interface ---------------------------------------------------- */
109         /* --------------------------------------------------------------------- */
110
111         // KeyEvents: 
112         KX_PYMETHOD_DOC_NOARGS(SCA_KeyboardSensor,getEventList); 
113         // KeyStatus: 
114         KX_PYMETHOD_DOC_O(SCA_KeyboardSensor,getKeyStatus);
115         
116         static PyObject*        pyattr_get_events(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
117 #endif
118 };
119
120
121 /**
122  * Transform keycodes to something printable.
123  */
124 char ToCharacter(int keyIndex, bool shifted);
125
126 /**
127  * Determine whether this character can be printed. We cannot use
128  * the library functions here, because we need to test our own
129  * keycodes. */
130 bool IsPrintable(int keyIndex);
131
132 /**
133  * Tests whether this is a delete key.
134  */     
135 bool IsDelete(int keyIndex);
136
137
138 #endif //__KX_KEYBOARDSENSOR
139
140
141