Support Forum       G3D Web Page     
Public Types | Public Member Functions | Static Public Member Functions | List of all members
G3D::GKey Class Reference

A mapping of every physical key on the keyboard and other input devices in a (mostly) platform independent manner. More...

Public Types

enum  Value {
  UNKNOWN = 0,
  FIRST = 0,
  BACKSPACE = 8,
  TAB = 9,
  CLEAR = 12,
  RETURN = 13,
  PAUSE = 19,
  ESCAPE = 27,
  SPACE = 32,
  EXCLAIM = 33,
  QUOTEDBL = 34,
  HASH = 35,
  DOLLAR = 36,
  AMPERSAND = 38,
  QUOTE = 39,
  LEFTPAREN = 40,
  RIGHTPAREN = 41,
  ASTERISK = 42,
  PLUS = 43,
  COMMA = 44,
  MINUS = 45,
  PERIOD = 46,
  SLASH = 47,
  COLON = 58,
  SEMICOLON = 59,
  LESS = 60,
  EQUALS = 61,
  GREATER = 62,
  QUESTION = 63,
  AT = 64,
  LEFTBRACKET = 91,
  BACKSLASH = 92,
  RIGHTBRACKET = 93,
  CARET = 94,
  UNDERSCORE = 95,
  BACKQUOTE = 96,
  DELETE = 127,
  WORLD_0 = 160,
  WORLD_1 = 161,
  WORLD_2 = 162,
  WORLD_3 = 163,
  WORLD_4 = 164,
  WORLD_5 = 165,
  WORLD_6 = 166,
  WORLD_7 = 167,
  WORLD_8 = 168,
  WORLD_9 = 169,
  WORLD_10 = 170,
  WORLD_11 = 171,
  WORLD_12 = 172,
  WORLD_13 = 173,
  WORLD_14 = 174,
  WORLD_15 = 175,
  WORLD_16 = 176,
  WORLD_17 = 177,
  WORLD_18 = 178,
  WORLD_19 = 179,
  WORLD_20 = 180,
  WORLD_21 = 181,
  WORLD_22 = 182,
  WORLD_23 = 183,
  WORLD_24 = 184,
  WORLD_25 = 185,
  WORLD_26 = 186,
  WORLD_27 = 187,
  WORLD_28 = 188,
  WORLD_29 = 189,
  WORLD_30 = 190,
  WORLD_31 = 191,
  WORLD_32 = 192,
  WORLD_33 = 193,
  WORLD_34 = 194,
  WORLD_35 = 195,
  WORLD_36 = 196,
  WORLD_37 = 197,
  WORLD_38 = 198,
  WORLD_39 = 199,
  WORLD_40 = 200,
  WORLD_41 = 201,
  WORLD_42 = 202,
  WORLD_43 = 203,
  WORLD_44 = 204,
  WORLD_45 = 205,
  WORLD_46 = 206,
  WORLD_47 = 207,
  WORLD_48 = 208,
  WORLD_49 = 209,
  WORLD_50 = 210,
  WORLD_51 = 211,
  WORLD_52 = 212,
  WORLD_53 = 213,
  WORLD_54 = 214,
  WORLD_55 = 215,
  WORLD_56 = 216,
  WORLD_57 = 217,
  WORLD_58 = 218,
  WORLD_59 = 219,
  WORLD_60 = 220,
  WORLD_61 = 221,
  WORLD_62 = 222,
  WORLD_63 = 223,
  WORLD_64 = 224,
  WORLD_65 = 225,
  WORLD_66 = 226,
  WORLD_67 = 227,
  WORLD_68 = 228,
  WORLD_69 = 229,
  WORLD_70 = 230,
  WORLD_71 = 231,
  WORLD_72 = 232,
  WORLD_73 = 233,
  WORLD_74 = 234,
  WORLD_75 = 235,
  WORLD_76 = 236,
  WORLD_77 = 237,
  WORLD_78 = 238,
  WORLD_79 = 239,
  WORLD_80 = 240,
  WORLD_81 = 241,
  WORLD_82 = 242,
  WORLD_83 = 243,
  WORLD_84 = 244,
  WORLD_85 = 245,
  WORLD_86 = 246,
  WORLD_87 = 247,
  WORLD_88 = 248,
  WORLD_89 = 249,
  WORLD_90 = 250,
  WORLD_91 = 251,
  WORLD_92 = 252,
  WORLD_93 = 253,
  WORLD_94 = 254,
  WORLD_95 = 255,
  KP0 = 256,
  KP1 = 257,
  KP2 = 258,
  KP3 = 259,
  KP4 = 260,
  KP5 = 261,
  KP6 = 262,
  KP7 = 263,
  KP8 = 264,
  KP9 = 265,
  KP_PERIOD = 266,
  KP_DIVIDE = 267,
  KP_MULTIPLY = 268,
  KP_MINUS = 269,
  KP_PLUS = 270,
  KP_ENTER = 271,
  KP_EQUALS = 272,
  UP = 273,
  DOWN = 274,
  RIGHT = 275,
  LEFT = 276,
  INSERT = 277,
  HOME = 278,
  END = 279,
  PAGEUP = 280,
  PAGEDOWN = 281,
  F1 = 282,
  F2 = 283,
  F3 = 284,
  F4 = 285,
  F5 = 286,
  F6 = 287,
  F7 = 288,
  F8 = 289,
  F9 = 290,
  F10 = 291,
  F11 = 292,
  F12 = 293,
  F13 = 294,
  F14 = 295,
  F15 = 296,
  NUMLOCK = 300,
  CAPSLOCK = 301,
  SCROLLOCK = 302,
  RSHIFT = 303,
  LSHIFT = 304,
  RCTRL = 305,
  LCTRL = 306,
  RALT = 307,
  LALT = 308,
  RMETA = 309,
  LMETA = 310,
  LSUPER = 311,
  RSUPER = 312,
  MODE = 313,
  COMPOSE = 314,
  HELP = 315,
  PRINT = 316,
  SYSREQ = 317,
  BREAK = 318,
  MENU = 319,
  POWER = 320,
  EURO = 321,
  UNDO = 322,
  LEFT_MOUSE = 324,
  MIDDLE_MOUSE,
  RIGHT_MOUSE,
  MOUSE_WHEEL_UP,
  MOUSE_WHEEL_DOWN,
  CONTROLLER_A,
  CONTROLLER_B,
  CONTROLLER_X,
  CONTROLLER_Y,
  CONTROLLER_LEFT_BUMPER,
  CONTROLLER_RIGHT_BUMPER,
  CONTROLLER_BACK,
  CONTROLLER_START,
  CONTROLLER_LEFT_CLICK,
  CONTROLLER_RIGHT_CLICK,
  CONTROLLER_DPAD_UP,
  CONTROLLER_DPAD_RIGHT,
  CONTROLLER_DPAD_DOWN,
  CONTROLLER_DPAD_LEFT,
  CONTROLLER_GUIDE,
  CONTROLLER_LEFT_TRIGGER,
  CONTROLLER_RIGHT_TRIGGER,
  CONTROLLER_RESERVED_1,
  CONTROLLER_RESERVED_2,
  CONTROLLER_RESERVED_3,
  CONTROLLER_RESERVED_4,
  CONTROLLER_LAST = CONTROLLER_RESERVED_4,
  LAST
}
 Don't use this enum directly; use GKey instances instead. More...
 

