OIS::SDLKeyboard

OIS::SDLKeyboard Class Reference

#include <SDLKeyboard.h>

Inheritance diagram for OIS::SDLKeyboard:
[legend]
Collaboration diagram for OIS::SDLKeyboard:
[legend]

List of all members.

Public Member Functions

 SDLKeyboard (bool buffered)
virtual ~SDLKeyboard ()
virtual bool isKeyDown (KeyCode key)
virtual const std::string & getAsString (KeyCode kc)
virtual void copyKeyStates (char keys[256])
virtual void setBuffered (bool buffered)
virtual void capture ()
virtual Interface * queryInterface (Interface::IType type)
virtual void _initialize ()
virtual void setTextTranslation (TextTranslationMode mode)

Protected Types

typedef std::map< SDLKey, KeyCode > KeyMap

Protected Member Functions

 SDLKeyboard ()

Protected Attributes

KeyMap mKeyMap
unsigned char KeyBuffer [256]
Uint8 * mSDLBuff
std::string mGetString

Detailed Description

Definition at line 31 of file SDLKeyboard.h.

Member Typedef Documentation

typedef std::map<SDLKey, KeyCode> OIS::SDLKeyboard::KeyMap [protected]

Definition at line 70 of file SDLKeyboard.h.

Constructor & Destructor Documentation

SDLKeyboard::SDLKeyboard ( bool  buffered  ) 

Remarks:
Constructor
Parameters:
buffered True for buffered input mode

Definition at line 32 of file SDLKeyboard.cpp.

References KeyBuffer, OIS::Keyboard::listener, OIS::Object::mBuffered, OIS::Object::mType, and OISKeyboard.

SDLKeyboard::~SDLKeyboard (  )  [virtual]

Definition at line 156 of file SDLKeyboard.cpp.

OIS::SDLKeyboard::SDLKeyboard (  )  [inline, protected]

Definition at line 68 of file SDLKeyboard.h.

Member Function Documentation

bool SDLKeyboard::isKeyDown ( KeyCode  key  )  [virtual]

Remarks:
Returns true if key is donwn
Parameters:
key A KeyCode to check

Implements OIS::Keyboard.

Definition at line 196 of file SDLKeyboard.cpp.

References KeyBuffer.

const std::string & SDLKeyboard::getAsString ( KeyCode  kc  )  [virtual]

Remarks:
Translates KeyCode to string representation. For example, KC_ENTER will be "Enter" - Locale specific of course.
Parameters:
kc KeyCode to convert
Returns:
The string as determined from the current locale

Implements OIS::Keyboard.

Definition at line 202 of file SDLKeyboard.cpp.

