Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
No Matches
KODI::JOYSTICK::CWheel Class Reference

#include <FeatureHandling.h>

Inheritance diagram for KODI::JOYSTICK::CWheel:
KODI::JOYSTICK::CAxisFeature KODI::JOYSTICK::CJoystickFeature

Public Member Functions

 CWheel (const FeatureName &name, IInputHandler *handler, IButtonMap *buttonMap)
 ~CWheel () override=default
bool OnAnalogMotion (const CDriverPrimitive &source, float magnitude) override
 An analog motion has occurred.
- Public Member Functions inherited from KODI::JOYSTICK::CAxisFeature
 CAxisFeature (const FeatureName &name, IInputHandler *handler, IButtonMap *buttonMap)
 ~CAxisFeature () override=default
bool OnDigitalMotion (const CDriverPrimitive &source, bool bPressed) override
 A digital 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::CAxisFeature
CFeatureAxis m_axis
float m_state = 0.0f
- 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

◆ CWheel()

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

◆ ~CWheel()

KODI::JOYSTICK::CWheel::~CWheel ( )

Member Function Documentation

◆ OnAnalogMotion()

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

An analog motion has occurred.

sourceThe source of the motion. Must be a semiaxis
magnitudeThe 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.

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