#include <yarp/dev/IJoypadController.h>

Inheritance diagram for yarp::dev::IJoypadController:

Public Types
enum	JoypadCtrl_coordinateMode { JypCtrlcoord_POLAR = 0 , JypCtrlcoord_CARTESIAN = 1 }

Public Member Functions
virtual	~IJoypadController ()=default
	Destructor.

virtual bool	eventDriven (bool enable, yarp::dev::IJoypadEvent *event=nullptr)
	Activate event Driven mode.

virtual bool	isEventDriven ()

virtual bool	getAxisCount (unsigned int &axis_count)=0
	Get number of axes.

virtual bool	getButtonCount (unsigned int &button_count)=0
	Get number of buttons.

virtual bool	getTrackballCount (unsigned int &Trackball_count)=0
	Get number of trackballs.

virtual bool	getHatCount (unsigned int &Hat_count)=0
	Get number of hats.

virtual bool	getTouchSurfaceCount (unsigned int &touch_count)=0
	Get the number of touch surface.

virtual bool	getStickCount (unsigned int &stick_count)=0
	Get the number of the sticks.

virtual bool	getStickDoF (unsigned int stick_id, unsigned int &DoF)=0
	Get the Degree Of Freedom count for desired stick.

virtual bool	getButton (unsigned int button_id, float &value)=0
	Get the value of a button.

virtual bool	getTrackball (unsigned int trackball_id, yarp::sig::Vector &value)=0
	Get the axes change of a Trackball.

virtual bool	getHat (unsigned int hat_id, unsigned char &value)=0
	Get the value of an Hat.

virtual bool	getAxis (unsigned int axis_id, double &value)=0
	Get the value of an axis if present, return false otherwise.

virtual bool	getStick (unsigned int stick_id, yarp::sig::Vector &value, JoypadCtrl_coordinateMode coordinate_mode)=0
	Get the value of a stick if present, return false otherwise.

virtual bool	getTouch (unsigned int touch_id, yarp::sig::Vector &value)=0
	Get the value of a touch if present, return false otherwise.

Protected Member Functions
virtual bool	parseActions (const yarp::os::Searchable &cfg, int *count=nullptr)

virtual bool	executeAction (int action_id)

Protected Attributes
std::map< int, std::string >	m_actions

Detailed Description

Definition at line 27 of file IJoypadController.h.

Member Enumeration Documentation

◆ JoypadCtrl_coordinateMode

enum yarp::dev::IJoypadController::JoypadCtrl_coordinateMode

Enumerator
JypCtrlcoord_POLAR
JypCtrlcoord_CARTESIAN

Definition at line 30 of file IJoypadController.h.

Constructor & Destructor Documentation

◆ ~IJoypadController()

virtual yarp::dev::IJoypadController::~IJoypadController ( )

virtualdefault

Destructor.

Member Function Documentation

◆ eventDriven()

virtual bool yarp::dev::IJoypadController::eventDriven	(	bool	enable,
		yarp::dev::IJoypadEvent *	event = `nullptr`
	)

inlinevirtual

Activate event Driven mode.

Parameters

enable	a bool to turn on or off the eventDriven mode.
event	a pointer to a valid yarp::dev::IJoypadEvent object whom action() method will be called on event detection.

Returns: true if succeeded. false otherwise.

Reimplemented in yarp::dev::IJoypadEventDriven.

Definition at line 52 of file IJoypadController.h.

◆ executeAction()

bool yarp::dev::IJoypadController::executeAction ( int action_id )

protectedvirtual

Reimplemented in yarp::dev::IJoypadEventDriven.

Definition at line 391 of file IJoypadController.cpp.

◆ getAxis()

virtual bool yarp::dev::IJoypadController::getAxis	(	unsigned int	axis_id,
		double &	value
	)

pure virtual

Get the value of an axis if present, return false otherwise.

Parameters

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).

Returns: true if succeeded, false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getAxisCount()

virtual bool yarp::dev::IJoypadController::getAxisCount ( unsigned int & axis_count )

pure virtual

Get number of axes.

Parameters

axes_count unsigned int reference that will contain the result.

Returns: true if succeeded. false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getButton()

virtual bool yarp::dev::IJoypadController::getButton	(	unsigned int	button_id,
		float &	value
	)

pure virtual

Get the value of a button.

From 0-unpressed to 1-fullpressed and values in the middle in the analog-face-button case.

Parameters

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)

Returns: true if succeeded, false otherwise

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getButtonCount()

virtual bool yarp::dev::IJoypadController::getButtonCount ( unsigned int & button_count )