Public Member Functions

 GKey (const Any &a)
 
 GKey ()
 
 GKey (const Value v)
 
 GKey (int v)
 Allow construction, but not implicit casts. More...
 
void deserialize (BinaryInput &b)
 
unsigned int hashCode () const
 
 operator int () const
 
bool operator!= (const GKey other) const
 
bool operator!= (const GKey::Value other) const
 
GKey operator+ (const int x) const
 
GKey & operator++ ()
 
GKey & operator+= (const int x)
 
GKey operator- (const int x) const
 
GKey & operator-- ()
 
GKey & operator-= (const int x)
 
bool operator< (const GKey other) const
 
bool operator< (const Value other) const
 
bool operator<= (const GKey other) const
 
bool operator<= (const Value other) const
 
const GKey & operator= (const Any &a)
 
bool operator== (const GKey other) const
 
bool operator== (const GKey::Value other) const
 
bool operator> (const GKey other) const
 
bool operator> (const Value other) const
 
bool operator>= (const GKey other) const
 
bool operator>= (const Value other) const
 
void serialize (BinaryOutput &b) const
 
Any toAny () const
 
String toString () const
 

Static Public Member Functions

static GKey fromString (const String &_s)
 

Detailed Description

A mapping of every physical key on the keyboard and other input devices in a (mostly) platform independent manner.

