syBR::InputCore::MouseHandler Class Reference

Base mouse handler class. More...

#include <MouseHandler.hpp>

Inheritance diagram for syBR::InputCore::MouseHandler:

List of all members.

Public Member Functions

MouseHandler ()

Constructor.

virtual ~MouseHandler ()

Destructor.

virtual bool isButtonDown (MouseButton button)=0

Check if a button is down.

virtual const int getMousePosition (const unsigned int axis, const bool relative) const =0

Get the position of the mouse along an axis.

Detailed Description

Base mouse handler class.

This is the object which gives access to the mouse. This is a pure abstract class which needs a concrete implementation (using OIS, DirectInput or any other input library).

Constructor & Destructor Documentation

syBR::InputCore::MouseHandler::MouseHandler ( )

Constructor.

syBR::InputCore::MouseHandler::~MouseHandler ( ) [virtual]

Destructor.

Reimplemented in syBR::InputOIS::MouseHandler.

Member Function Documentation

virtual bool syBR::InputCore::MouseHandler::isButtonDown ( MouseButton button ) [pure virtual]

Check if a button is down.

Parameters:

button

Button to be checked

Returns:

One of these:

true if the button is currently down
false otherwise

Implemented in syBR::InputOIS::MouseHandler.

virtual const int syBR::InputCore::MouseHandler::getMousePosition	(	const unsigned int	axis,
		const bool	relative
	)			const `[pure virtual]`

Get the position of the mouse along an axis.

Parameters:

	axis	0 for x-axis, 1 for y-axis and 2 for z-axis (wheel)
	relative	One of these: true to return the position relative to the last kwown position false to return the absolute position

Returns:: Position of the mouse along the specified axis

Implemented in syBR::InputOIS::MouseHandler.

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

/home/seb/syBR/inputCore/src/MouseHandler.hpp
/home/seb/syBR/inputCore/src/MouseHandler.cpp


Public Member Functions
	MouseHandler ()
	Constructor.
virtual	~MouseHandler ()
	Destructor.
virtual bool	isButtonDown (MouseButton button)=0
	Check if a button is down.
virtual const int	getMousePosition (const unsigned int axis, const bool relative) const =0
	Get the position of the mouse along an axis.