M_HidJoystick::IClient Class Reference

Public Member Functions
virtual	~IClient ()
virtual void	EventButton (uint32_t ButtonIndex, std::string const &ButtonName, bool IsSelected)
virtual void	EventIncrement (uint32_t Index, int32_t Steps)
virtual void	ReportJoystickSettings (M_HidJoystick::JoystickSettingsType const &Settings)
virtual void	ReportAxis (uint32_t KeyAxisIndex, double Value, bool IsRemoved)
virtual void	ReportInputValue (uint32_t KeyValueInputIndex, M_Common::PropertyType const &Value, bool IsRemoved)
virtual void	ReportMenuStatus (uint32_t KeyMenuIndex, bool IsActive, bool IsRemoved)
virtual void	ReportJoystickCurve (uint32_t KeyAxisIndex, std::string const &Curve, bool IsRemoved)

Detailed Description

Client interface. Contains operations reported by a Joystick Service.

Constructor & Destructor Documentation

~IClient()

M_HidJoystick::IClient::~IClient ( )

virtual

Member Function Documentation

EventButton()

void M_HidJoystick::IClient::EventButton ( uint32_t  ButtonIndex, std::string const &  ButtonName, bool  IsSelected  )

virtual

Triggered every time a Joystick button is selected or unselected.

Parameters

ButtonIndex	Index identifying the button.
ButtonName	Name of the button.
IsSelected	Indicates if the button has been selected (true) or unselected (false).

EventIncrement()

void M_HidJoystick::IClient::EventIncrement ( uint32_t  Index, int32_t  Steps  )

virtual

Triggered every time a increment encoder is activated.

Parameters

Index	Index identifying the increment.
Steps	The current number of steps value.

ReportAxis()

void M_HidJoystick::IClient::ReportAxis ( uint32_t  KeyAxisIndex, double  Value, bool  IsRemoved  )

virtual

Reports the current axis position every time a joystick axis is moved.

Parameters

KeyAxisIndex	Index identifying the axis.
Value	The current axis value. Range: -1.0 - +1.0
IsRemoved	Indicates if the status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.

ReportInputValue()

void M_HidJoystick::IClient::ReportInputValue ( uint32_t  KeyValueInputIndex, M_Common::PropertyType const &  Value, bool  IsRemoved  )

virtual

Reports the specified input value.

Parameters

KeyValueInputIndex	Identifies the value input index.
Value	Value.
IsRemoved	Indicates if the status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.

ReportJoystickCurve()

void M_HidJoystick::IClient::ReportJoystickCurve ( uint32_t  KeyAxisIndex, std::string const &  Curve, bool  IsRemoved  )

virtual

Contains the joystick input curve.

Parameters

KeyAxisIndex	Identifies the axis.
Curve	Input scaling characteristics.
IsRemoved	Indicates if the status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.

ReportJoystickSettings()

void M_HidJoystick::IClient::ReportJoystickSettings ( M_HidJoystick::JoystickSettingsType const &  Settings )

virtual

Contains the static settings for a Joystick. This should be provided at startup and in the event of degraded functionality, e.g. due to an internal failure.

Parameters

Settings

Joystick settings data.

ReportMenuStatus()

void M_HidJoystick::IClient::ReportMenuStatus ( uint32_t  KeyMenuIndex, bool  IsActive, bool  IsRemoved  )

virtual

Reports the specified menu's status.

Parameters

KeyMenuIndex	Identifies the menu index.
IsActive	Indicates whether the menu is active.
IsRemoved	Indicates if the status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.