OIS::LinuxInputManager Class Reference

#include <LinuxInputManager.h>

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

List of all members.

Public Member Functions

 LinuxInputManager ()
virtual ~LinuxInputManager ()
virtual const std::string & inputSystemName ()
virtual int numJoysticks ()
virtual int numMice ()
virtual int numKeyBoards ()
ObjectcreateInputObject (Type iType, bool bufferMode)
void destroyInputObject (Object *obj)
Window _getWindow ()
 Method for retrieving the XWindow Handle.
void _setGrabState (bool grab)
 Internal method for checking if regrabbing is needed.
bool _getGrabState ()

Protected Member Functions

void _initialize (ParamList &paramList)
void _parseConfigSettings (ParamList &paramList)
 internal class method for dealing with param list
void _enumerateDevices ()
 internal class method for finding attached devices

Protected Attributes

JoyStickInfoList unusedJoyStickList
 List of unused joysticks ready to be used.
char joySticks
 Number of joysticks found.
Window window
 X11 Stuff.
bool grabMouse
 Keyboard, Mouse Settings.
bool grabKeyboard
bool mGrabs
bool hideMouse
bool useXRepeat
 By default, keyboard disables XRepeatRate.

Static Protected Attributes

static const std::string iName = "X11 Linux Input Manager"
 Input manager string name.


Detailed Description

Linux X11 InputManager specialization - Using lowlevel joys

Definition at line 35 of file LinuxInputManager.h.


Constructor & Destructor Documentation

LinuxInputManager::LinuxInputManager (  ) 

Definition at line 33 of file LinuxInputManager.cpp.

References grabKeyboard, grabMouse, hideMouse, mGrabs, useXRepeat, and window.

LinuxInputManager::~LinuxInputManager (  )  [virtual]

Definition at line 46 of file LinuxInputManager.cpp.

References OIS::LinuxJoyStick::_clearJoys(), and unusedJoyStickList.


Member Function Documentation

virtual const std::string& OIS::LinuxInputManager::inputSystemName (  )  [inline, virtual]

Remarks:
Gets the name of the current input system.. eg. "Win32", "Linux", "XBox", etc

Implements OIS::InputManager.

Definition at line 42 of file LinuxInputManager.h.

References iName.

int LinuxInputManager::numJoysticks (  )  [virtual]

Remarks:
Returns the number of joysticks found

Implements OIS::InputManager.

Definition at line 102 of file LinuxInputManager.cpp.

References joySticks.

int LinuxInputManager::numMice (  )  [virtual]

Remarks:
Returns the number of mice found

Implements OIS::InputManager.

Definition at line 108 of file LinuxInputManager.cpp.

int LinuxInputManager::numKeyBoards (  )  [virtual]

Remarks:
Returns the number of keyboards found

Implements OIS::InputManager.

Definition at line 114 of file LinuxInputManager.cpp.

Object * LinuxInputManager::createInputObject ( Type  iType,
bool  bufferMode 
) [virtual]

Remarks:
Returns the type of input requested or raises Exception

Implements OIS::InputManager.

Definition at line 120 of file LinuxInputManager.cpp.

References OIS::Object::_initialize(), E_InputDeviceNonExistant, E_InputDeviceNotSupported, grabKeyboard, grabMouse, hideMouse, OIS_EXCEPT, OISJoyStick, OISKeyboard, OISMouse, unusedJoyStickList, and useXRepeat.

void LinuxInputManager::destroyInputObject ( Object obj  )  [virtual]

Remarks:
Destroys Input Object

Implements OIS::InputManager.

Definition at line 164 of file LinuxInputManager.cpp.

References OISJoyStick, OIS::Object::type(), and unusedJoyStickList.

Window OIS::LinuxInputManager::_getWindow (  )  [inline]

Method for retrieving the XWindow Handle.

Definition at line 57 of file LinuxInputManager.h.

References window.

void OIS::LinuxInputManager::_setGrabState ( bool  grab  )  [inline]

Internal method for checking if regrabbing is needed.

Definition at line 60 of file LinuxInputManager.h.

References mGrabs.

Referenced by OIS::LinuxKeyboard::capture().

bool OIS::LinuxInputManager::_getGrabState (  )  [inline]

Definition at line 61 of file LinuxInputManager.h.

References mGrabs.

Referenced by OIS::LinuxKeyboard::capture().

void LinuxInputManager::_initialize ( ParamList paramList  )  [protected, virtual]

Internal... Called from createInputSystem.

Implements OIS::InputManager.

Definition at line 52 of file LinuxInputManager.cpp.

References _enumerateDevices(), and _parseConfigSettings().

void LinuxInputManager::_parseConfigSettings ( ParamList paramList  )  [protected]

internal class method for dealing with param list

Definition at line 61 of file LinuxInputManager.cpp.

References E_InvalidParam, grabKeyboard, grabMouse, hideMouse, OIS_EXCEPT, useXRepeat, and window.

Referenced by _initialize().

void LinuxInputManager::_enumerateDevices (  )  [protected]

internal class method for finding attached devices

Definition at line 94 of file LinuxInputManager.cpp.

References OIS::LinuxJoyStick::_scanJoys(), joySticks, and unusedJoyStickList.

Referenced by _initialize().


Member Data Documentation

JoyStickInfoList OIS::LinuxInputManager::unusedJoyStickList [protected]

List of unused joysticks ready to be used.

Definition at line 72 of file LinuxInputManager.h.

Referenced by _enumerateDevices(), createInputObject(), destroyInputObject(), and ~LinuxInputManager().

char OIS::LinuxInputManager::joySticks [protected]

Number of joysticks found.

Definition at line 74 of file LinuxInputManager.h.

Referenced by _enumerateDevices(), and numJoysticks().

const std::string LinuxInputManager::iName = "X11 Linux Input Manager" [static, protected]

Input manager string name.

Definition at line 77 of file LinuxInputManager.h.

Referenced by inputSystemName().

Window OIS::LinuxInputManager::window [protected]

X11 Stuff.

Definition at line 80 of file LinuxInputManager.h.

Referenced by _getWindow(), _parseConfigSettings(), and LinuxInputManager().

bool OIS::LinuxInputManager::grabMouse [protected]

Keyboard, Mouse Settings.

Definition at line 83 of file LinuxInputManager.h.

Referenced by _parseConfigSettings(), createInputObject(), and LinuxInputManager().

bool OIS::LinuxInputManager::grabKeyboard [protected]

Definition at line 83 of file LinuxInputManager.h.

Referenced by _parseConfigSettings(), createInputObject(), and LinuxInputManager().

bool OIS::LinuxInputManager::mGrabs [protected]

Definition at line 84 of file LinuxInputManager.h.

Referenced by _getGrabState(), _setGrabState(), and LinuxInputManager().

bool OIS::LinuxInputManager::hideMouse [protected]

Definition at line 85 of file LinuxInputManager.h.

Referenced by _parseConfigSettings(), createInputObject(), and LinuxInputManager().

bool OIS::LinuxInputManager::useXRepeat [protected]

By default, keyboard disables XRepeatRate.

Definition at line 88 of file LinuxInputManager.h.

Referenced by _parseConfigSettings(), createInputObject(), and LinuxInputManager().


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