input::handler_impl Class Reference

The base class for input implementation. More...

#include <input.hpp>

Inheritance diagram for input::handler_impl:
input::glfw_handler input::ois_handler input::sfml_handler

List of all members.

Classes

struct  key_state
struct  mouse_state

Public Member Functions

 handler_impl ()
 Constructor.
virtual ~handler_impl ()
 Destructor.
virtual void update ()=0
 Updates this implementation handler.
virtual void toggle_mouse_grab ()=0
 Toggles mouse grab.
virtual std::string get_key_name (key::code mKey) const =0
 Returns the name of the key as it appears on the keyboard.

Public Attributes

struct
input::handler_impl::key_state 
mKeyboard
struct
input::handler_impl::mouse_state 
mMouse
std::vector< char32_t > lChars
std::vector< char32_t > lCharsCache_

Detailed Description

The base class for input implementation.

Definition at line 26 of file input.hpp.


Constructor & Destructor Documentation

input::handler_impl::handler_impl (  ) 

Constructor.

Definition at line 61 of file input.cpp.

virtual input::handler_impl::~handler_impl (  )  [inline, virtual]

Destructor.

Definition at line 34 of file input.hpp.


Member Function Documentation

virtual std::string input::handler_impl::get_key_name ( key::code  mKey  )  const [pure virtual]

Returns the name of the key as it appears on the keyboard.

Returns:
The name of the key as it appears on the keyboard

Implemented in input::glfw_handler, and input::sfml_handler.

virtual void input::handler_impl::toggle_mouse_grab (  )  [pure virtual]

Toggles mouse grab.

When the mouse is grabbed, it is confined to the borders of the main window. The actual cursor behavior when reaching those borders is of no importance : what matters is that relative mouse movement is always aquired, i.e. the mouse is never blocked. The mouse is not grabbed by default.

Implemented in input::glfw_handler, input::ois_handler, and input::sfml_handler.

virtual void input::handler_impl::update (  )  [pure virtual]

Updates this implementation handler.

Implemented in input::glfw_handler, input::ois_handler, and input::sfml_handler.


Member Data Documentation

std::vector<char32_t> input::handler_impl::lChars

Definition at line 68 of file input.hpp.

std::vector<char32_t> input::handler_impl::lCharsCache_

Definition at line 69 of file input.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on Tue Jan 1 21:58:13 2013 for gui by  doxygen 1.6.1