OIS::Object Class Reference

The base class of all input types. More...

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

Inheritance diagram for OIS::Object:

Public Member Functions
virtual	~Object ()
virtual void	_initialize ()=0
virtual bool	buffered () const
virtual void	capture ()=0
InputManager *	getCreator () const
virtual int	getID () const
virtual Interface *	queryInterface (Interface::IType type)=0
virtual void	setBuffered (bool buffered)=0
Type	type () const
const std::string &	vendor () const

Protected Member Functions
	Object (const std::string &vendor, Type iType, bool buffered, int devID, InputManager *creator)

Protected Attributes
bool	mBuffered
	Buffered flag. More...
InputManager *	mCreator
	The creator who created this object. More...
int	mDevID
	Not fully implemented yet. More...
Type	mType
	Type of controller object. More...
std::string	mVendor
	Vendor name if applicable/known. More...

Detailed Description

The base class of all input types.

Constructor & Destructor Documentation

virtual OIS::Object::~Object ( )

inlinevirtual

OIS::Object::Object ( const std::string &  vendor, Type  iType, bool  buffered, int  devID, InputManager *  creator  )

inlineprotected

Member Function Documentation

virtual void OIS::Object::_initialize ( )

pure virtual

Remarks

Internal... Do not call this directly.

Implemented in OIS::Win32Keyboard, OIS::MacJoyStick, OIS::MacKeyboard, OIS::LinuxKeyboard, OIS::LinuxJoyStick, OIS::LinuxMouse, OIS::Win32JoyStick, OIS::Win32Mouse, and OIS::MacMouse.

virtual bool OIS::Object::buffered ( ) const

inlinevirtual

Remarks

Get buffered mode - true is buffered, false otherwise

virtual void OIS::Object::capture ( )

pure virtual

Remarks

Used for updating call once per frame before checking state or to update events

Implemented in OIS::Win32Keyboard, OIS::MacJoyStick, OIS::LinuxKeyboard, OIS::MacKeyboard, OIS::LinuxJoyStick, OIS::LinuxMouse, OIS::Win32JoyStick, OIS::Win32Mouse, and OIS::MacMouse.

InputManager* OIS::Object::getCreator ( ) const

inline

Remarks

Returns this input object's creator

virtual int OIS::Object::getID ( ) const

inlinevirtual

Remarks

This may/may not) differentiate the different controllers based on (for instance) a port number (useful for console InputManagers)

virtual Interface* OIS::Object::queryInterface ( Interface::IType  type )

pure virtual

Remarks

If available, get an interface to write to some devices. Examples include, turning on and off LEDs, ForceFeedback, etc

Parameters

type	The type of interface you are looking for

Implemented in OIS::Win32Keyboard, OIS::MacJoyStick, OIS::MacKeyboard, OIS::LinuxKeyboard, OIS::LinuxJoyStick, OIS::LinuxMouse, OIS::Win32JoyStick, OIS::Win32Mouse, and OIS::MacMouse.

virtual void OIS::Object::setBuffered ( bool  buffered )

pure virtual

Remarks

Sets buffered mode

Implemented in OIS::Win32Keyboard, OIS::MacJoyStick, OIS::LinuxKeyboard, OIS::LinuxJoyStick, OIS::MacKeyboard, OIS::LinuxMouse, OIS::Win32JoyStick, OIS::Win32Mouse, and OIS::MacMouse.

Type OIS::Object::type ( ) const

inline

Remarks

Get the type of device

const std::string& OIS::Object::vendor ( ) const

inline

Remarks

Get the vender string name

Member Data Documentation

bool OIS::Object::mBuffered

protected

Buffered flag.

InputManager* OIS::Object::mCreator

protected

The creator who created this object.

int OIS::Object::mDevID

protected

Not fully implemented yet.

Type OIS::Object::mType

protected

Type of controller object.

std::string OIS::Object::mVendor

protected

Vendor name if applicable/known.

---

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

• external/ois/OISObject.h