International keyboards use the range 0xA1 - 0xFF as international virtual keycodes.

The scan codes have been chosen to map to ASCII for most printable characters (use lower-case letters for alphabetic keys).

Not all GKeys are generated as explicit events. E.g., the MOUSE and CONTROLLER are solely for use with UserInput.

See also
G3D::OSWindow, G3D::GameController, G3D::JoystickIndex, G3D::UserInput

Member Enumeration Documentation

◆ Value

enum G3D::GKey::Value

Don't use this enum directly; use GKey instances instead.

Enumerator
UNKNOWN 
FIRST 
BACKSPACE 
TAB 
CLEAR 
RETURN 
PAUSE 
ESCAPE 
SPACE 
EXCLAIM 
QUOTEDBL 
HASH 
DOLLAR 
AMPERSAND 
QUOTE 
LEFTPAREN 
RIGHTPAREN 
ASTERISK 
PLUS 
COMMA 
MINUS 
PERIOD 
SLASH 
COLON 
SEMICOLON 
LESS 
EQUALS 
GREATER 
QUESTION 
AT 
LEFTBRACKET 
BACKSLASH 
RIGHTBRACKET 
CARET 
UNDERSCORE 
BACKQUOTE 
DELETE 
WORLD_0 
WORLD_1 
WORLD_2 
WORLD_3 
WORLD_4 
WORLD_5 
WORLD_6 
WORLD_7 
WORLD_8 
WORLD_9 
WORLD_10 
WORLD_11 
WORLD_12 
WORLD_13 
WORLD_14 
WORLD_15 
WORLD_16 
WORLD_17 
WORLD_18 
WORLD_19 
WORLD_20 
WORLD_21 
WORLD_22 
WORLD_23 
WORLD_24 
WORLD_25 
WORLD_26 
WORLD_27 
WORLD_28 
WORLD_29 
WORLD_30 
WORLD_31 
WORLD_32 
WORLD_33 
WORLD_34 
WORLD_35 
WORLD_36 
WORLD_37 
WORLD_38 
WORLD_39 
WORLD_40 
WORLD_41 
WORLD_42 
WORLD_43 
WORLD_44 
WORLD_45 
WORLD_46 
WORLD_47 
WORLD_48 
WORLD_49 
WORLD_50 
WORLD_51 
WORLD_52 
WORLD_53 
WORLD_54 
WORLD_55 
WORLD_56 
WORLD_57 
WORLD_58 
WORLD_59 
WORLD_60 
WORLD_61 
WORLD_62 
WORLD_63 
WORLD_64 
WORLD_65 
WORLD_66 
WORLD_67 
WORLD_68 
WORLD_69 
WORLD_70 
WORLD_71 
WORLD_72 
WORLD_73 
WORLD_74 
WORLD_75 
WORLD_76 
WORLD_77 
WORLD_78 
WORLD_79 
WORLD_80 
WORLD_81 
WORLD_82 
WORLD_83 
WORLD_84 
WORLD_85 
WORLD_86 
WORLD_87 
WORLD_88 
WORLD_89 
WORLD_90 
WORLD_91 
WORLD_92 
WORLD_93 
WORLD_94 
WORLD_95 
KP0 
KP1 
KP2 
KP3 
KP4 
KP5 
KP6 
KP7 
KP8 
KP9 
KP_PERIOD 
KP_DIVIDE 
KP_MULTIPLY 
KP_MINUS 
KP_PLUS 
KP_ENTER 
KP_EQUALS 
UP 
DOWN 
RIGHT 
LEFT 
INSERT 
HOME 
END 
PAGEUP 
PAGEDOWN 
F1 
F2 
F3 
F4 
F5 
F6 
F7 
F8 
F9 
F10 
F11 
F12 
F13 
F14 
F15 
NUMLOCK 
CAPSLOCK 
SCROLLOCK 
RSHIFT 
LSHIFT 
RCTRL 
LCTRL 
RALT 
LALT 
RMETA 
LMETA 
LSUPER 
RSUPER 
MODE 
COMPOSE 
HELP 
PRINT 
SYSREQ 
BREAK 
MENU 
POWER 
EURO 
UNDO 
LEFT_MOUSE 
MIDDLE_MOUSE 
RIGHT_MOUSE 
MOUSE_WHEEL_UP 
MOUSE_WHEEL_DOWN 
CONTROLLER_A 

