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

Analog axis deadzone filtering. More...

#include <DeadzoneFilter.h>

Public Member Functions

 CDeadzoneFilter (IButtonMap *buttonMap, PERIPHERALS::CPeripheral *peripheral)
 
float FilterAxis (unsigned int axisIndex, float axisValue)
 Apply deadzone filtering to an axis.
 

Static Public Attributes

static const char * SETTING_LEFT_STICK_DEADZONE = "left_stick_deadzone"
 
static const char * SETTING_RIGHT_STICK_DEADZONE = "right_stick_deadzone"
 

Detailed Description

Analog axis deadzone filtering.

Axis is scaled appropriately, so position is continuous from -1.0 to 1.0:

       |    / 1.0
       |   /
     __|__/
    /  |
   /   |--| Deadzone

-1.0 / |

After deadzone filtering, the value will be:

  • Negative in the interval [-1.0, -deadzone)
  • Zero in the interval [-deadzone, deadzone]
  • Positive in the interval (deadzone, 1.0]

Constructor & Destructor Documentation

◆ CDeadzoneFilter()

CDeadzoneFilter::CDeadzoneFilter ( IButtonMap * buttonMap,
PERIPHERALS::CPeripheral * peripheral )

Member Function Documentation

◆ FilterAxis()

float CDeadzoneFilter::FilterAxis ( unsigned int axisIndex,
float axisValue )

Apply deadzone filtering to an axis.

Parameters
axisIndexThe axis index
axisValueThe axis value
Returns
The value after applying deadzone filtering

Member Data Documentation

◆ SETTING_LEFT_STICK_DEADZONE

const char * CDeadzoneFilter::SETTING_LEFT_STICK_DEADZONE = "left_stick_deadzone"
static

◆ SETTING_RIGHT_STICK_DEADZONE

const char * CDeadzoneFilter::SETTING_RIGHT_STICK_DEADZONE = "right_stick_deadzone"
static

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