pure virtual

Get number of buttons.

Parameters

button_count unsigned int reference that will contain the result.

Returns: true if succeeded. false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getHat()

virtual bool yarp::dev::IJoypadController::getHat	(	unsigned int	hat_id,
		unsigned char &	value
	)

pure virtual

Get the value of an Hat.

Parameters

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.

Returns: true if succeeded, false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getHatCount()

virtual bool yarp::dev::IJoypadController::getHatCount ( unsigned int & Hat_count )

pure virtual

Get number of hats.

Parameters

Hat_count unsigned int reference that will contain the result.

Returns: true if succeeded. false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getStick()

virtual bool yarp::dev::IJoypadController::getStick	(	unsigned int	stick_id,
		yarp::sig::Vector &	value,
		JoypadCtrl_coordinateMode	coordinate_mode
	)

pure virtual

Get the value of a stick if present, return false otherwise.

Parameters

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 (spheric in 3 dof position cases) mode.

Returns: true if succeeded, false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getStickCount()

virtual bool yarp::dev::IJoypadController::getStickCount ( unsigned int & stick_count )

pure virtual

Get the number of the sticks.

Parameters

stick_count unsigned int reference that will contain the result.

Returns: bool if succeeded, false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getStickDoF()

virtual bool yarp::dev::IJoypadController::getStickDoF	(	unsigned int	stick_id,
		unsigned int &	DoF
	)

pure virtual

Get the Degree Of Freedom count for desired stick.

Parameters

stick_id	Id of the stick. must be > -1 && < getStickCount(), return false otherwise.
DoF	an unsigned int reference that will contain the value.

Returns: true if succeeded, false otherwise

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getTouch()

virtual bool yarp::dev::IJoypadController::getTouch	(	unsigned int	touch_id,
		yarp::sig::Vector &	value
	)

pure virtual

Get the value of a touch if present, return false otherwise.

Parameters

value a vector that will contain the touch values normalized from 0.0 to 1.0.

Returns: true if succeeded, false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getTouchSurfaceCount()

virtual bool yarp::dev::IJoypadController::getTouchSurfaceCount ( unsigned int & touch_count )

pure virtual

Get the number of touch surface.

Multiple touch surface can rappresent either multiple physical monotouch surface or a multitouch surface or a combination of the two.

Parameters

touch_count unsigned int reference that will contain the result.

Returns: true if succeeded. false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getTrackball()

virtual bool yarp::dev::IJoypadController::getTrackball	(	unsigned int	trackball_id,
		yarp::sig::Vector &	value
	)

pure virtual

Get the axes change of a Trackball.

Parameters

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).

Returns: true if succeeded, false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ getTrackballCount()

virtual bool yarp::dev::IJoypadController::getTrackballCount ( unsigned int & Trackball_count )

pure virtual

Get number of trackballs.

Parameters

Trackball_count unsigned int reference that will contain the result.

Returns: true if succeeded. false otherwise.

Implemented in yarp::dev::OVRHeadset, and yarp::dev::IJoypadEventDriven.

◆ isEventDriven()

virtual bool yarp::dev::IJoypadController::isEventDriven ( )

inlinevirtual

Reimplemented in yarp::dev::IJoypadEventDriven.

Definition at line 53 of file IJoypadController.h.

◆ parseActions()

bool yarp::dev::IJoypadController::parseActions	(	const yarp::os::Searchable &	cfg,
		int *	count = `nullptr`
	)

protectedvirtual

Reimplemented in yarp::dev::IJoypadEventDriven.

Definition at line 407 of file IJoypadController.cpp.

Member Data Documentation

◆ m_actions

std::map<int, std::string> yarp::dev::IJoypadController::m_actions

protected

Definition at line 33 of file IJoypadController.h.

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

src/libYARP_dev/src/yarp/dev/IJoypadController.h
src/libYARP_dev/src/yarp/dev/IJoypadController.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ JoypadCtrl_coordinateMode

Constructor & Destructor Documentation

◆ ~IJoypadController()

Member Function Documentation

◆ eventDriven()

◆ executeAction()

◆ getAxis()

◆ getAxisCount()

◆ getButton()

◆ getButtonCount()

◆ getHat()

◆ getHatCount()

◆ getStick()

◆ getStickCount()

◆ getStickDoF()

◆ getTouch()

◆ getTouchSurfaceCount()

◆ getTrackball()

◆ getTrackballCount()

◆ isEventDriven()

◆ parseActions()

Member Data Documentation

◆ m_actions