Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OIS::LinuxInputManager Class Reference

Linux X11 InputManager specialization - Using lowlevel joys. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/external/ois/linux/LinuxInputManager.h>

Inheritance diagram for OIS::LinuxInputManager:
OIS::InputManager OIS::FactoryCreator

Public Member Functions

 LinuxInputManager ()
 
virtual ~LinuxInputManager ()
 
bool _getGrabState ()
 
Window _getWindow ()
 Method for retrieving the XWindow Handle. More...
 
void _initialize (ParamList &paramList)
 
void _setGrabState (bool grab)
 Internal method for checking if regrabbing is needed. More...
 
void _setKeyboardUsed (bool used)
 Internal method, used for flaggin keyboard as available/unavailable for creation. More...
 
void _setMouseUsed (bool used)
 Internal method, used for flaggin mouse as available/unavailable for creation. More...
 
ObjectcreateObject (InputManager *creator, Type iType, bool bufferMode, const std::string &vendor="")
 
void destroyObject (Object *obj)
 
DeviceList freeDeviceList ()
 
int freeDevices (Type iType)
 
int totalDevices (Type iType)
 
bool vendorExist (Type iType, const std::string &vendor)
 
- Public Member Functions inherited from OIS::InputManager
void addFactoryCreator (FactoryCreator *factory)
 
ObjectcreateInputObject (Type iType, bool bufferMode, const std::string &vendor="")
 
void destroyInputObject (Object *obj)
 
void enableAddOnFactory (AddOnFactories factory)
 
int getNumberOfDevices (Type iType)
 
const std::string & getVersionName ()
 
const std::string & inputSystemName ()
 
DeviceList listFreeDevices ()
 
void removeFactoryCreator (FactoryCreator *factory)
 
- Public Member Functions inherited from OIS::FactoryCreator
virtual ~FactoryCreator ()
 

Protected Member Functions

void _enumerateDevices ()
 internal class method for finding attached devices More...
 
void _parseConfigSettings (ParamList &paramList)
 internal class method for dealing with param list More...
 
- Protected Member Functions inherited from OIS::InputManager
 InputManager (const std::string &name)
 
virtual ~InputManager ()
 

Protected Attributes

bool grabKeyboard
 
bool grabMouse
 Keyboard, Mouse Settings. More...
 
bool hideMouse
 
char joySticks
 Number of joysticks found. More...
 
bool keyboardUsed
 Used to know if we used up keyboard. More...
 
bool mGrabs
 
bool mouseUsed
 Used to know if we used up mouse. More...
 
JoyStickInfoList unusedJoyStickList
 List of unused joysticks ready to be used. More...
 
Window window
 X11 Stuff. More...
 
- Protected Attributes inherited from OIS::InputManager
LIRCFactoryCreator * m_lircSupport
 Extra factory (not enabled by default) More...
 
const std::string m_VersionName
 OIS Version name. More...
 
WiiMoteFactoryCreator * m_wiiMoteSupport
 
FactoryList mFactories
 FactoryCreator list. More...
 
FactoryCreatedObject mFactoryObjects
 Factory created objects - useful so we can find creator to send destruction request to. More...
 
const std::string mInputSystemName
 Name of the input system. More...
 

Additional Inherited Members

- Public Types inherited from OIS::InputManager
enum  AddOnFactories { AddOn_All = 0, AddOn_LIRC = 1, AddOn_WiiMote = 2 }
 All generic devices OIS supports internally (if they are compiled in) More...
 
- Static Public Member Functions inherited from OIS::InputManager
static InputManagercreateInputSystem (std::size_t winHandle)
 
static InputManagercreateInputSystem (ParamList &paramList)
 
static void destroyInputSystem (InputManager *manager)
 
static unsigned int getVersionNumber ()
 

Detailed Description

Linux X11 InputManager specialization - Using lowlevel joys.

Constructor & Destructor Documentation

LinuxInputManager::LinuxInputManager ( )
LinuxInputManager::~LinuxInputManager ( )
virtual

Member Function Documentation

void LinuxInputManager::_enumerateDevices ( )
protected

internal class method for finding attached devices

bool OIS::LinuxInputManager::_getGrabState ( )
inline
Window OIS::LinuxInputManager::_getWindow ( )
inline

Method for retrieving the XWindow Handle.

void LinuxInputManager::_initialize ( ParamList paramList)
virtual

Remarks
Called from createInputSystem, gives derived input class a chance to setup after it is created

Implements OIS::InputManager.

void LinuxInputManager::_parseConfigSettings ( ParamList paramList)
protected

internal class method for dealing with param list

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

Internal method for checking if regrabbing is needed.

void OIS::LinuxInputManager::_setKeyboardUsed ( bool  used)
inline

Internal method, used for flaggin keyboard as available/unavailable for creation.

void OIS::LinuxInputManager::_setMouseUsed ( bool  used)
inline

Internal method, used for flaggin mouse as available/unavailable for creation.

Object * LinuxInputManager::createObject ( InputManager creator,
Type  iType,
bool  bufferMode,
const std::string &  vendor = "" 
)
virtual

Remarks
Creates the object
Parameters
iTypeType to create
bufferModeTrue to setup for buffered events
vendorCreate a device with the vendor name, "" means vendor name is unimportant

Implements OIS::FactoryCreator.

void LinuxInputManager::destroyObject ( Object obj)
virtual

Remarks
Destroys object
Parameters
objObject to destroy

Implements OIS::FactoryCreator.

DeviceList LinuxInputManager::freeDeviceList ( )
virtual

Implements OIS::FactoryCreator.

int LinuxInputManager::freeDevices ( Type  iType)
virtual

Remarks
Number of free devices of requested type
Parameters
iTypeType of devices to check

Implements OIS::FactoryCreator.

int LinuxInputManager::totalDevices ( Type  iType)
virtual

Remarks
Number of total devices of requested type
Parameters
iTypeType of devices to check

Implements OIS::FactoryCreator.

bool LinuxInputManager::vendorExist ( Type  iType,
const std::string &  vendor 
)
virtual

Remarks
Does a Type exist with the given vendor name
Parameters
iTypeType to check
vendorVendor name to test

Implements OIS::FactoryCreator.

Member Data Documentation

bool OIS::LinuxInputManager::grabKeyboard
protected
bool OIS::LinuxInputManager::grabMouse
protected

Keyboard, Mouse Settings.

bool OIS::LinuxInputManager::hideMouse
protected
char OIS::LinuxInputManager::joySticks
protected

Number of joysticks found.

bool OIS::LinuxInputManager::keyboardUsed
protected

Used to know if we used up keyboard.

bool OIS::LinuxInputManager::mGrabs
protected
bool OIS::LinuxInputManager::mouseUsed
protected

Used to know if we used up mouse.

JoyStickInfoList OIS::LinuxInputManager::unusedJoyStickList
protected

List of unused joysticks ready to be used.

Window OIS::LinuxInputManager::window
protected

X11 Stuff.


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