OIS::Mouse Class Reference

#include <src/ois/OISMouse.h>

Inheritance diagram for OIS::Mouse:

OIS::Object OIS::LinuxMouse OIS::MacMouse OIS::Win32Mouse

List of all members.

Public Member Functions

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

Protected Member Functions

 Mouse (const std::string &vendor, bool buffered, int devID, InputManager *creator)

Protected Attributes

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


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 ( const std::string vendor,
bool  buffered,
int  devID,
InputManager creator 
) [inline, protected]


Member Function Documentation

MouseListener* OIS::Mouse::getEventCallback (  )  const [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

Referenced by orxonox::InputManager::_reload(), and orxonox::InputManager::setWindowExtents().

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

Referenced by orxonox::InputManager::_initialiseMouse().


Member Data Documentation


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

Generated on Tue Jul 28 16:22:18 2009 for Orxonox by  doxygen 1.5.6