OIS::LinuxMouse Class Reference

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/external/ois/linux/LinuxMouse.h>

Inheritance diagram for OIS::LinuxMouse:

Public Member Functions
	LinuxMouse (InputManager *creator, bool buffered, bool grab, bool hide)
virtual	~LinuxMouse ()
virtual void	_initialize ()
virtual void	capture ()
void	grab (bool grab)
void	hide (bool hide)
virtual Interface *	queryInterface (Interface::IType)
virtual void	setBuffered (bool buffered)
Public Member Functions inherited from OIS::Mouse
virtual	~Mouse ()
MouseListener *	getEventCallback () const
const MouseState &	getMouseState () const
virtual void	setEventCallback (MouseListener *mouseListener)
Public Member Functions inherited from OIS::Object
virtual	~Object ()
virtual bool	buffered () const
InputManager *	getCreator () const
virtual int	getID () const
Type	type () const
const std::string &	vendor () const

Protected Member Functions
void	_processXEvents ()
Protected Member Functions inherited from OIS::Mouse
	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
Cursor	cursor
Display *	display
bool	grabMouse
bool	hideMouse
bool	mMoved
bool	mouseFocusLost
bool	mWarped
long	oldXMouseX
long	oldXMouseY
long	oldXMouseZ
Window	window
Protected Attributes inherited from OIS::Mouse
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...

Constructor & Destructor Documentation

LinuxMouse::LinuxMouse	(	InputManager *	creator,
		bool	buffered,
		bool	grab,
		bool	hide
	)

LinuxMouse::~LinuxMouse ( )

virtual

Member Function Documentation

void LinuxMouse::_initialize ( )

virtual

Remarks

Internal... Do not call this directly.

Implements OIS::Object.

void LinuxMouse::_processXEvents ( )

protected

void LinuxMouse::capture ( )

virtual

Remarks

Note: Calling this will also update the keyboard (X11 updates in a single event queue). Updates State and/or raises event for buffered mode..

Implements OIS::Object.

void LinuxMouse::grab

(

bool

grab

)

void LinuxMouse::hide

(

bool

hide

)

virtual Interface* OIS::LinuxMouse::queryInterface ( Interface::IType  )

inlinevirtual

Remarks

If available, get an interface to write to some devices. Examples include, turning on and off LEDs, ForceFeedback, etc

Parameters

type	The type of interface you are looking for

Implements OIS::Object.

void LinuxMouse::setBuffered ( bool  buffered )

virtual

Remarks

Sets buffered mode

Implements OIS::Object.

Member Data Documentation

Cursor OIS::LinuxMouse::cursor

protected

Display* OIS::LinuxMouse::display

protected

bool OIS::LinuxMouse::grabMouse

protected

bool OIS::LinuxMouse::hideMouse

protected

bool OIS::LinuxMouse::mMoved

protected

bool OIS::LinuxMouse::mouseFocusLost

protected

bool OIS::LinuxMouse::mWarped

protected

long OIS::LinuxMouse::oldXMouseX

protected

long OIS::LinuxMouse::oldXMouseY

protected

long OIS::LinuxMouse::oldXMouseZ

protected

Window OIS::LinuxMouse::window

protected

---

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

• external/ois/linux/LinuxMouse.h
• external/ois/linux/LinuxMouse.cpp