Inheritance diagram for OIS::Mouse:

Public Member Functions
virtual	~Mouse ()

MouseListener *	getEventCallback () const

const MouseState &	getMouseState () const

virtual void	setEventCallback (MouseListener *mouseListener)

Public Member Functions inherited from OIS::Object
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
	Mouse (const std::string &vendor, bool buffered, int devID, InputManager *creator)

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

Protected Attributes
MouseListener *	mListener
	Used for buffered/actionmapping callback. More...

MouseState	mState
	The state of the mouse. More...

Protected Attributes inherited from OIS::Object
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

Mouse base class.

To be implemented by specific system (ie. DirectX Mouse) This class is useful as you remain OS independent using this common interface.

Constructor & Destructor Documentation

virtual OIS::Mouse::~Mouse ( )

inlinevirtual

inlineprotected

MouseListener* OIS::Mouse::getEventCallback ( ) const

inline

const MouseState& OIS::Mouse::getMouseState ( ) const

inline

Remarks: Returns the state of the mouse - is valid for both buffered and non buffered mode

virtual void OIS::Mouse::setEventCallback ( MouseListener * mouseListener )

inlinevirtual

Remarks: Register/unregister a Mouse Listener - Only one allowed for simplicity. If broadcasting is neccessary, just broadcast from the callback you registered.

Parameters

mouseListener Send a pointer to a class derived from MouseListener or 0 to clear the callback

MouseListener* OIS::Mouse::mListener

protected

Used for buffered/actionmapping callback.

MouseState OIS::Mouse::mState

protected

The state of the mouse.

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