OIS::InputManager Class Reference

#include <OISInputManager.h>

Inheritance diagram for OIS::InputManager:

[legend]

List of all members.

Public Member Functions
virtual const std::string &	inputSystemName ()=0
virtual int	numJoysticks ()=0
virtual int	numMice ()=0
virtual int	numKeyBoards ()=0
virtual Object *	createInputObject (Type iType, bool bufferMode)=0
virtual void	destroyInputObject (Object *obj)=0
Static Public Member Functions
static unsigned int	getVersionNumber ()
static const char *	getVersionName ()
static InputManager *	createInputSystem (std::size_t winHandle)
static InputManager *	createInputSystem (ParamList &paramList)
static void	destroyInputSystem (InputManager *manager)
Protected Member Functions
virtual void	_initialize (ParamList &paramList)=0
	Internal... Called from createInputSystem.
	InputManager ()
virtual	~InputManager ()

---

Detailed Description

Base Manager class. No longer a Singleton; so feel free to create as many InputManager's as you have windows.

Definition at line 34 of file OISInputManager.h.

---

Constructor & Destructor Documentation

OIS::InputManager::InputManager

(

)

[inline, protected]

Definition at line 123 of file OISInputManager.h.

virtual OIS::InputManager::~InputManager

(

)

[inline, protected, virtual]

Definition at line 124 of file OISInputManager.h.

---

Member Function Documentation

unsigned int InputManager::getVersionNumber

(

)

[static]

Remarks:

Returns version number (useful in DLL/SO libs)

Returns:

Bits: 1-8 Patch number, 9-16 Minor version, 17-32 Major version

Definition at line 45 of file OISInputManager.cpp.

References OIS_VERSION.

Referenced by initOIS().

const char * InputManager::getVersionName

(

)

[static]

Remarks:

Returns version string (useful in DLL/SO libs)

Returns:

Version name

Definition at line 51 of file OISInputManager.cpp.

References gVersionName.

Referenced by initOIS().

InputManager * InputManager::createInputSystem

(

std::size_t

winHandle

)

[static]

Remarks:

Creates appropriate input system dependent on platform.

Parameters:

winHandle

Contains OS specific window handle (such as HWND or X11 Window)

Returns:

A pointer to the created manager, or raises Exception

Definition at line 57 of file OISInputManager.cpp.

InputManager * InputManager::createInputSystem

(

ParamList &

paramList

)

[static]

Remarks:

Creates appropriate input system dependent on platform.

Parameters:

paramList

ParamList contains OS specific info (such as HWND and HINSTANCE for window apps), and access mode.

Returns:

A pointer to the created manager, or raises Exception

Definition at line 68 of file OISInputManager.cpp.

References _initialize(), and OIS_EXCEPT.

virtual const std::string& OIS::InputManager::inputSystemName

(

)

[pure virtual]

Remarks:

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

Implemented in OIS::LinuxInputManager, OIS::MacInputManager, OIS::SDLInputManager, and OIS::Win32InputManager.

Referenced by doStartup(), and initOIS().

void InputManager::destroyInputSystem

(

InputManager *

manager

)

[static]

Remarks:

Destroys the InputManager

Parameters:

manager

Manager to destroy

Definition at line 100 of file OISInputManager.cpp.

virtual int OIS::InputManager::numJoysticks

(

)

[pure virtual]

Remarks:

Returns the number of joysticks found

Implemented in OIS::LinuxInputManager, OIS::MacInputManager, OIS::SDLInputManager, and OIS::Win32InputManager.

Referenced by doStartup().

virtual int OIS::InputManager::numMice

(

)

[pure virtual]

Remarks:

Returns the number of mice found

Implemented in OIS::LinuxInputManager, OIS::MacInputManager, OIS::SDLInputManager, and OIS::Win32InputManager.

virtual int OIS::InputManager::numKeyBoards

(

)

[pure virtual]

Remarks:

Returns the number of keyboards found

Implemented in OIS::LinuxInputManager, OIS::MacInputManager, OIS::SDLInputManager, and OIS::Win32InputManager.

virtual Object* OIS::InputManager::createInputObject	(	Type	iType,
		bool	bufferMode
	)			[pure virtual]

Remarks:

Returns the type of input requested or raises Exception

Implemented in OIS::LinuxInputManager, OIS::MacInputManager, OIS::SDLInputManager, and OIS::Win32InputManager.

Referenced by doStartup(), and initOIS().

virtual void OIS::InputManager::destroyInputObject

(

Object *

obj

)

[pure virtual]

Remarks:

Destroys Input Object

Implemented in OIS::LinuxInputManager, OIS::MacInputManager, OIS::SDLInputManager, and OIS::Win32InputManager.

Referenced by main().

virtual void OIS::InputManager::_initialize

(

ParamList &

paramList

)

[protected, pure virtual]

Internal... Called from createInputSystem.

Implemented in OIS::LinuxInputManager, OIS::MacInputManager, OIS::SDLInputManager, and OIS::Win32InputManager.

Referenced by createInputSystem().

---

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

• E:/Download/ois-1.0RC1/includes/OISInputManager.h
• E:/Download/ois-1.0RC1/src/OISInputManager.cpp

---