Orxonox: OIS::Mouse Class Reference

# OIS::Mouse Class Reference

`#include <src/ois/OISMouse.h>`

Inheritance diagram for OIS::Mouse:

List of all members.

## Public Member Functions

MouseListener * | getEventCallback () const
const MouseState & | getMouseState () const
virtual void | setEventCallback (MouseListener *mouseListener)
virtual | ~Mouse ()

## Protected Member Functions

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

## Protected Attributes

MouseListener * | mListener
| 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

MouseListener* OIS::Mouse::mListener`[protected]`

Used for buffered/actionmapping callback.

Referenced by OIS::Win32Mouse::_doMouseClick(), OIS::MacMouse::_mouseCallback(), OIS::LinuxMouse::_processXEvents(), OIS::Win32Mouse::capture(), OIS::MacMouse::capture(), and OIS::LinuxMouse::capture().

MouseState OIS::Mouse::mState`[protected]`

The state of the mouse.

Referenced by OIS::Win32Mouse::_doMouseClick(), OIS::Win32Mouse::_initialize(), OIS::MacMouse::_initialize(), OIS::LinuxMouse::_initialize(), OIS::MacMouse::_mouseCallback(), OIS::LinuxMouse::_processXEvents(), OIS::Win32Mouse::capture(), OIS::MacMouse::capture(), and OIS::LinuxMouse::capture().

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

- src/ois/OISMouse.h