IMouse Class Reference

Defines the interface that a Mouse implementation must implement. More...

#include <Input/Mouse.h>

Inherited by SDLMouse.

List of all members.

Public Member Functions
virtual bool	ButtonPressed (MouseButton button, Point2i *pos=NULL) const =0
	Determines if the given mouse button was just pressed.
virtual bool	ButtonReleased (MouseButton button, Point2i *pos=NULL) const =0
	Determines if the given mouse button was just released.
virtual bool	ButtonDown (MouseButton button) const =0
	Determines if the given mouse button is down.
virtual bool	WheelUp () const =0
	Determines if the mouse wheel has been moved up.
virtual bool	WheelDown () const =0
	Determines if the mouse wheel has been moved down.
virtual bool	HasFocus () const =0
	Determines if the mouse has screen focus.
virtual bool	InFixedPositionMode () const =0
	Determines if the mouse is in fixed position mode.
virtual Point2i	GetPos () const =0
	Gets the current position of the mouse.
virtual Point2f	GetPosNorm () const =0
	Gets the mouse position in normalized screen coordinates.
virtual Point2i	GetMoveDelta () const =0
	Gets the amount the mouse has moved since the last update.

---

Detailed Description

Defines the interface that a Mouse implementation must implement.

---

Member Function Documentation

virtual bool IMouse::ButtonDown

(

MouseButton

button

)

const [pure virtual]

Determines if the given mouse button is down.

Parameters:

[in]

button

the MouseButton to check.

Returns:

True if the given button has been pressed and is now being held down.

Implemented in SDLMouse.

virtual bool IMouse::ButtonPressed	(	MouseButton	button,
		Point2i *	pos = NULL
	)			const [pure virtual]

Determines if the given mouse button was just pressed.

Parameters:

[in]	button	the MouseButton to check.
[in]	pos	pointer that will hold the position where the button was pressed. Defaults to NULL.

Returns:

True if the given button has been pressed. Optionally outputs the position where the button was pressed.

Implemented in SDLMouse.

virtual bool IMouse::ButtonReleased	(	MouseButton	button,
		Point2i *	pos = NULL
	)			const [pure virtual]

Determines if the given mouse button was just released.

Parameters:

[in]	button	the MouseButton to check.
[in]	pos	pointer that will hold the position where the button was released. Defaults to NULL.

Returns:

True if the given button wass just released.

Implemented in SDLMouse.

virtual Point2i IMouse::GetMoveDelta

(

)

const [pure virtual]

Gets the amount the mouse has moved since the last update.

Returns:

the amount the mouse has moved since the last update.

Implemented in SDLMouse.

virtual Point2i IMouse::GetPos

(

)

const [pure virtual]

Gets the current position of the mouse.

Returns:

the current mouse position.

Implemented in SDLMouse.

virtual Point2f IMouse::GetPosNorm

(

)

const [pure virtual]

Gets the mouse position in normalized screen coordinates.

Returns:

the current mouse position in normalized screen coordinates.

Implemented in SDLMouse.

virtual bool IMouse::HasFocus

(

)

const [pure virtual]

Determines if the mouse has screen focus.

Returns:

True if the mouse has screen focus, false otherwise.

Implemented in SDLMouse.

virtual bool IMouse::InFixedPositionMode

(

)

const [pure virtual]

Determines if the mouse is in fixed position mode.

Returns:

True if the mouse is in fixed position mode, false otherwise.

Implemented in SDLMouse.

virtual bool IMouse::WheelDown

(

)

const [pure virtual]

Determines if the mouse wheel has been moved down.

Returns:

True if the mouse wheel has been moved down.

Implemented in SDLMouse.

virtual bool IMouse::WheelUp

(

)

const [pure virtual]

Determines if the mouse wheel has been moved up.

Returns:

True if the mouse wheel has been moved up.

Implemented in SDLMouse.

---

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

• Mouse.h