syBR::InputOIS::KeyboardHandler Class Reference

Keyboard handler class. More...

#include <KeyboardHandler.hpp>

Inheritance diagram for syBR::InputOIS::KeyboardHandler:

syBR::InputCore::KeyboardHandler

List of all members.

Public Member Functions

 KeyboardHandler (OIS::Keyboard *pKeyboard)
 Constructor.
 ~KeyboardHandler ()
 Destructor.
bool isKeyDown (InputCore::KeyCode key)
 Check if a key is down.

Private Attributes

OIS::Keyboard * m_pKeyboard
 OIS keyboard.

Static Private Attributes

static const OIS::KeyCode sm_keyCodes []
 Relationship between the InputCore keycodes and OIS keycodes.

Friends

class InputSystem


Detailed Description

Keyboard handler class.

This is the main object which gives access to input devices such as the keyboard and the mouse. This is an implementation of the InputCore::KeyboardHandler class using the OIS input library.


Constructor & Destructor Documentation

syBR::InputOIS::KeyboardHandler::KeyboardHandler ( OIS::Keyboard *  pKeyboard  ) 

Constructor.

syBR::InputOIS::KeyboardHandler::~KeyboardHandler (  )  [virtual]

Destructor.

Reimplemented from syBR::InputCore::KeyboardHandler.


Member Function Documentation

bool syBR::InputOIS::KeyboardHandler::isKeyDown ( InputCore::KeyCode  key  )  [virtual]

Check if a key is down.

Parameters:
key Key to be checked
Returns:
One of these:
  • true if the key is currently down
  • false otherwise

Implements syBR::InputCore::KeyboardHandler.


Friends And Related Function Documentation

friend class InputSystem [friend]


Member Data Documentation

const OIS::KeyCode syBR::InputOIS::KeyboardHandler::sm_keyCodes [static, private]

Relationship between the InputCore keycodes and OIS keycodes.

OIS::Keyboard* syBR::InputOIS::KeyboardHandler::m_pKeyboard [private]

OIS keyboard.


The documentation for this class was generated from the following files:

Copyright © 2008 by Sebastien Frippiat
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 License.
Last modified Tue Dec 30 17:57:34 2008