dtGame::InputComponentMouseListener Class Reference

Implementation of MouseListener. More...

#include <baseinputcomponent.h>

Inheritance diagram for dtGame::InputComponentMouseListener:

List of all members.

Public Member Functions
	InputComponentMouseListener (dtGame::BaseInputComponent &inputComp)
	Constructor.
virtual bool	HandleButtonPressed (const dtCore::Mouse *mouse, dtCore::Mouse::MouseButton button)
	Called when a button is pressed.
virtual bool	HandleButtonReleased (const dtCore::Mouse *mouse, dtCore::Mouse::MouseButton button)
	Called when a button is released.
virtual bool	HandleButtonClicked (const dtCore::Mouse *mouse, dtCore::Mouse::MouseButton button, int clickCount)
	Called when a button is clicked.
virtual bool	HandleMouseMoved (const dtCore::Mouse *mouse, float x, float y)
	Called when the mouse pointer is moved.
virtual bool	HandleMouseDragged (const dtCore::Mouse *mouse, float x, float y)
	Called when the mouse pointer is dragged.
virtual bool	HandleMouseScrolled (const dtCore::Mouse *mouse, int delta)
	Called when the mouse is scrolled.
Protected Member Functions
virtual	~InputComponentMouseListener ()
	Destructor.

---

Detailed Description

Implementation of MouseListener.

This is used internally by the BaseInputComponent for handling mouse events in a Game Manager app using the GameEntryPoint

See also:

BaseInputComponent

GameEntryPoint

---

Constructor & Destructor Documentation

dtGame::InputComponentMouseListener::InputComponentMouseListener

(

dtGame::BaseInputComponent &

inputComp

)

Constructor.

virtual dtGame::InputComponentMouseListener::~InputComponentMouseListener

(

)

[inline, protected, virtual]

Destructor.

---

Member Function Documentation

virtual bool dtGame::InputComponentMouseListener::HandleButtonPressed	(	const dtCore::Mouse *	mouse,
		dtCore::Mouse::MouseButton	button
	)			[inline, virtual]

Called when a button is pressed.

Parameters:

	mouse	the source of the event
	button	the button pressed

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implements dtCore::MouseListener.

virtual bool dtGame::InputComponentMouseListener::HandleButtonReleased	(	const dtCore::Mouse *	mouse,
		dtCore::Mouse::MouseButton	button
	)			[inline, virtual]

Called when a button is released.

Parameters:

	mouse	the source of the event
	button	the button released

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implements dtCore::MouseListener.

virtual bool dtGame::InputComponentMouseListener::HandleButtonClicked	(	const dtCore::Mouse *	mouse,
		dtCore::Mouse::MouseButton	button,
		int	clickCount
	)			[inline, virtual]

Called when a button is clicked.

Parameters:

	mouse	the source of the event
	button	the button clicked
	clickCount	the click count

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implements dtCore::MouseListener.

virtual bool dtGame::InputComponentMouseListener::HandleMouseMoved	(	const dtCore::Mouse *	mouse,
		float	x,
		float	y
	)			[inline, virtual]

Called when the mouse pointer is moved.

Parameters:

	mouse	the source of the event
	x	the x coordinate
	y	the y coordinate

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implements dtCore::MouseListener.

virtual bool dtGame::InputComponentMouseListener::HandleMouseDragged	(	const dtCore::Mouse *	mouse,
		float	x,
		float	y
	)			[inline, virtual]

Called when the mouse pointer is dragged.

Parameters:

	mouse	the source of the event
	x	the x coordinate
	y	the y coordinate

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implements dtCore::MouseListener.

virtual bool dtGame::InputComponentMouseListener::HandleMouseScrolled	(	const dtCore::Mouse *	mouse,
		int	delta
	)			[inline, virtual]

Called when the mouse is scrolled.

Parameters:

	mouse	the source of the event
	delta	the scroll delta (+1 for up one, -1 for down one)

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implements dtCore::MouseListener.

---