MouseDevice Class Reference

Inheritance diagram for MouseDevice:

Public Types
enum	MOUSE_BUTTONS
	buttons list

Public Member Functions
	MouseDevice (const kstl::string &name, DECLARE_CLASS_NAME_TREE_ARG)
	constructor More...
int	getButtonsCount ()
	button count for this mouse More...
int	getWheelCount ()
	wheel count for this mouse More...
kfloat	getWheelRoll ()
	wheel roll (Z axis) for this mouse More...
kfloat	getWheelRollDelta ()
	delta for wheel roll (Z axis) for this mouse More...
void	getPos (kfloat &posX, kfloat &posY)
	retreive current position More...
void	getMouvement (kfloat &dX, kfloat &dY)
	retreive movement More...
int	getButtonState (MOUSE_BUTTONS button)
	retreive given button state More...

Protected Member Functions
virtual	~MouseDevice ()
	destructor

Protected Attributes
int	mWheelCount
	wheel count
int	mButtonsCount
	button count
maFloat	mPosX
	mouse cursor current position on x axis
maFloat	mPosY
	mouse cursor current position on y axis
kfloat	mDX
	mouse movement on x axis
kfloat	mDY
	mouse movement on y axis
kfloat	mDZ
	wheel movement
kfloat	mPreviousDZ
	delta for wheel movement

Detailed Description

mouse cursor current position on x axis

Attributes

Key : PosX

• Type : float
• Default Value : 0.000000

Key : PosY

• Type : float
• Default Value : 0.000000

mouse cursor current position on y axis

Constructor & Destructor Documentation

MouseDevice()

MouseDevice::MouseDevice	(	const kstl::string &	name,
		DECLARE_CLASS_NAME_TREE_ARG
	)

constructor

Parameters

name	: instance name
DECLARE_CLASS_NAME_TREE_ARG	: list of arguments

Member Function Documentation

getButtonsCount()

int MouseDevice::getButtonsCount ( )

inline

button count for this mouse

Returns

the number of buttons

getButtonState()

int MouseDevice::getButtonState ( MOUSE_BUTTONS  button )

inline

retreive given button state

Parameters

button

: given button

Returns

state of the given button

getMouvement()

void MouseDevice::getMouvement ( kfloat &  dX, kfloat &  dY  )

inline

retreive movement

retreive movement

Parameters

dX	: movement on x axis (in/out param)
dY	: movement on y axis (in/out param)

getPos()

void MouseDevice::getPos ( kfloat &  posX, kfloat &  posY  )

inline

retreive current position

Parameters

posX	: position on x axis (in/out param)
posY	: position on y axis (in/out param)

getWheelCount()

int MouseDevice::getWheelCount ( )

inline

wheel count for this mouse

Returns

the wheel count for this mouse

getWheelRoll()

int MouseDevice::getWheelRoll ( )

inline

wheel roll (Z axis) for this mouse

Returns

the wheel roll (Z axis) for this mouse

getWheelRollDelta()

int MouseDevice::getWheelRollDelta ( )

inline

delta for wheel roll (Z axis) for this mouse

Returns

delta for the wheel roll (Z axis) for this mouse

---

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

• G:/Projects/Github/kigs/framework/Input/Headers/MouseDevice.h
• G:/Projects/Github/kigs/framework/Input/Sources/MouseDevice.cpp