SDLJoypad: Device that reads inputs of Joypads compatible with the SDL library.
More...
#include <SDLJoypad/SDLJoypad.h>
Inheritance diagram for SDLJoypad:Public Member Functions | |
| SDLJoypad () | |
| virtual | ~SDLJoypad () |
| bool | open (yarp::os::Searchable &config) override |
| Open the DeviceDriver. | |
| bool | close () override |
| Close the DeviceDriver. | |
| yarp::dev::ReturnValue | getAxisCount (size_t &axis_count) override |
| Get number of axes. | |
| yarp::dev::ReturnValue | getButtonCount (size_t &button_count) override |
| Get number of buttons. | |
| yarp::dev::ReturnValue | getHatCount (size_t &hat_count) override |
| Get number of hats. | |
| yarp::dev::ReturnValue | getTrackballCount (size_t &trackball_count) override |
| Get number of trackballs. | |
| yarp::dev::ReturnValue | getTouchSurfaceCount (size_t &touch_count) override |
| Get the number of touch surface. | |
| yarp::dev::ReturnValue | getStickCount (size_t &stick_count) override |
| Get the number of the sticks. | |
| yarp::dev::ReturnValue | getButton (size_t button_id, double &value) override |
| Get the value of a button. | |
| yarp::dev::ReturnValue | getTrackball (size_t trackball_id, yarp::dev::TrackballData &value) override |
| Get the axes change of a Trackball. | |
| yarp::dev::ReturnValue | getHat (size_t hat_id, unsigned char &value) override |
| Get the value of an Hat. | |
| yarp::dev::ReturnValue | getAxis (size_t axis_id, double &value) override |
| Get the value of an axis if present, return false otherwise. | |
| yarp::dev::ReturnValue | getStick (size_t stick_id, yarp::dev::StickData &value, JoypadCtrl_coordinateMode coordinate_mode) override |
| Get the value of a stick if present, return false otherwise. | |
| yarp::dev::ReturnValue | getTouch (size_t touch_id, std::vector< yarp::dev::TouchData > &value) override |
| Get the value of a touch if present, return false otherwise. | |
Public Member Functions inherited from yarp::dev::IJoypadController | |
| virtual | ~IJoypadController () |
| Destructor. | |
| virtual yarp::dev::ReturnValue | getAllAxes (std::vector< double > &values) |
| Get the values of all available joystick axes. | |
Public Member Functions inherited from yarp::dev::DeviceDriver | |
| DeviceDriver () | |
| DeviceDriver (const DeviceDriver &other)=delete | |
| DeviceDriver (DeviceDriver &&other) noexcept=delete | |
| DeviceDriver & | operator= (const DeviceDriver &other)=delete |
| DeviceDriver & | operator= (DeviceDriver &&other) noexcept=delete |
| virtual | ~DeviceDriver () |
| virtual std::string | id () const |
| Return the id assigned to the PolyDriver. | |
| virtual void | setId (const std::string &id) |
| Set the id for this device. | |
| template<class T > | |
| bool | view (T *&x) |
| Get an interface to the device driver. | |
| virtual DeviceDriver * | getImplementation () |
| Some drivers are bureaucrats, pointing at others. | |
Additional Inherited Members | |
Public Types inherited from yarp::dev::IJoypadController | |
| enum class | JoypadCtrl_coordinateMode { JypCtrlcoord_POLAR = 0 , JypCtrlcoord_CARTESIAN = 1 } |
SDLJoypad: Device that reads inputs of Joypads compatible with the SDL library.
Parameters accepted in the config argument of the open method:
| Parameter name | Type | Units | Default Value | Required | Description | Notes |
|---|---|---|---|---|---|---|
| UseAllJoypadAsOne | string | if there are more than one joypad connected | merge together multiple joypad | set it to 1 to have all the connected joypad as one | ||
| DefaultJoystickNumber | string | will be asked | No | select the id of the joypad to use | important if there are more than one joypad and UseAllJoypadAsOne is set to 0. if not present, a input will be requested to the user | |
| sticks | int | Yes | count of sticks to configure | for each stick there must be a group called STICK<id here> with data on the axis to be configured as stickl | ||
| STICK[ID] | group | depending on 'sticks' parameter | group containing axes data for this stick | |||
| axes | int | yes | axes count for this stick | set it for each stick in the proper stick group | ||
| axis[ID]_id | int | depending on axes parameter | axis id for current stick related axis | set it for each stick in the proper stick group | ||
| invert_axis_[ID] | bool | false | no | invert the current axis | set it for each stick in the proper stick group | |
| deadZone | double | 0.0 | yes | set the deadzone for this stick | set it for each stick in the proper stick group |
Definition at line 61 of file SDLJoypad.h.
|
default |
|
virtualdefault |
|
overridevirtual |
Close the DeviceDriver.
Reimplemented from yarp::dev::DeviceDriver.
Definition at line 249 of file SDLJoypad.cpp.
|
overridevirtual |
Get the value of an axis if present, return false otherwise.
| axis_id | Id of the axis to get. must be > -1 && < getAxisCount(), return false otherwise. |
| value | reference to be valued. the absolute boundaries for the values should be -1.0 and 1.0 However the actual range depends on the physical device (example: analog trigger does not have a central position thus can give a value from 0.0 to 0.1). |
Implements yarp::dev::IJoypadController.
Definition at line 349 of file SDLJoypad.cpp.
|
overridevirtual |
Get number of axes.
| axes_count | unsigned int reference that will contain the result. |
Implements yarp::dev::IJoypadController.
Definition at line 254 of file SDLJoypad.cpp.
|
overridevirtual |
Get the value of a button.
From 0-unpressed to 1-fullpressed and values in the middle in the analog-face-button case.
| button_id | Id of the button to get. Must be > -1 && < getButtonCount(), return false otherwise |
| value | reference to be valued. The value will be from 0.0 (not even touched) to 1.0 (fully pressed) |
Implements yarp::dev::IJoypadController.
Definition at line 290 of file SDLJoypad.cpp.
|
overridevirtual |
Get number of buttons.
| button_count | unsigned int reference that will contain the result. |
Implements yarp::dev::IJoypadController.
Definition at line 260 of file SDLJoypad.cpp.
|
overridevirtual |
Get the value of an Hat.
| hat_id | Id of the POV hat to get. Must be > -1 && < getHatCount(), return false otherwise. |
| value | reference to be valued. use the YRPJOY_HAT_ macro series to get the currently pressed directions. |
Implements yarp::dev::IJoypadController.
Definition at line 408 of file SDLJoypad.cpp.
|
overridevirtual |
Get number of hats.
| Hat_count | unsigned int reference that will contain the result. |
Implements yarp::dev::IJoypadController.
Definition at line 272 of file SDLJoypad.cpp.
|
overridevirtual |
Get the value of a stick if present, return false otherwise.
| stick_id | Id of the stick to get. must be > -1 && < getStickCount(), return false otherwise. |
| value | a vector that will contain the joystick position. the size of the vector will give you the Number of degrees of freedom and the value will be from -1.0 to 1.0. |
| coordinate_mode | to get data in cartesian mode or polar mode. |
Implements yarp::dev::IJoypadController.
Definition at line 369 of file SDLJoypad.cpp.
|
overridevirtual |
Get the number of the sticks.
| stick_count | unsigned int reference that will contain the result. |
Implements yarp::dev::IJoypadController.
Definition at line 284 of file SDLJoypad.cpp.
|
overridevirtual |
Get the value of a touch if present, return false otherwise.
| value | a vector that will contain the touch values normalized from 0.0 to 1.0. |
Implements yarp::dev::IJoypadController.
Definition at line 403 of file SDLJoypad.cpp.
|
overridevirtual |
Get the number of touch surface.
Multiple touch surface can represent either multiple physical monotouch surface or a multitouch surface or a combination of the two.
| touch_count | unsigned int reference that will contain the result. |
Implements yarp::dev::IJoypadController.
Definition at line 278 of file SDLJoypad.cpp.
|
overridevirtual |
Get the axes change of a Trackball.
| trackball_id | Id of the Trackball to get. Must be > -1 && < getTrackballCount(), return false otherwise. |
| value | reference to be valued. the value will be from 0.0 (not moving) to 1.0 (full velocity). |
Implements yarp::dev::IJoypadController.
Definition at line 434 of file SDLJoypad.cpp.
|
overridevirtual |
Get number of trackballs.
| Trackball_count | unsigned int reference that will contain the result. |
Implements yarp::dev::IJoypadController.
Definition at line 266 of file SDLJoypad.cpp.
|
overridevirtual |
Open the DeviceDriver.
| config | is a list of parameters for the device. Which parameters are effective for your device can vary. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device). |
Reimplemented from yarp::dev::DeviceDriver.
Definition at line 30 of file SDLJoypad.cpp.