KODI::JOYSTICK::CScalarFeature Class Reference

#include <FeatureHandling.h>

Inheritance diagram for KODI::JOYSTICK::CScalarFeature:

Public Member Functions
	CScalarFeature (const FeatureName &name, IInputHandler *handler, IButtonMap *buttonMap)
	~CScalarFeature () override=default
bool	OnDigitalMotion (const CDriverPrimitive &source, bool bPressed) override
	A digital motion has occurred.
bool	OnAnalogMotion (const CDriverPrimitive &source, float magnitude) override
	An analog motion has occurred.
void	ProcessMotions () override
	Process the motions that have occurred since the last invocation.
Public Member Functions inherited from KODI::JOYSTICK::CJoystickFeature
	CJoystickFeature (const FeatureName &name, IInputHandler *handler, IButtonMap *buttonMap)
virtual	~CJoystickFeature ()=default
bool	AcceptsInput (bool bActivation)
	Check if the input handler is accepting input.

Additional Inherited Members
Protected Member Functions inherited from KODI::JOYSTICK::CJoystickFeature
void	ResetMotion ()
	Reset motion timer.
void	StartMotion ()
	Start the motion timer.
bool	InMotion () const
	Check if the feature is in motion.
unsigned int	MotionTimeMs () const
	Get the time for which the feature has been in motion.
Protected Attributes inherited from KODI::JOYSTICK::CJoystickFeature
const FeatureName	m_name
IInputHandler *const	m_handler
IButtonMap *const	m_buttonMap
const bool	m_bEnabled

Constructor & Destructor Documentation

CScalarFeature()

CScalarFeature::CScalarFeature	(	const FeatureName &	name,
		IInputHandler *	handler,
		IButtonMap *	buttonMap )

~CScalarFeature()

KODI::JOYSTICK::CScalarFeature::~CScalarFeature ( )

overridedefault

Member Function Documentation

OnAnalogMotion()

bool CScalarFeature::OnAnalogMotion ( const CDriverPrimitive & source, float magnitude )

overridevirtual

An analog motion has occurred.

Parameters

source	The source of the motion. Must be a semiaxis
magnitude	The magnitude of the press or motion in the interval [0.0, 1.0]

For semiaxes, the magnitude is the force or travel distance in the direction of the semiaxis. If the value is in the opposite direction, the magnitude is 0.0.

For example, if the analog stick goes left, the negative semiaxis will have a value of 1.0 and the positive semiaxis will have a value of 0.0.

Implements KODI::JOYSTICK::CJoystickFeature.

OnDigitalMotion()

bool CScalarFeature::OnDigitalMotion ( const CDriverPrimitive & source, bool bPressed )

overridevirtual

A digital motion has occurred.

Parameters

source	The source of the motion. Must be digital (button or hat)
bPressed	True for press motion, false for release motion

Returns

true if the motion was handled, false otherwise

Implements KODI::JOYSTICK::CJoystickFeature.

ProcessMotions()

void CScalarFeature::ProcessMotions ( )

overridevirtual

Process the motions that have occurred since the last invocation.

This allows features with motion on multiple driver primitives to call their handler once all driver primitives are accounted for.

Implements KODI::JOYSTICK::CJoystickFeature.

---

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

• FeatureHandling.h
• FeatureHandling.cpp