References OIS::KC_0, OIS::KC_1, OIS::KC_2, OIS::KC_3, OIS::KC_4, OIS::KC_5, OIS::KC_6, OIS::KC_7, OIS::KC_8, OIS::KC_9, OIS::KC_A, OIS::KC_ABNT_C1, OIS::KC_ABNT_C2, OIS::KC_ADD, OIS::KC_APOSTROPHE, OIS::KC_APPS, OIS::KC_AT, OIS::KC_AX, OIS::KC_B, OIS::KC_BACK, OIS::KC_BACKSLASH, OIS::KC_C, OIS::KC_CALCULATOR, OIS::KC_CAPITAL, OIS::KC_COLON, OIS::KC_COMMA, OIS::KC_CONVERT, OIS::KC_D, OIS::KC_DECIMAL, OIS::KC_DELETE, OIS::KC_DIVIDE, OIS::KC_DOWN, OIS::KC_E, OIS::KC_END, OIS::KC_EQUALS, OIS::KC_ESCAPE, OIS::KC_F, OIS::KC_F1, OIS::KC_F10, OIS::KC_F11, OIS::KC_F12, OIS::KC_F13, OIS::KC_F14, OIS::KC_F15, OIS::KC_F2, OIS::KC_F3, OIS::KC_F4, OIS::KC_F5, OIS::KC_F6, OIS::KC_F7, OIS::KC_F8, OIS::KC_F9, OIS::KC_G, OIS::KC_GRAVE, OIS::KC_H, OIS::KC_HOME, OIS::KC_I, OIS::KC_INSERT, OIS::KC_J, OIS::KC_K, OIS::KC_KANA, OIS::KC_KANJI, OIS::KC_L, OIS::KC_LBRACKET, OIS::KC_LCONTROL, OIS::KC_LEFT, OIS::KC_LMENU, OIS::KC_LSHIFT, OIS::KC_LWIN, OIS::KC_M, OIS::KC_MAIL, OIS::KC_MEDIASELECT, OIS::KC_MEDIASTOP, OIS::KC_MINUS, OIS::KC_MULTIPLY, OIS::KC_MUTE, OIS::KC_MYCOMPUTER, OIS::KC_N, OIS::KC_NEXTTRACK, OIS::KC_NOCONVERT, OIS::KC_NUMLOCK, OIS::KC_NUMPAD0, OIS::KC_NUMPAD1, OIS::KC_NUMPAD2, OIS::KC_NUMPAD3, OIS::KC_NUMPAD4, OIS::KC_NUMPAD5, OIS::KC_NUMPAD6, OIS::KC_NUMPAD7, OIS::KC_NUMPAD8, OIS::KC_NUMPAD9, OIS::KC_NUMPADCOMMA, OIS::KC_NUMPADENTER, OIS::KC_NUMPADEQUALS, OIS::KC_O, OIS::KC_OEM_102, OIS::KC_P, OIS::KC_PAUSE, OIS::KC_PERIOD, OIS::KC_PGDOWN, OIS::KC_PGUP, OIS::KC_PLAYPAUSE, OIS::KC_POWER, OIS::KC_PREVTRACK, OIS::KC_Q, OIS::KC_R, OIS::KC_RBRACKET, OIS::KC_RCONTROL, OIS::KC_RETURN, OIS::KC_RIGHT, OIS::KC_RMENU, OIS::KC_RSHIFT, OIS::KC_RWIN, OIS::KC_S, OIS::KC_SCROLL, OIS::KC_SEMICOLON, OIS::KC_SLASH, OIS::KC_SLEEP, OIS::KC_SPACE, OIS::KC_STOP, OIS::KC_SUBTRACT, OIS::KC_SYSRQ, OIS::KC_T, OIS::KC_TAB, OIS::KC_U, OIS::KC_UNDERLINE, OIS::KC_UNLABELED, OIS::KC_UP, OIS::KC_V, OIS::KC_VOLUMEDOWN, OIS::KC_VOLUMEUP, OIS::KC_W, OIS::KC_WAKE, OIS::KC_WEBBACK, OIS::KC_WEBFAVORITES, OIS::KC_WEBFORWARD, OIS::KC_WEBHOME, OIS::KC_WEBREFRESH, OIS::KC_WEBSEARCH, OIS::KC_WEBSTOP, OIS::KC_X, OIS::KC_Y, OIS::KC_YEN, OIS::KC_Z, and mGetString.

void SDLKeyboard::copyKeyStates ( char  keys[256]  )  [virtual]

Remarks:
Copies the state of the keys into the sent buffer (in the form of 1 is down and 0 is up)

Implements OIS::Keyboard.

Definition at line 357 of file SDLKeyboard.cpp.

References KeyBuffer.

void SDLKeyboard::setBuffered ( bool  buffered  )  [virtual]

Remarks:
Sets buffered mode

Implements OIS::Object.

Definition at line 364 of file SDLKeyboard.cpp.

References OIS::Object::mBuffered.

void SDLKeyboard::capture (  )  [virtual]

Remarks:
Used for updating call once per frame before checking state or to update events

Implements OIS::Object.

Definition at line 161 of file SDLKeyboard.cpp.

References OIS::KC_LMENU, OIS::KC_RMENU, OIS::KC_TAB, KeyBuffer, OIS::KeyListener::keyPressed(), OIS::KeyListener::keyReleased(), OIS::Keyboard::listener, OIS::Object::mBuffered, mKeyMap, and OIS_SDL_KEY_BUFF.

virtual Interface* OIS::SDLKeyboard::queryInterface ( Interface::IType  type  )  [inline, virtual]

Remarks:
If available, get an interface to write to some devices. Examples include, turning on and off LEDs, ForceFeedback, etc
Parameters:
type The type of interface you are looking for

Implements OIS::Object.

Definition at line 59 of file SDLKeyboard.h.

void SDLKeyboard::_initialize (  )  [virtual]

Remarks:
Internal... Do not call this directly.

Implements OIS::Object.

