syBR::InputOIS::InputSystem Class Reference

Base input system class. More...

#include <InputSystem.hpp>

Inheritance diagram for syBR::InputOIS::InputSystem:

List of all members.

Public Member Functions

InputSystem (Core::Logger *pLogger)

Constructor.

~InputSystem ()

Destructor.

bool initialize (void *windowHandle)

Initialize input system.

void terminate ()

Terminate input system.

void update ()

Update input system.

bool createKeyboardHandler ()

Create the keyboard handler, if not yet created.

void releaseKeyboardHandler ()

Release the keyboard handler.

bool createMouseHandler ()

Create the mouse handler, if not yet created.

void releaseMouseHandler ()

Release the mouse handler.

Private Attributes

OIS::InputManager * m_pInputManager

OIS input manager.

Detailed Description

Base input system 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::InputSystem class using the OIS input library.

Constructor & Destructor Documentation

syBR::InputOIS::InputSystem::InputSystem ( Core::Logger * pLogger )

Constructor.

Parameters:

pLogger

Pointer to the instance of the logger to use

Reimplemented from syBR::InputCore::InputSystem.

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

Destructor.

Reimplemented from syBR::InputCore::InputSystem.

Member Function Documentation

bool syBR::InputOIS::InputSystem::initialize ( void * windowHandle ) [virtual]

Initialize input system.

Parameters:

windowHandle

Handle of the window whose inputs are to be managed

Returns:

One of these:

true if system was successfully initialized
false otherwise

Implements syBR::InputCore::InputSystem.

void syBR::InputOIS::InputSystem::terminate ( ) [virtual]

Terminate input system.

Implements syBR::InputCore::InputSystem.

void syBR::InputOIS::InputSystem::update ( ) [virtual]

Update input system.

Reimplemented from syBR::InputCore::InputSystem.

bool syBR::InputOIS::InputSystem::createKeyboardHandler ( ) [virtual]

Create the keyboard handler, if not yet created.

Only one keyboard handler can ever be created, call it once when you need to retrieve keyboard input.

Returns:

One of these:

true in case of success
false otherwise

Implements syBR::InputCore::InputSystem.

void syBR::InputOIS::InputSystem::releaseKeyboardHandler ( ) [virtual]

Release the keyboard handler.

This obviously won't do anything unless createKeyboardHandler() has been previously created

Implements syBR::InputCore::InputSystem.

bool syBR::InputOIS::InputSystem::createMouseHandler ( ) [virtual]

Create the mouse handler, if not yet created.

Only one keyboard mouse can ever be created, call it once when you need to retrieve mouse input.

Returns:

One of these:

true in case of success
false otherwise

Implements syBR::InputCore::InputSystem.

void syBR::InputOIS::InputSystem::releaseMouseHandler ( ) [virtual]

Release the mouse handler.

This obviously won't do anything unless createMouseHandler() has been previously created

Implements syBR::InputCore::InputSystem.

Member Data Documentation

OIS::InputManager* syBR::InputOIS::InputSystem::m_pInputManager [private]

OIS input manager.

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

/home/seb/syBR/inputOIS/src/InputSystem.hpp
/home/seb/syBR/inputOIS/src/InputSystem.cpp


Public Member Functions
	InputSystem (Core::Logger *pLogger)
	Constructor.
	~InputSystem ()
	Destructor.
bool	initialize (void *windowHandle)
	Initialize input system.
void	terminate ()
	Terminate input system.
void	update ()
	Update input system.
bool	createKeyboardHandler ()
	Create the keyboard handler, if not yet created.
void	releaseKeyboardHandler ()
	Release the keyboard handler.
bool	createMouseHandler ()
	Create the mouse handler, if not yet created.
void	releaseMouseHandler ()
	Release the mouse handler.
Private Attributes
OIS::InputManager *	m_pInputManager
	OIS input manager.