OIS::Mouse Class Reference

#include <OISMouse.h>

Inheritance diagram for OIS::Mouse:

OIS::Object List of all members.

Public Member Functions

virtual ~Mouse ()
virtual void setEventCallback (MouseListener *mouseListener)
MouseListenergetEventCallback ()
const MouseStategetMouseState () const

Protected Member Functions

 Mouse ()

Protected Attributes

MouseState mState
 The state of the mouse.
MouseListenerlistener
 Used for buffered/actionmapping callback.

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 (  )  [inline, virtual]

OIS::Mouse::Mouse (  )  [inline, protected]


Member Function Documentation

virtual void OIS::Mouse::setEventCallback ( MouseListener mouseListener  )  [inline, virtual]

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::getEventCallback (  )  [inline]

Remarks:
Returns currently set callback.. or 0

const MouseState& OIS::Mouse::getMouseState (  )  const [inline]

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


Member Data Documentation

MouseState OIS::Mouse::mState [protected]

The state of the mouse.

MouseListener* OIS::Mouse::listener [protected]

Used for buffered/actionmapping callback.


The documentation for this class was generated from the following file:
Generated on Fri Jul 13 21:21:06 2007 for OIS by  doxygen 1.5.2