Win32InputManager specialization - Using DirectInput8. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/external/ois/win32/Win32InputManager.h>

Inheritance diagram for OIS::Win32InputManager:

Public Member Functions
	Win32InputManager ()

virtual	~Win32InputManager ()

void	_initialize (ParamList &paramList)

void	_returnJoyStick (const JoyStickInfo &joystick)
	Internal method, return unused joystick to queue. 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...

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

void	destroyObject (Object *obj)

DeviceList	freeDeviceList ()

int	freeDevices (Type iType)

HWND	getWindowHandle ()
	Returns HWND needed by DirectInput Device Object. More...

int	totalDevices (Type iType)

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

Public Member Functions inherited from OIS::InputManager
void	addFactoryCreator (FactoryCreator *factory)

Object *	createInputObject (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 ()

Static Protected Member Functions
static BOOL CALLBACK	_DIEnumDevCallback (LPCDIDEVICEINSTANCE lpddi, LPVOID pvRef)
	Used during device enumeration. More...

Protected Attributes
HWND	hWnd
	The window handle we are using. More...

DWORD	joySettings
	Used for joystick device settings. More...

char	joySticks
	Number of total joysticks (inuse or not) More...

DWORD	kbSettings
	Used for keyboard device settings. More...

bool	keyboardUsed
	Used to know if we used up keyboard. More...

IDirectInput8 *	mDirectInput
	Direct Input Interface. More...

DWORD	mouseSettings
	Used for mouse device settings. More...

bool	mouseUsed
	Used to know if we used up mouse. More...

JoyStickInfoList	unusedJoyStickList
	Keep a list of all joysticks enumerated, but not in use. 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 InputManager *	createInputSystem (std::size_t winHandle)

static InputManager *	createInputSystem (ParamList &paramList)

static void	destroyInputSystem (InputManager *manager)

static unsigned int	getVersionNumber ()

Detailed Description

Win32InputManager specialization - Using DirectInput8.

Constructor & Destructor Documentation

Win32InputManager::Win32InputManager ( )

Win32InputManager::~Win32InputManager ( )

virtual

Member Function Documentation

BOOL CALLBACK Win32InputManager::_DIEnumDevCallback	(	LPCDIDEVICEINSTANCE	lpddi,
		LPVOID	pvRef
	)

staticprotected

Used during device enumeration.

void Win32InputManager::_enumerateDevices ( )

protected

internal class method for finding attached devices

void Win32InputManager::_initialize ( ParamList & paramList )

virtual

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

Implements OIS::InputManager.

void Win32InputManager::_parseConfigSettings ( ParamList & paramList )

protected

internal class method for dealing with param list

void Win32InputManager::_returnJoyStick ( const JoyStickInfo & joystick )

Internal method, return unused joystick to queue.

void OIS::Win32InputManager::_setKeyboardUsed ( bool used )

inline

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

void OIS::Win32InputManager::_setMouseUsed ( bool used )

inline

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

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

virtual

Remarks: Creates the object

Parameters

iType	Type to create
bufferMode	True to setup for buffered events
vendor	Create a device with the vendor name, "" means vendor name is unimportant

Implements OIS::FactoryCreator.

void Win32InputManager::destroyObject ( Object * obj )

virtual

Remarks: Destroys object

Parameters

obj	Object to destroy

Implements OIS::FactoryCreator.

DeviceList Win32InputManager::freeDeviceList ( )

virtual

Implements OIS::FactoryCreator.

int Win32InputManager::freeDevices ( Type iType )

virtual

Remarks: Number of free devices of requested type

Parameters

iType Type of devices to check

Implements OIS::FactoryCreator.

HWND OIS::Win32InputManager::getWindowHandle ( )

inline

Returns HWND needed by DirectInput Device Object.

int Win32InputManager::totalDevices ( Type iType )

virtual

Remarks: Number of total devices of requested type

Parameters

iType Type of devices to check

Implements OIS::FactoryCreator.

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

virtual

Remarks: Does a Type exist with the given vendor name

Parameters

iType	Type to check
vendor	Vendor name to test

Implements OIS::FactoryCreator.

Member Data Documentation

HWND OIS::Win32InputManager::hWnd

protected

The window handle we are using.

DWORD OIS::Win32InputManager::joySettings

protected

Used for joystick device settings.

char OIS::Win32InputManager::joySticks

protected

Number of total joysticks (inuse or not)

DWORD OIS::Win32InputManager::kbSettings

protected

Used for keyboard device settings.

bool OIS::Win32InputManager::keyboardUsed

protected

Used to know if we used up keyboard.

IDirectInput8* OIS::Win32InputManager::mDirectInput

protected

Direct Input Interface.

DWORD OIS::Win32InputManager::mouseSettings

protected

Used for mouse device settings.

bool OIS::Win32InputManager::mouseUsed

protected

Used to know if we used up mouse.

JoyStickInfoList OIS::Win32InputManager::unusedJoyStickList

protected

Keep a list of all joysticks enumerated, but not in use.

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

external/ois/win32/Win32InputManager.h
external/ois/win32/Win32InputManager.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation