#include <Joystick.h>

Classes
struct	State

Public Member Functions
	Joystick ()

virtual	~Joystick ()

bool	getJoystickPosition (int nJoy, State &output)

void	setLimits (const std::vector< int > &minPerAxis, const std::vector< int > &maxPerAxis)

Static Public Member Functions
static int	getJoysticksCount ()

Detailed Description

Access to joysticks and gamepads (read buttons and position), and request number of joysticks in the system.

Note: New in MRPT 2.13.0: the API changed to support an arbitrary number of input axes.

Constructor & Destructor Documentation

◆ Joystick()

mvsim::Joystick::Joystick ( )

Constructor

◆ ~Joystick()

virtual mvsim::Joystick::~Joystick ( )

virtual

Destructor

Member Function Documentation

◆ getJoystickPosition()

bool mvsim::Joystick::getJoystickPosition	(	int	nJoy,
		State &	output
	)

Gets joystick information.

This method will try first to open the joystick, so you can safely call it while the joystick is plugged and removed arbitrarly.

Parameters

nJoy	The index of the joystick to query: The first one is 0, the second 1, etc... See CJoystick::getJoysticksCount to discover the number of joysticks in the system.
x	The x axis position, range [-1,1]
y	The y axis position, range [-1,1]
z	The z axis position, range [-1,1]
buttons	Each element will hold true if buttons are pressed. The size of the vector will be set automatically to the number of buttons.
raw_x_pos	If it is desired the raw integer measurement from JoyStick, set this pointer to a desired placeholder.
raw_y_pos	If it is desired the raw integer measurement from JoyStick, set this pointer to a desired placeholder.
raw_z_pos	If it is desired the raw integer measurement from JoyStick, set this pointer to a desired placeholder.

Returns: Returns true if successfull, false on error, for example, if joystick is not present.

See also: setLimits

◆ getJoysticksCount()

static int mvsim::Joystick::getJoysticksCount ( )

static

Returns the number of Joysticks in the computer.

◆ setLimits()

void mvsim::Joystick::setLimits	(	const std::vector< int > &	minPerAxis,
		const std::vector< int > &	maxPerAxis
	)

Set the axis limit values, for computing a [-1,1] position index easily Only required to calibrate analog joystick. It seems that these values must been calibrated for each joystick model.

Default values:

Windows: [0, 0xFFFF]
Linux: [-32767,32767]

See also: getJoystickPosition

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

/home/docs/checkouts/readthedocs.org/user_builds/mvsimulator/checkouts/stable/modules/simulator/include/mvsim/Joystick.h

Classes

Public Member Functions

Static Public Member Functions