Xbox-style dual stick controller.

CONTROLLER_B 
CONTROLLER_X 
CONTROLLER_Y 
CONTROLLER_LEFT_BUMPER 

Also called the shoulder button or grip button in VR.

CONTROLLER_RIGHT_BUMPER 

Also called the shoulder button or grip button in VR.

CONTROLLER_BACK 

Also the traditional "select" button.

CONTROLLER_START 
CONTROLLER_LEFT_CLICK 

The left stick pressed down button.

CONTROLLER_RIGHT_CLICK 

The right stick pressed down button.

CONTROLLER_DPAD_UP 
CONTROLLER_DPAD_RIGHT 
CONTROLLER_DPAD_DOWN 
CONTROLLER_DPAD_LEFT 
CONTROLLER_GUIDE 

The logo/power/home button, e.g., the one with the Xbox Guide logo on an Xbox controller.

CONTROLLER_LEFT_TRIGGER 
CONTROLLER_RIGHT_TRIGGER 
CONTROLLER_RESERVED_1 
CONTROLLER_RESERVED_2 
CONTROLLER_RESERVED_3 
CONTROLLER_RESERVED_4 
CONTROLLER_LAST 
LAST 

Constructor & Destructor Documentation

◆ GKey() [1/4]

G3D::GKey::GKey ( const Any &  a)
inlineexplicit

◆ GKey() [2/4]

G3D::GKey::GKey ( )
inline

Referenced by operator+(), operator-(), and operator=().

◆ GKey() [3/4]

G3D::GKey::GKey ( const Value  v)
inline

◆ GKey() [4/4]

G3D::GKey::GKey ( int  v)
inlineexplicit

Allow construction, but not implicit casts.

Member Function Documentation

◆ deserialize()

void G3D::GKey::deserialize ( BinaryInput &  b)
inline

◆ fromString()

static GKey G3D::GKey::fromString ( const String &  _s)
static

Referenced by GKey().

◆ hashCode()

unsigned int G3D::GKey::hashCode ( ) const
inline

◆ operator int()

G3D::GKey::operator int ( ) const
inline

◆ operator!=() [1/2]

bool G3D::GKey::operator!= ( const GKey  other) const
inline

◆ operator!=() [2/2]

bool G3D::GKey::operator!= ( const GKey::Value  other) const
inline

◆ operator+()

GKey G3D::GKey::operator+ ( const int  x) const
inline

◆ operator++()

GKey& G3D::GKey::operator++ ( )
inline

◆ operator+=()

GKey& G3D::GKey::operator+= ( const int  x)
inline

◆ operator-()

GKey G3D::GKey::operator- ( const int  x) const
inline

◆ operator--()

GKey& G3D::GKey::operator-- ( )
inline

◆ operator-=()

GKey& G3D::GKey::operator-= ( const int  x)
inline

◆ operator<() [1/2]

bool G3D::GKey::operator< ( const GKey  other) const
inline

◆ operator<() [2/2]

bool G3D::GKey::operator< ( const Value  other) const
inline

◆ operator<=() [1/2]

bool G3D::GKey::operator<= ( const GKey  other) const
inline

◆ operator<=() [2/2]

bool G3D::GKey::operator<= ( const Value  other) const
inline

◆ operator=()

const GKey& G3D::GKey::operator= ( const Any &  a)
inline

◆ operator==() [1/2]

bool G3D::GKey::operator== ( const GKey  other) const
inline

◆ operator==() [2/2]

bool G3D::GKey::operator== ( const GKey::Value  other) const
inline

◆ operator>() [1/2]

bool G3D::GKey::operator> ( const GKey  other) const
inline

◆ operator>() [2/2]

bool G3D::GKey::operator> ( const Value  other) const
inline

◆ operator>=() [1/2]

bool G3D::GKey::operator>= ( const GKey  other) const
inline

◆ operator>=() [2/2]

bool G3D::GKey::operator>= ( const Value  other) const
inline

◆ serialize()

void G3D::GKey::serialize ( BinaryOutput &  b) const
inline

◆ toAny()

Any G3D::GKey::toAny ( ) const
inline

◆ toString()

String G3D::GKey::toString ( ) const

Referenced by toAny().

documentation generated on Wed Nov 24 2021 08:01:56 using doxygen 1.8.15