OIS::Mouse Class Reference

#include <OISMouse.h>

Inheritance diagram for OIS::Mouse:

[legend]

Collaboration diagram for OIS::Mouse:

[legend]

List of all members.

Public Member Functions
virtual	~Mouse ()
virtual void	setEventCallback (MouseListener *mouseListener)
MouseListener *	getEventCallback ()
const MouseState &	getMouseState () const
Protected Member Functions
	Mouse ()
Protected Attributes
MouseState	mState
	The state of the mouse.
MouseListener *	listener
	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.

Definition at line 106 of file OISMouse.h.

---

Constructor & Destructor Documentation

virtual OIS::Mouse::~Mouse

(

)

[inline, virtual]

Definition at line 109 of file OISMouse.h.

OIS::Mouse::Mouse

(

)

[inline, protected]

Definition at line 127 of file OISMouse.h.

---

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

Definition at line 118 of file OISMouse.h.

Referenced by initOIS().

MouseListener* OIS::Mouse::getEventCallback

(

)

[inline]

Remarks:

Returns currently set callback.. or 0

Definition at line 121 of file OISMouse.h.

const MouseState& OIS::Mouse::getMouseState

(

)

const [inline]

Remarks:

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

Definition at line 124 of file OISMouse.h.

Referenced by handleNonBufferedMouse().

---

Member Data Documentation

MouseState OIS::Mouse::mState [protected]

The state of the mouse.

Definition at line 129 of file OISMouse.h.

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

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

Used for buffered/actionmapping callback.

Definition at line 132 of file OISMouse.h.

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

---

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

• E:/Download/ois-1.0RC1/includes/OISMouse.h

---