KODI::GAME::CGameClientMouse Class Reference

Handles mouse events for games. More...

#include <GameClientMouse.h>

Inheritance diagram for KODI::GAME::CGameClientMouse:

Collaboration diagram for KODI::GAME::CGameClientMouse:

Public Member Functions
	CGameClientMouse (CGameClient &gameClient, std::string controllerId, MOUSE::IMouseInputProvider *inputProvider)
	Constructor registers for mouse events at CInputManager. More...
	~CGameClientMouse () override
	Destructor unregisters from mouse events from CInputManager.
std::string	ControllerID () const override
	The controller profile for this mouse input handler. More...
bool	OnMotion (const std::string &relpointer, int dx, int dy) override
	A relative pointer has moved. More...
bool	OnButtonPress (const std::string &button) override
	A mouse button has been pressed. More...
void	OnButtonRelease (const std::string &button) override
	A mouse button has been released. More...
void	OnInputFrame () override
	Called at the end of the frame that provided input. More...
const std::string &	GetControllerID () const
const PERIPHERALS::PeripheralPtr &	GetSource () const
float	GetActivation () const
void	SetSource (PERIPHERALS::PeripheralPtr sourcePeripheral)
void	ClearSource ()

Detailed Description

Handles mouse events for games.

Listens to mouse events and forwards them to the games (as game_input_event).

Constructor & Destructor Documentation

CGameClientMouse()

CGameClientMouse::CGameClientMouse	(	CGameClient &	gameClient,
		std::string	controllerId,
		MOUSE::IMouseInputProvider *	inputProvider
	)

Constructor registers for mouse events at CInputManager.

Parameters

gameClient	The game client implementation.
controllerId	The controller profile used for input
dllStruct	The emulator or game to which the events are sent.
inputProvider	The interface providing us with mouse input.

Member Function Documentation

ControllerID()

std::string CGameClientMouse::ControllerID ( ) const

overridevirtual

The controller profile for this mouse input handler.

Returns

The ID of the add-on extending kodi.game.controller

Implements KODI::MOUSE::IMouseInputHandler.

OnButtonPress()

bool CGameClientMouse::OnButtonPress ( const std::string &  button )

overridevirtual

A mouse button has been pressed.

Parameters

button

The name of the feature being pressed

Returns

True if the event was handled, otherwise false

Implements KODI::MOUSE::IMouseInputHandler.

OnButtonRelease()

void CGameClientMouse::OnButtonRelease ( const std::string &  button )

overridevirtual

A mouse button has been released.

Parameters

button

The name of the feature being released

Implements KODI::MOUSE::IMouseInputHandler.

OnInputFrame()

void CGameClientMouse::OnInputFrame ( )

overridevirtual

Called at the end of the frame that provided input.

This can be as a result of a pointer update, a button press, or a button release. All three events will result in a call to OnInputFrame().

Implements KODI::MOUSE::IMouseInputHandler.

OnMotion()

bool CGameClientMouse::OnMotion ( const std::string &  relpointer, int  dx, int  dy  )

overridevirtual

A relative pointer has moved.

Parameters

relpointer	The name of the relative pointer being moved
dx	The relative x coordinate of motion
dy	The relative y coordinate of motion

The mouse uses a left-handed (graphics) cartesian coordinate system. Positive X is right, positive Y is down.

Returns

True if the event was handled, otherwise false

Todo:

Allow mouse motion to activate controller This will follow a larger refactoring of the mouse input system

Implements KODI::MOUSE::IMouseInputHandler.

---

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

• xbmc/games/addons/input/GameClientMouse.h
• xbmc/games/addons/input/GameClientMouse.cpp