Definition at line 43 of file SDLKeyboard.cpp.

References OIS::KC_0, OIS::KC_1, OIS::KC_2, OIS::KC_3, OIS::KC_4, OIS::KC_5, OIS::KC_6, OIS::KC_7, OIS::KC_8, OIS::KC_9, OIS::KC_A, OIS::KC_ADD, OIS::KC_APOSTROPHE, OIS::KC_B, OIS::KC_BACK, OIS::KC_BACKSLASH, OIS::KC_C, OIS::KC_CAPITAL, OIS::KC_COLON, OIS::KC_COMMA, OIS::KC_D, OIS::KC_DECIMAL, OIS::KC_DELETE, OIS::KC_DIVIDE, OIS::KC_DOWN, OIS::KC_E, OIS::KC_END, OIS::KC_EQUALS, OIS::KC_ESCAPE, OIS::KC_F, OIS::KC_F1, OIS::KC_F10, OIS::KC_F11, OIS::KC_F12, OIS::KC_F13, OIS::KC_F14, OIS::KC_F15, OIS::KC_F2, OIS::KC_F3, OIS::KC_F4, OIS::KC_F5, OIS::KC_F6, OIS::KC_F7, OIS::KC_F8, OIS::KC_F9, OIS::KC_G, OIS::KC_GRAVE, OIS::KC_H, OIS::KC_HOME, OIS::KC_I, OIS::KC_INSERT, OIS::KC_J, OIS::KC_K, OIS::KC_L, OIS::KC_LCONTROL, OIS::KC_LEFT, OIS::KC_LMENU, OIS::KC_LSHIFT, OIS::KC_LWIN, OIS::KC_M, OIS::KC_MINUS, OIS::KC_MULTIPLY, OIS::KC_N, OIS::KC_NUMLOCK, OIS::KC_NUMPAD0, OIS::KC_NUMPAD1, OIS::KC_NUMPAD2, OIS::KC_NUMPAD3, OIS::KC_NUMPAD4, OIS::KC_NUMPAD5, OIS::KC_NUMPAD6, OIS::KC_NUMPAD7, OIS::KC_NUMPAD8, OIS::KC_NUMPAD9, OIS::KC_NUMPADEQUALS, OIS::KC_O, OIS::KC_P, OIS::KC_PERIOD, OIS::KC_PGDOWN, OIS::KC_PGUP, OIS::KC_Q, OIS::KC_R, OIS::KC_RETURN, OIS::KC_RIGHT, OIS::KC_RMENU, OIS::KC_RSHIFT, OIS::KC_RWIN, OIS::KC_S, OIS::KC_SCROLL, OIS::KC_SEMICOLON, OIS::KC_SLASH, OIS::KC_SPACE, OIS::KC_SUBTRACT, OIS::KC_SYSRQ, OIS::KC_T, OIS::KC_TAB, OIS::KC_U, OIS::KC_UP, OIS::KC_V, OIS::KC_W, OIS::KC_X, OIS::KC_Y, OIS::KC_Z, mKeyMap, OIS::Keyboard::mModifiers, and mSDLBuff.

void SDLKeyboard::setTextTranslation ( TextTranslationMode  mode  )  [virtual]

Reimplemented from OIS::Keyboard.

Definition at line 370 of file SDLKeyboard.cpp.

References OIS::Keyboard::Ascii, OIS::Keyboard::mTextMode, OIS::Keyboard::Off, and OIS::Keyboard::Unicode.

Member Data Documentation

KeyMap OIS::SDLKeyboard::mKeyMap [protected]

Definition at line 71 of file SDLKeyboard.h.

Referenced by _initialize(), and capture().

unsigned char OIS::SDLKeyboard::KeyBuffer[256] [protected]

Definition at line 73 of file SDLKeyboard.h.

Referenced by capture(), copyKeyStates(), isKeyDown(), and SDLKeyboard().

Uint8* OIS::SDLKeyboard::mSDLBuff [protected]

Definition at line 74 of file SDLKeyboard.h.

Referenced by _initialize().

std::string OIS::SDLKeyboard::mGetString [protected]

Definition at line 76 of file SDLKeyboard.h.

Referenced by getAsString().

The documentation for this class was generated from the following files:
Generated on Sat Dec 1 20:13:55 2007 for OIS by  doxygen 1.5.4