include/InputDevice.h File Reference


Detailed Description

Input Device Interface Module - Header.

Author:
Richard Marks <ccpsceo@gmail.com>

Definition in file InputDevice.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  ENGINE
namespace  ENGINE::KEY
namespace  ENGINE::AXIS

Classes

class  ENGINE::InputDeviceSingleton
 Interface to the input devices; keyboard, mouse, and joystick. More...

Defines

#define InputDevice   InputDeviceSingleton::GetInstance()
 an alias to the InputDeviceSingleton::GetInstance() function

Enumerations

enum  ENGINE::KEY::Modifier {
  ENGINE::KEY::Mod_Shift = 0x0001, ENGINE::KEY::Mod_Ctrl = 0x0002, ENGINE::KEY::Mod_Alt = 0x0004, ENGINE::KEY::Mod_LSuper = 0x0008,
  ENGINE::KEY::Mod_RSuper = 0x0010, ENGINE::KEY::Mod_Menu = 0x0020, ENGINE::KEY::Mod_Command = 0x0040, ENGINE::KEY::Mod_ScrollLock = 0x0100,
  ENGINE::KEY::Mod_NumLock = 0x0200, ENGINE::KEY::Mod_CapsLock = 0x0400, ENGINE::KEY::Mod_InAltSeq = 0x0800, ENGINE::KEY::Mod_Accent1 = 0x1000,
  ENGINE::KEY::Mod_Accent2 = 0x2000, ENGINE::KEY::Mod_Accent3 = 0x4000, ENGINE::KEY::Mod_Accent4 = 0x8000
}
 modifier key bit masks to be used in the keyboard functions to check modifier keys such as CTRL More...
enum  ENGINE::KEY::VirtualKey {
  ENGINE::KEY::Key_A = 0x1, ENGINE::KEY::Key_B = 0x2, ENGINE::KEY::Key_C = 0x3, ENGINE::KEY::Key_D = 0x4,
  ENGINE::KEY::Key_E = 0x5, ENGINE::KEY::Key_F = 0x6, ENGINE::KEY::Key_G = 0x7, ENGINE::KEY::Key_H = 0x8,
  ENGINE::KEY::Key_I = 0x9, ENGINE::KEY::Key_J = 0xA, ENGINE::KEY::Key_K = 0xB, ENGINE::KEY::Key_L = 0xC,
  ENGINE::KEY::Key_M = 0xD, ENGINE::KEY::Key_N = 0xE, ENGINE::KEY::Key_O = 0xF, ENGINE::KEY::Key_P = 0x10,
  ENGINE::KEY::Key_Q = 0x11, ENGINE::KEY::Key_R = 0x12, ENGINE::KEY::Key_S = 0x13, ENGINE::KEY::Key_T = 0x14,
  ENGINE::KEY::Key_U = 0x15, ENGINE::KEY::Key_V = 0x16, ENGINE::KEY::Key_W = 0x17, ENGINE::KEY::Key_X = 0x18,
  ENGINE::KEY::Key_Y = 0x19, ENGINE::KEY::Key_Z = 0x1A, ENGINE::KEY::Key_0 = 0x1B, ENGINE::KEY::Key_1 = 0x1C,
  ENGINE::KEY::Key_2 = 0x1D, ENGINE::KEY::Key_3 = 0x1E, ENGINE::KEY::Key_4 = 0x1F, ENGINE::KEY::Key_5 = 0x20,
  ENGINE::KEY::Key_6 = 0x21, ENGINE::KEY::Key_7 = 0x22, ENGINE::KEY::Key_8 = 0x23, ENGINE::KEY::Key_9 = 0x24,
  ENGINE::KEY::Key_Num0 = 0x25, ENGINE::KEY::Key_Num1 = 0x26, ENGINE::KEY::Key_Num2 = 0x27, ENGINE::KEY::Key_Num3 = 0x28,
  ENGINE::KEY::Key_Num4 = 0x29, ENGINE::KEY::Key_Num5 = 0x2A, ENGINE::KEY::Key_Num6 = 0x2B, ENGINE::KEY::Key_Num7 = 0x2C,
  ENGINE::KEY::Key_Num8 = 0x2D, ENGINE::KEY::Key_Num9 = 0x2E, ENGINE::KEY::Key_F1 = 0x2F, ENGINE::KEY::Key_F2 = 0x30,
  ENGINE::KEY::Key_F3 = 0x31, ENGINE::KEY::Key_F4 = 0x32, ENGINE::KEY::Key_F5 = 0x33, ENGINE::KEY::Key_F6 = 0x34,
  ENGINE::KEY::Key_F7 = 0x35, ENGINE::KEY::Key_F8 = 0x36, ENGINE::KEY::Key_F9 = 0x37, ENGINE::KEY::Key_F10 = 0x38,
  ENGINE::KEY::Key_F11 = 0x39, ENGINE::KEY::Key_F12 = 0x3A, ENGINE::KEY::Key_Escape = 0x3B, ENGINE::KEY::Key_Tilde = 0x3C,
  ENGINE::KEY::Key_Minus = 0x3D, ENGINE::KEY::Key_Equals = 0x3E, ENGINE::KEY::Key_Backspace = 0x3F, ENGINE::KEY::Key_Tab = 0x40,
  ENGINE::KEY::Key_OpenBrace = 0x41, ENGINE::KEY::Key_CloseBrace = 0x42, ENGINE::KEY::Key_Enter = 0x43, ENGINE::KEY::Key_Colon = 0x44,
  ENGINE::KEY::Key_Quote = 0x45, ENGINE::KEY::Key_Backslash = 0x46, ENGINE::KEY::Key_Backslash2 = 0x47, ENGINE::KEY::Key_Comma = 0x48,
  ENGINE::KEY::Key_Stop = 0x49, ENGINE::KEY::Key_Divide = 0x4A, ENGINE::KEY::Key_Space = 0x4B, ENGINE::KEY::Key_Insert = 0x4C,
  ENGINE::KEY::Key_Delete = 0x4D, ENGINE::KEY::Key_Home = 0x4E, ENGINE::KEY::Key_End = 0x4F, ENGINE::KEY::Key_PageUp = 0x50,
  ENGINE::KEY::Key_PageDown = 0x51, ENGINE::KEY::Key_Left = 0x52, ENGINE::KEY::Key_Right = 0x53, ENGINE::KEY::Key_Up = 0x54,
  ENGINE::KEY::Key_Down = 0x55, ENGINE::KEY::Key_NumDivide = 0x56, ENGINE::KEY::Key_Asterisk = 0x57, ENGINE::KEY::Key_NumMinus = 0x58,
  ENGINE::KEY::Key_NumPlus = 0x59, ENGINE::KEY::Key_NumDelete = 0x5A, ENGINE::KEY::Key_NumEnter = 0x5B, ENGINE::KEY::Key_PrintScreen = 0x5C,
  ENGINE::KEY::Key_Pause = 0x5D, ENGINE::KEY::Key_AbntC1 = 0x5E, ENGINE::KEY::Key_Yen = 0x5F, ENGINE::KEY::Key_Kana = 0x60,
  ENGINE::KEY::Key_Convert = 0x61, ENGINE::KEY::Key_NoConvert = 0x62, ENGINE::KEY::Key_At = 0x63, ENGINE::KEY::Key_Circumflex = 0x64,
  ENGINE::KEY::Key_Colon2 = 0x65, ENGINE::KEY::Key_Kanji = 0x66, ENGINE::KEY::Key_NumEquals = 0x67, ENGINE::KEY::Key_Backtick = 0x68,
  ENGINE::KEY::Key_Semicolon = 0x69, ENGINE::KEY::Key_Command = 0x6A, ENGINE::KEY::Key_Unknown1 = 0x6B, ENGINE::KEY::Key_Unknown2 = 0x6C,
  ENGINE::KEY::Key_Unknown3 = 0x6D, ENGINE::KEY::Key_Unknown4 = 0x6E, ENGINE::KEY::Key_Unknown5 = 0x6F, ENGINE::KEY::Key_Unknown6 = 0x70,
  ENGINE::KEY::Key_Unknown7 = 0x71, ENGINE::KEY::Key_Unknown8 = 0x72, ENGINE::KEY::Key_Modifiers = 0x73, ENGINE::KEY::Key_LShift = 0x73,
  ENGINE::KEY::Key_RShift = 0x74, ENGINE::KEY::Key_LCtrl = 0x75, ENGINE::KEY::Key_RCtrl = 0x76, ENGINE::KEY::Key_Alt = 0x77,
  ENGINE::KEY::Key_AltGr = 0x78, ENGINE::KEY::Key_LSuper = 0x79, ENGINE::KEY::Key_RSuper = 0x7A, ENGINE::KEY::Key_Menu = 0x7B,
  ENGINE::KEY::Key_ScrollLock = 0x7C, ENGINE::KEY::Key_NumLock = 0x7D, ENGINE::KEY::Key_CapsLock = 0x7E, ENGINE::KEY::Key_Max = 0x7F
}
 virtual-key codes for every key we could ever need More...
