code cleanup: make header defines more consistent, JOYSENSOR header guard had a typo...
[blender-staging.git] / source / gameengine / GamePlayer / common / GPC_KeyboardDevice.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_KeyboardDevice.h
29  *  \ingroup player
30  */
31
32 #ifndef __GPC_KEYBOARDDEVICE_H__
33 #define __GPC_KEYBOARDDEVICE_H__
34
35 #ifdef WIN32
36 #pragma warning (disable : 4786)
37 #endif  /* WIN32 */
38
39 #include "SCA_IInputDevice.h"
40
41 #include <map>
42
43
44 /**
45  * System independent implementation of SCA_IInputDevice.
46  * System dependent keyboard devices need only to inherit this class
47  * and fill the m_reverseKeyTranslateTable key translation map.
48  * \see SCA_IInputDevice
49  */
50
51 class GPC_KeyboardDevice : public SCA_IInputDevice
52 {
53 protected:
54
55         /**
56          * This map converts system dependent keyboard codes into Ketsji codes.
57          * System dependent keyboard codes are stored as ints.
58          */
59         std::map<int, KX_EnumInputs> m_reverseKeyTranslateTable;
60         short   m_exitkey;
61
62 public:
63         bool m_hookesc;
64         GPC_KeyboardDevice()
65                 : m_hookesc(false)
66         {
67         }
68
69         virtual ~GPC_KeyboardDevice(void)
70         {
71         }
72
73         virtual bool IsPressed(SCA_IInputDevice::KX_EnumInputs inputcode)
74         {
75                 return false;
76         }
77
78         virtual void NextFrame();
79         
80         virtual KX_EnumInputs ToNative(int incode)
81         {
82                 return m_reverseKeyTranslateTable[incode];
83         }
84
85         virtual bool ConvertEvent(int incode, int val);
86         
87         virtual void HookEscape();
88 };
89
90 #endif  /* __GPC_KEYBOARDDEVICE_H__ */