OIS::Object Class Reference

#include <OISObject.h>

Inheritance diagram for OIS::Object:

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

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

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

Detailed Description

The base class of all input types.

Constructor & Destructor Documentation

~Object()

virtual OIS::Object::~Object ( )

inlinevirtual

Object()

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

inlineprotected

Member Function Documentation

_initialize()

virtual void OIS::Object::_initialize ( )

pure virtual

Remarks

Internal... Do not call this directly.

buffered()

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

inlinevirtual

Remarks

Get buffered mode - true is buffered, false otherwise

capture()

virtual void OIS::Object::capture ( )

pure virtual

Remarks

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

getCreator()

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

inline

Remarks

Returns this input object's creator

getID()

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)

queryInterface()

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

setBuffered()

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

pure virtual

Remarks

Sets buffered mode

type()

Type OIS::Object::type ( ) const

inline

Remarks

Get the type of device

vendor()

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

inline

Remarks

Get the vender string name

Member Data Documentation

mBuffered

bool OIS::Object::mBuffered

protected

Buffered flag.

mCreator

InputManager* OIS::Object::mCreator

protected

The creator who created this object.

mDevID

int OIS::Object::mDevID

protected

Not fully implemented yet.

mType

Type OIS::Object::mType

protected

Type of controller object.

mVendor

std::string OIS::Object::mVendor

protected

Vendor name if applicable/known.

---

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

• C:/Users/Ybalrid/git/OIS/includes/OISObject.h