enum  ENGINE::AXIS::Axis { ENGINE::AXIS::Axis_X = 0x1, ENGINE::AXIS::Axis_Y = 0x2, ENGINE::AXIS::Axis_Z = 0x3 }
 enumerations for devices that move on any of 3 cardinal axes More...

Variables

const unsigned int ENGINE::INIT_KEYBOARD = 0x0001
 bitmask for the InputDeviceSingleton::Initialize() function. -- initialize the keyboard
const unsigned int ENGINE::INIT_MOUSE = 0x0002
 bitmask for the InputDeviceSingleton::Initialize() function -- initialize the mouse
const unsigned int ENGINE::INIT_JOYSTICK = 0x0004
 bitmask for the InputDeviceSingleton::Initialize() function -- initialize the joystick
const unsigned int ENGINE::INIT_ALLDEVICES = 0x0007
 bitmask for the InputDeviceSingleton::Initialize() function -- initialize all devices
const unsigned int ENGINE::UPDATE_KEYBOARD = 0x0001
 bitmask for the InputDeviceSingleton::Update() function. -- update the keyboard
const unsigned int ENGINE::UPDATE_MOUSE = 0x0002
 bitmask for the InputDeviceSingleton::Update() function -- update the mouse
const unsigned int ENGINE::UPDATE_JOYSTICK = 0x0004
 bitmask for the InputDeviceSingleton::Update() function -- update the joystick
const unsigned int ENGINE::UPDATE_ALLDEVICES = 0x0007
 bitmask for the InputDeviceSingleton::Update() function -- update all devices


Define Documentation

#define InputDevice   InputDeviceSingleton::GetInstance()

an alias to the InputDeviceSingleton::GetInstance() function

Definition at line 595 of file InputDevice.h.


Generated on Tue Mar 3 20:11:33 2009 for ged101minimal by  doxygen 1.5.5