source/gameengine/BlenderRoutines/KX_BlenderInputDevice.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  */
  29 #ifndef __KX_BLENDERINPUTDEVICE
  30 #define __KX_BLENDERINPUTDEVICE
  31
  32 #if defined(WIN32) && !defined(FREE_WINDOWS)
  33 #pragma warning(disable : 4786)  // shut off 255 char limit debug template warning
  34 #endif
  35
  36 #include <map>
  37
  38 #include "wm_event_types.h"
  39 #include "WM_types.h"
  40 #include "SCA_IInputDevice.h"
  41
  42 #ifdef WITH_CXX_GUARDEDALLOC
  43 #include "MEM_guardedalloc.h"
  44 #endif
  45
  46 /**
  47  Base Class for Blender specific inputdevices. Blender specific inputdevices are used when the gameengine is running in embedded mode instead of standalone mode.
  48 */
  49 class BL_BlenderInputDevice : public SCA_IInputDevice
  50 {
  51         // this map is Blender specific: a conversion between blender and ketsji enums
  52         std::map<int,KX_EnumInputs> m_reverseKeyTranslateTable;
  53 public:
  54         BL_BlenderInputDevice()
  55                 {
  56
  57                         /* The reverse table. In order to not confuse ourselves, we      */
  58                         /* immediately convert all events that come in to KX codes.      */
  59                         m_reverseKeyTranslateTable[LEFTMOUSE                    ] =     KX_LEFTMOUSE            ;
  60                         m_reverseKeyTranslateTable[MIDDLEMOUSE                  ] =     KX_MIDDLEMOUSE          ;
  61                         m_reverseKeyTranslateTable[RIGHTMOUSE                   ] =     KX_RIGHTMOUSE           ;
  62                         m_reverseKeyTranslateTable[WHEELUPMOUSE                 ] =     KX_WHEELUPMOUSE         ;
  63                         m_reverseKeyTranslateTable[WHEELDOWNMOUSE               ] =     KX_WHEELDOWNMOUSE       ;
  64                         m_reverseKeyTranslateTable[MOUSEX                       ] =     KX_MOUSEX               ;
  65                         m_reverseKeyTranslateTable[MOUSEY                       ] =     KX_MOUSEY               ;
  66
  67                         // TIMERS
  68
  69                         m_reverseKeyTranslateTable[TIMER0                           ] = KX_TIMER0                  ;
  70                         m_reverseKeyTranslateTable[TIMER1                           ] = KX_TIMER1                  ;
  71                         m_reverseKeyTranslateTable[TIMER2                           ] = KX_TIMER2                  ;
  72
  73                         // SYSTEM
  74 #if 0
  75                         /* **** XXX **** */
  76                         m_reverseKeyTranslateTable[KEYBD                            ] = KX_KEYBD                   ;
  77                         m_reverseKeyTranslateTable[RAWKEYBD                         ] = KX_RAWKEYBD                ;
  78                         m_reverseKeyTranslateTable[REDRAW                           ] = KX_REDRAW                  ;
  79                         m_reverseKeyTranslateTable[INPUTCHANGE                      ] = KX_INPUTCHANGE             ;
  80                         m_reverseKeyTranslateTable[QFULL                            ] = KX_QFULL                   ;
  81                         m_reverseKeyTranslateTable[WINFREEZE                        ] = KX_WINFREEZE               ;
  82                         m_reverseKeyTranslateTable[WINTHAW                          ] = KX_WINTHAW                 ;
  83                         m_reverseKeyTranslateTable[WINCLOSE                         ] = KX_WINCLOSE                ;
  84                         m_reverseKeyTranslateTable[WINQUIT                          ] = KX_WINQUIT                 ;
  85                         m_reverseKeyTranslateTable[Q_FIRSTTIME                      ] = KX_Q_FIRSTTIME             ;
  86                         /* **** XXX **** */
  87 #endif
  88                         // standard keyboard
  89
  90                         m_reverseKeyTranslateTable[AKEY                             ] = KX_AKEY                    ;
  91                         m_reverseKeyTranslateTable[BKEY                             ] = KX_BKEY                    ;
  92                         m_reverseKeyTranslateTable[CKEY                             ] = KX_CKEY                    ;
  93                         m_reverseKeyTranslateTable[DKEY                             ] = KX_DKEY                    ;
  94                         m_reverseKeyTranslateTable[EKEY                             ] = KX_EKEY                    ;
  95                         m_reverseKeyTranslateTable[FKEY                             ] = KX_FKEY                    ;
  96                         m_reverseKeyTranslateTable[GKEY                             ] = KX_GKEY                    ;
  97 //XXX clean up
  98 #ifdef WIN32
  99 #define HKEY    'h'
 100 #endif
 101                         m_reverseKeyTranslateTable[HKEY                             ] = KX_HKEY                    ;
 102 //XXX clean up
 103 #ifdef WIN32
 104 #undef HKEY
 105 #endif
 106                         m_reverseKeyTranslateTable[IKEY                             ] = KX_IKEY                    ;
 107                         m_reverseKeyTranslateTable[JKEY                             ] = KX_JKEY                    ;
 108                         m_reverseKeyTranslateTable[KKEY                             ] = KX_KKEY                    ;
 109                         m_reverseKeyTranslateTable[LKEY                             ] = KX_LKEY                    ;
 110                         m_reverseKeyTranslateTable[MKEY                             ] = KX_MKEY                    ;
 111                         m_reverseKeyTranslateTable[NKEY                             ] = KX_NKEY                    ;
 112                         m_reverseKeyTranslateTable[OKEY                             ] = KX_OKEY                    ;
 113                         m_reverseKeyTranslateTable[PKEY                             ] = KX_PKEY                    ;
 114                         m_reverseKeyTranslateTable[QKEY                             ] = KX_QKEY                    ;
 115                         m_reverseKeyTranslateTable[RKEY                             ] = KX_RKEY                    ;
 116                         m_reverseKeyTranslateTable[SKEY                             ] = KX_SKEY                    ;
 117                         m_reverseKeyTranslateTable[TKEY                             ] = KX_TKEY                    ;
 118                         m_reverseKeyTranslateTable[UKEY                             ] = KX_UKEY                    ;
 119                         m_reverseKeyTranslateTable[VKEY                             ] = KX_VKEY                    ;
 120                         m_reverseKeyTranslateTable[WKEY                             ] = KX_WKEY                    ;
 121                         m_reverseKeyTranslateTable[XKEY                             ] = KX_XKEY                    ;
 122                         m_reverseKeyTranslateTable[YKEY                             ] = KX_YKEY                    ;
 123                         m_reverseKeyTranslateTable[ZKEY                             ] = KX_ZKEY                    ;
 124
 125                         m_reverseKeyTranslateTable[ZEROKEY                              ] = KX_ZEROKEY                  ;
 126                         m_reverseKeyTranslateTable[ONEKEY                               ] = KX_ONEKEY                   ;
 127                         m_reverseKeyTranslateTable[TWOKEY                               ] = KX_TWOKEY                   ;
 128                         m_reverseKeyTranslateTable[THREEKEY                     ] = KX_THREEKEY                ;
 129                         m_reverseKeyTranslateTable[FOURKEY                              ] = KX_FOURKEY                  ;
 130                         m_reverseKeyTranslateTable[FIVEKEY                              ] = KX_FIVEKEY                  ;
 131                         m_reverseKeyTranslateTable[SIXKEY                               ] = KX_SIXKEY                   ;
 132                         m_reverseKeyTranslateTable[SEVENKEY                         ] = KX_SEVENKEY                ;
 133                         m_reverseKeyTranslateTable[EIGHTKEY                         ] = KX_EIGHTKEY                ;
 134                         m_reverseKeyTranslateTable[NINEKEY                              ] = KX_NINEKEY                  ;
 135
 136                         m_reverseKeyTranslateTable[CAPSLOCKKEY                      ] = KX_CAPSLOCKKEY             ;
 137
 138                         m_reverseKeyTranslateTable[LEFTCTRLKEY                  ] = KX_LEFTCTRLKEY              ;
 139                         m_reverseKeyTranslateTable[LEFTALTKEY                   ] = KX_LEFTALTKEY               ;
 140                         m_reverseKeyTranslateTable[RIGHTALTKEY                  ] = KX_RIGHTALTKEY              ;
 141                         m_reverseKeyTranslateTable[RIGHTCTRLKEY                         ] = KX_RIGHTCTRLKEY             ;
 142                         m_reverseKeyTranslateTable[RIGHTSHIFTKEY                        ] = KX_RIGHTSHIFTKEY            ;
 143                         m_reverseKeyTranslateTable[LEFTSHIFTKEY                     ] = KX_LEFTSHIFTKEY            ;
 144
 145                         m_reverseKeyTranslateTable[ESCKEY                           ] = KX_ESCKEY                  ;
 146                         m_reverseKeyTranslateTable[TABKEY                           ] = KX_TABKEY                  ;
 147                         m_reverseKeyTranslateTable[RETKEY                           ] = KX_RETKEY                  ;
 148                         m_reverseKeyTranslateTable[SPACEKEY                         ] = KX_SPACEKEY                ;
 149                         m_reverseKeyTranslateTable[LINEFEEDKEY                  ] = KX_LINEFEEDKEY              ;
 150                         m_reverseKeyTranslateTable[BACKSPACEKEY                     ] = KX_BACKSPACEKEY            ;
 151                         m_reverseKeyTranslateTable[DELKEY                           ] = KX_DELKEY                  ;
 152                         m_reverseKeyTranslateTable[SEMICOLONKEY                     ] = KX_SEMICOLONKEY            ;
 153                         m_reverseKeyTranslateTable[PERIODKEY                    ] = KX_PERIODKEY                ;
 154                         m_reverseKeyTranslateTable[COMMAKEY                             ] = KX_COMMAKEY         ;
 155                         m_reverseKeyTranslateTable[QUOTEKEY                             ] = KX_QUOTEKEY         ;
 156                         m_reverseKeyTranslateTable[ACCENTGRAVEKEY                       ] = KX_ACCENTGRAVEKEY           ;
 157                         m_reverseKeyTranslateTable[MINUSKEY                             ] = KX_MINUSKEY         ;
 158                         m_reverseKeyTranslateTable[SLASHKEY                             ] = KX_SLASHKEY         ;
 159                         m_reverseKeyTranslateTable[BACKSLASHKEY                     ] = KX_BACKSLASHKEY            ;
 160                         m_reverseKeyTranslateTable[EQUALKEY                             ] = KX_EQUALKEY         ;
 161                         m_reverseKeyTranslateTable[LEFTBRACKETKEY                       ] = KX_LEFTBRACKETKEY           ;
 162                         m_reverseKeyTranslateTable[RIGHTBRACKETKEY                      ] = KX_RIGHTBRACKETKEY          ;
 163
 164                         m_reverseKeyTranslateTable[LEFTARROWKEY                     ] = KX_LEFTARROWKEY            ;
 165                         m_reverseKeyTranslateTable[DOWNARROWKEY                     ] = KX_DOWNARROWKEY            ;
 166                         m_reverseKeyTranslateTable[RIGHTARROWKEY                        ] = KX_RIGHTARROWKEY            ;
 167                         m_reverseKeyTranslateTable[UPARROWKEY                   ] = KX_UPARROWKEY               ;
 168
 169                         m_reverseKeyTranslateTable[PAD2                         ] = KX_PAD2                     ;
 170                         m_reverseKeyTranslateTable[PAD4                         ] = KX_PAD4                     ;
 171                         m_reverseKeyTranslateTable[PAD6                         ] = KX_PAD6                     ;
 172                         m_reverseKeyTranslateTable[PAD8                         ] = KX_PAD8                     ;
 173
 174                         m_reverseKeyTranslateTable[PAD1                         ] = KX_PAD1                     ;
 175                         m_reverseKeyTranslateTable[PAD3                         ] = KX_PAD3                     ;
 176                         m_reverseKeyTranslateTable[PAD5                         ] = KX_PAD5                     ;
 177                         m_reverseKeyTranslateTable[PAD7                         ] = KX_PAD7                     ;
 178                         m_reverseKeyTranslateTable[PAD9                         ] = KX_PAD9                     ;
 179
 180                         m_reverseKeyTranslateTable[PADPERIOD                        ] = KX_PADPERIOD               ;
 181                         m_reverseKeyTranslateTable[PADSLASHKEY                    ] = KX_PADSLASHKEY           ;
 182                         m_reverseKeyTranslateTable[PADASTERKEY                      ] = KX_PADASTERKEY             ;
 183
 184
 185                         m_reverseKeyTranslateTable[PAD0                         ] = KX_PAD0                     ;
 186                         m_reverseKeyTranslateTable[PADMINUS                         ] = KX_PADMINUS                ;
 187                         m_reverseKeyTranslateTable[PADENTER                         ] = KX_PADENTER                ;
 188                         m_reverseKeyTranslateTable[PADPLUSKEY                       ] = KX_PADPLUSKEY              ;
 189
 190
 191                         m_reverseKeyTranslateTable[F1KEY                            ] = KX_F1KEY                   ;
 192                         m_reverseKeyTranslateTable[F2KEY                            ] = KX_F2KEY                   ;
 193                         m_reverseKeyTranslateTable[F3KEY                            ] = KX_F3KEY                   ;
 194                         m_reverseKeyTranslateTable[F4KEY                            ] = KX_F4KEY                   ;
 195                         m_reverseKeyTranslateTable[F5KEY                            ] = KX_F5KEY                   ;
 196                         m_reverseKeyTranslateTable[F6KEY                            ] = KX_F6KEY                   ;
 197                         m_reverseKeyTranslateTable[F7KEY                            ] = KX_F7KEY                   ;
 198                         m_reverseKeyTranslateTable[F8KEY                            ] = KX_F8KEY                   ;
 199                         m_reverseKeyTranslateTable[F9KEY                            ] = KX_F9KEY                   ;
 200                         m_reverseKeyTranslateTable[F10KEY                           ] = KX_F10KEY                  ;
 201                         m_reverseKeyTranslateTable[F11KEY      ] = KX_F11KEY                  ;
 202                         m_reverseKeyTranslateTable[F12KEY      ] = KX_F12KEY                  ;
 203                         m_reverseKeyTranslateTable[F13KEY      ] = KX_F13KEY                  ;
 204                         m_reverseKeyTranslateTable[F14KEY      ] = KX_F14KEY                  ;
 205                         m_reverseKeyTranslateTable[F15KEY      ] = KX_F15KEY                  ;
 206                         m_reverseKeyTranslateTable[F16KEY      ] = KX_F16KEY                  ;
 207                         m_reverseKeyTranslateTable[F17KEY      ] = KX_F17KEY                  ;
 208                         m_reverseKeyTranslateTable[F18KEY      ] = KX_F18KEY                  ;
 209                         m_reverseKeyTranslateTable[F19KEY      ] = KX_F19KEY                  ;
 210
 211                         m_reverseKeyTranslateTable[PAUSEKEY    ] = KX_PAUSEKEY                ;
 212                         m_reverseKeyTranslateTable[INSERTKEY   ] = KX_INSERTKEY               ;
 213                         m_reverseKeyTranslateTable[HOMEKEY     ] = KX_HOMEKEY                 ;
 214                         m_reverseKeyTranslateTable[PAGEUPKEY   ] = KX_PAGEUPKEY               ;
 215                         m_reverseKeyTranslateTable[PAGEDOWNKEY ] = KX_PAGEDOWNKEY             ;
 216                         m_reverseKeyTranslateTable[ENDKEY      ] = KX_ENDKEY                  ;
 217
 218
 219                 }
 220
 221         virtual ~BL_BlenderInputDevice()
 222                 {
 223
 224                 }
 225
 226          KX_EnumInputs ToNative(unsigned short incode) {
 227                 return m_reverseKeyTranslateTable[incode];
 228         }
 229
 230         virtual bool    IsPressed(SCA_IInputDevice::KX_EnumInputs inputcode)=0;
 231 //      virtual const SCA_InputEvent&   GetEventValue(SCA_IInputDevice::KX_EnumInputs inputcode)=0;
 232         virtual bool    ConvertBlenderEvent(unsigned short incode,short val)=0;
 233
 234
 235 #ifdef WITH_CXX_GUARDEDALLOC
 236 public:
 237         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:BL_BlenderInputDevice"); }
 238         void operator delete(void *mem) { MEM_freeN(mem); }
 239 #endif
 240 };
 241 #endif //__KX_BLENDERINPUTDEVICE
 242