OSDL::Events::ClassicalJoystick

OSDL::Events::ClassicalJoystick Class Reference

#include <OSDLClassicalJoystick.h>

Inheritance diagram for OSDL::Events::ClassicalJoystick:

[legend]
Collaboration diagram for OSDL::Events::ClassicalJoystick:
[legend]
List of all members.

Detailed Description

Models a classical joystick, with simplified access to the two main axes, commonly used to indicate the joystick current direction, with customizable deadzone support and two buttons directly managed.

This simplifies the task of the any controller being linked to this joystick.

Note:
Only the two first axes have a deadzone managed, since they usually correspond to the actual stick. Further axes are often dedicated to throttle, which do not need any deadzone at all for most applications.

Controllers should be linked to at most one Classical joystick, since the joystick index is not propagated.

Definition at line 40 of file OSDLClassicalJoystick.h.

Public Member Functions

 ClassicalJoystick (JoystickNumber index, AxisPosition deadZoneExtent=DefaultDeadZoneExtent) throw ()
 Constructs a new joystick handler.
virtual ~ClassicalJoystick () throw ()
 Virtual destructor, closing corresponding joystick device.
virtual void getDeadZoneValues (AxisPosition &firstAxisExtent, AxisPosition &secondAxisExtent) const throw ()
 Returns the deadzone extent for the two first axes.
virtual void setDeadZoneValues (AxisPosition firstAxisExtent=DefaultDeadZoneExtent, AxisPosition secondAxisExtent=DefaultDeadZoneExtent) throw ()
 Sets the deadzone values for the two first axes.
virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const throw ()
 Returns an user-friendly description of the state of this object.
virtual const std::string & getName () const throw ()
 Returns the implementation dependent name of this joystick.
virtual bool isOpen () const throw ()
 Tells whether this joystick is currently opened.
virtual void open () throw ( JoystickException )
 Opens the joystick, so that it can be used.
virtual void close () throw ( JoystickException )
 Closes the joystick.
virtual JoystickAxesCount getNumberOfAxes () const throw ()
 Returns the number of joystick axes.
virtual JoystickTrackballsCount getNumberOfTrackballs () const throw ()
 Returns the number of joystick trackballs.
virtual JoystickHatsCount getNumberOfHats () const throw ()
 Returns the number of joystick hats.
virtual JoystickButtonsCount getNumberOfButtons () const throw ()
 Returns the number of joystick buttons.
virtual AxisPosition getAbscissaPosition () const throw ()
 Returns the absolute position of the X axis.
virtual AxisPosition getOrdinatePosition () const throw ()
 Returns the absolute position of the Y axis.
virtual AxisPosition getPositionOfAxis (JoystickAxesCount index) const throw ( JoystickException )
 Returns the absolute position of the specified axis.
virtual HatPosition getPositionOfHat (JoystickHatsCount index) const throw ( JoystickException )
 Returns the absolute position of the specified hat.
virtual bool isButtonPressed (JoystickButtonsCount buttonNumber) const throw ( JoystickException )
 Tells whether specified joystick button is pressed.
virtual bool getPositionOfTrackball (JoystickTrackballsCount ball, BallMotion &deltaX, BallMotion &deltaY) const throw ( JoystickException )
 Returns the relative position of the specified trackball.
virtual void update () throw ()
 Updates the description of this joystick (trackballs, hats, buttons, etc.
virtual OSDL::MVC::Controller & getActualController () const throw ( EventsException )
 Returns the actual (OSDL) controller this input device should be linked to.

Static Public Attributes

static const AxisPosition DefaultDeadZoneExtent

Protected Member Functions

virtual void axisChanged (const JoystickAxisEvent &joystickEvent) throw ()
 Called whenever an axis of this joystick changed, and notify the linked controller, if any.
virtual void buttonPressed (const JoystickButtonEvent &joystickEvent) throw ()
 Called whenever a button of this joystick was pressed, and notify the linked controller, if any.
virtual void buttonReleased (const JoystickButtonEvent &joystickEvent) throw ()
 Called whenever a button of this joystick was released, and notify the linked controller, if any.
virtual JoystickNumber getIndex () const throw ()
 Returns the index of this joystick in the platform list.
virtual void trackballChanged (const JoystickTrackballEvent &joystickEvent) throw ()
 Called whenever a trackball of this joystick changed, and notifies the linked controller, if any.
virtual void hatChanged (const JoystickHatEvent &joystickEvent) throw ()
 Called whenever a hat of this joystick changed, and notifies the linked controller, if any.

Protected Attributes

AxisPosition _deadZoneExtentFirstAxis
 Stores the dead zone extent for first axis.
AxisPosition _deadZoneExtentSecondAxis
 Stores the dead zone extent for first axis.
std::string _name
 The implementation dependent name of this joystick, if any.
JoystickNumber _index
 The number of this joystick in platform list.
RawJoystick * _internalJoystick
 The internal raw joystick being used.
JoystickAxesCount _axisCount
 The number of axes for this joystick.
JoystickTrackballsCount _trackballCount
 The number of trackballs for this joystick.
JoystickHatsCount _hatCount
 The number of hats for this joystick.
JoystickButtonsCount _buttonCount
 The number of buttons for this joystick.

Private Member Functions

 ClassicalJoystick (const Joystick &source) throw ()
 Copy constructor made private to ensure that it will never be called.
ClassicalJoystick & operator= (const Joystick &source) throw ()
 Assignment operator made private to ensure that it will never be called.

Friends

class OSDL::Events::JoystickHandler

Constructor & Destructor Documentation

ClassicalJoystick::ClassicalJoystick ( JoystickNumber  index,
AxisPosition  deadZoneExtent = DefaultDeadZoneExtent 
) throw () [explicit]

Constructs a new joystick handler.

Parameters:
index the index of this joystick in platform list.

Definition at line 44 of file OSDLClassicalJoystick.cc.

ClassicalJoystick::~ClassicalJoystick (  )  throw () [virtual]

Virtual destructor, closing corresponding joystick device.

Definition at line 54 of file OSDLClassicalJoystick.cc.

OSDL::Events::ClassicalJoystick::ClassicalJoystick ( const Joystick &  source  )  throw () [explicit, private]

Copy constructor made private to ensure that it will never be called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.

Member Function Documentation

void ClassicalJoystick::getDeadZoneValues ( AxisPosition &  firstAxisExtent,
AxisPosition &  secondAxisExtent 
) const throw () [virtual]

Returns the deadzone extent for the two first axes.

Parameters:
firstAxisExtent will be set to the extent for the first axis.
secondAxisExtent will be set to the extent for the second axis.

Definition at line 60 of file OSDLClassicalJoystick.cc.

void ClassicalJoystick::setDeadZoneValues ( AxisPosition  firstAxisExtent = DefaultDeadZoneExtent,
AxisPosition  secondAxisExtent = DefaultDeadZoneExtent 
) throw () [virtual]

Sets the deadzone values for the two first axes.

Parameters:
firstAxisExtent the extent of the deadzone for the first axis.
secondAxisExtent the extent of the deadzone for the second axis.

Definition at line 70 of file OSDLClassicalJoystick.cc.

const string ClassicalJoystick::toString ( Ceylan::VerbosityLevels  level = Ceylan::high  )  const throw () [virtual]

Returns an user-friendly description of the state of this object.

Parameters:
level the requested verbosity level.
Note:
Text output format is determined from overall settings.
See also:
Ceylan::TextDisplayable

Reimplemented from OSDL::Events::Joystick.

Definition at line 80 of file OSDLClassicalJoystick.cc.

References OSDL::Video::Pixels::toString().

void ClassicalJoystick::axisChanged ( const JoystickAxisEvent &  joystickEvent  )  throw () [protected, virtual]

Called whenever an axis of this joystick changed, and notify the linked controller, if any.

Parameters:
joystickEvent the corresponding joystick event.
Note:
Expected to be triggered by the Joystick handler.

Reimplemented from OSDL::Events::Joystick.

Definition at line 98 of file OSDLClassicalJoystick.cc.

References OSDL::Events::EventsModule::DescribeEvent(), and OSDL_JOYSTICK_LOG.

void ClassicalJoystick::buttonPressed ( const JoystickButtonEvent &  joystickEvent  )  throw () [protected, virtual]

Called whenever a button of this joystick was pressed, and notify the linked controller, if any.

Parameters:
joystickEvent the corresponding joystick event.
Note:
Expected to be triggered by the Joystick handler.

Reimplemented from OSDL::Events::Joystick.

Definition at line 151 of file OSDLClassicalJoystick.cc.

References OSDL::Events::EventsModule::DescribeEvent(), and OSDL_JOYSTICK_LOG.

void ClassicalJoystick::buttonReleased ( const JoystickButtonEvent &  joystickEvent  )  throw () [protected, virtual]

Called whenever a button of this joystick was released, and notify the linked controller, if any.

Parameters:
joystickEvent the corresponding joystick event.
Note:
Expected to be triggered by the Joystick handler.

Reimplemented from OSDL::Events::Joystick.

Definition at line 192 of file OSDLClassicalJoystick.cc.

References OSDL::Events::EventsModule::DescribeEvent(), and OSDL_JOYSTICK_LOG.

ClassicalJoystick& OSDL::Events::ClassicalJoystick::operator= ( const Joystick &  source  )  throw () [private]

Assignment operator made private to ensure that it will never be called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

Reimplemented from OSDL::Events::Joystick.

const string & Joystick::getName (  )  const throw () [virtual, inherited]

Returns the implementation dependent name of this joystick.

Definition at line 78 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_name.

bool Joystick::isOpen (  )  const throw () [virtual, inherited]

Tells whether this joystick is currently opened.

Note:
A joystick must be opened before being used.

Definition at line 84 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_index, OSDL::Events::Joystick::_internalJoystick, and OSDL::Video::Pixels::toString().

Referenced by OSDL::Events::Joystick::close(), OSDL::Events::Joystick::getAbscissaPosition(), OSDL::Events::Joystick::getNumberOfAxes(), OSDL::Events::Joystick::getNumberOfButtons(), OSDL::Events::Joystick::getNumberOfHats(), OSDL::Events::Joystick::getNumberOfTrackballs(), OSDL::Events::Joystick::getOrdinatePosition(), OSDL::Events::Joystick::open(), and OSDL::Events::Joystick::~Joystick().

void Joystick::open (  )  throw ( JoystickException ) [virtual, inherited]

Opens the joystick, so that it can be used.

Exceptions:
JoystickException if the joystick was already open.

Definition at line 103 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_index, OSDL::Events::Joystick::_internalJoystick, OSDL::Events::Joystick::isOpen(), and OSDL::Events::Joystick::update().

void Joystick::close (  )  throw ( JoystickException ) [virtual, inherited]

Closes the joystick.

Exceptions:
JoystickException if the joystick was not open.

Definition at line 117 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_internalJoystick, and OSDL::Events::Joystick::isOpen().

Referenced by OSDL::Events::Joystick::~Joystick().

JoystickAxesCount Joystick::getNumberOfAxes (  )  const throw () [virtual, inherited]

Returns the number of joystick axes.

Note:
The joystick must already have been opened.

Definition at line 210 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_axisCount, and OSDL::Events::Joystick::isOpen().

JoystickTrackballsCount Joystick::getNumberOfTrackballs (  )  const throw () [virtual, inherited]

Returns the number of joystick trackballs.

Note:
The joystick must already have been opened.

Definition at line 224 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_trackballCount, and OSDL::Events::Joystick::isOpen().

JoystickHatsCount Joystick::getNumberOfHats (  )  const throw () [virtual, inherited]

Returns the number of joystick hats.

Note:
The joystick must already have been opened.

Definition at line 238 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_hatCount, and OSDL::Events::Joystick::isOpen().

JoystickButtonsCount Joystick::getNumberOfButtons (  )  const throw () [virtual, inherited]

Returns the number of joystick buttons.

Note:
The joystick must already have been opened.

Definition at line 252 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_buttonCount, and OSDL::Events::Joystick::isOpen().

AxisPosition Joystick::getAbscissaPosition (  )  const throw () [virtual, inherited]

Returns the absolute position of the X axis.

Note:
On most modern joysticks the X axis is represented by axis 0, which is the axis that is used by this method.

Joystick must be already open.

Definition at line 266 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_axisCount, OSDL::Events::Joystick::_internalJoystick, and OSDL::Events::Joystick::isOpen().

AxisPosition Joystick::getOrdinatePosition (  )  const throw () [virtual, inherited]

Returns the absolute position of the Y axis.

Note:
On most modern joysticks the Y axis is represented by axis 1, which is the axis that is used by this method.

Joystick must be already open.

Definition at line 285 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_axisCount, OSDL::Events::Joystick::_internalJoystick, and OSDL::Events::Joystick::isOpen().

AxisPosition Joystick::getPositionOfAxis ( JoystickAxesCount  index  )  const throw ( JoystickException ) [virtual, inherited]

Returns the absolute position of the specified axis.

Parameters:
index the index of the axis for this joystick.
Returns:
the axis position.
Exceptions:
JoystickException if the joystick is not already opened or if index is out of bounds.

Definition at line 304 of file OSDLJoystick.cc.

References OSDL::Video::Pixels::toString().

HatPosition Joystick::getPositionOfHat ( JoystickHatsCount  index  )  const throw ( JoystickException ) [virtual, inherited]

Returns the absolute position of the specified hat.

Parameters:
index the index of the hat for this joystick.
Returns:
the hat position.
Exceptions:
JoystickException if the joystick is not already open or if index is out of bounds.

Definition at line 321 of file OSDLJoystick.cc.

References OSDL::Video::Pixels::toString().

bool Joystick::isButtonPressed ( JoystickButtonsCount  buttonNumber  )  const throw ( JoystickException ) [virtual, inherited]

Tells whether specified joystick button is pressed.

Parameters:
buttonNumber the number of the button for this joystick.
Returns:
true iff the button is currently pressed.
Exceptions:
JoystickException if the joystick is not already open or if the button number is out of bounds.

Definition at line 338 of file OSDLJoystick.cc.

References OSDL::Video::Pixels::toString().

bool Joystick::getPositionOfTrackball ( JoystickTrackballsCount  ball,
BallMotion &  deltaX,
BallMotion &  deltaY 
) const throw ( JoystickException ) [virtual, inherited]

Returns the relative position of the specified trackball.

Parameters:
ball the number of the ball for this joystick.
deltaX the abscissa motion delta, since last call to this method, will be stored here.
deltaY the ordinate motion delta, since last call to this method, will be stored here.
Returns:
true iff the operation succeeded.
Exceptions:
JoystickException if the joystick is not already open or if index is out of bounds.
Note:
Trackballs can only return relative motion since the last call of this method.

Definition at line 355 of file OSDLJoystick.cc.

References OSDL::Video::Pixels::toString().

void Joystick::update (  )  throw () [virtual, inherited]

Updates the description of this joystick (trackballs, hats, buttons, etc.

)

Note:
The joystick must be open.

Definition at line 399 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_axisCount, OSDL::Events::Joystick::_buttonCount, OSDL::Events::Joystick::_hatCount, OSDL::Events::Joystick::_internalJoystick, and OSDL::Events::Joystick::_trackballCount.

Referenced by OSDL::Events::Joystick::open().

JoystickNumber Joystick::getIndex (  )  const throw () [protected, virtual, inherited]

Returns the index of this joystick in the platform list.

Note:
Should be useless.

Definition at line 374 of file OSDLJoystick.cc.

References OSDL::Events::Joystick::_index, OSDL::Events::Joystick::_internalJoystick, and OSDL::Video::Pixels::toString().

void Joystick::trackballChanged ( const JoystickTrackballEvent &  joystickEvent  )  throw () [protected, virtual, inherited]

Called whenever a trackball of this joystick changed, and notifies the linked controller, if any.

Parameters:
joystickEvent the corresponding joystick event.
Note:
Expected to be triggered by the Joystick handler.

Definition at line 147 of file OSDLJoystick.cc.

References OSDL::Events::EventsModule::DescribeEvent(), and OSDL_JOYSTICK_LOG.

void Joystick::hatChanged ( const JoystickHatEvent &  joystickEvent  )  throw () [protected, virtual, inherited]

Called whenever a hat of this joystick changed, and notifies the linked controller, if any.

Parameters:
joystickEvent the corresponding joystick event.
Note:
Expected to be triggered by the Joystick handler.

Definition at line 163 of file OSDLJoystick.cc.

References OSDL::Events::EventsModule::DescribeEvent(), and OSDL_JOYSTICK_LOG.

OSDL::MVC::Controller & InputDevice::getActualController (  )  const throw ( EventsException ) [virtual, inherited]

Returns the actual (OSDL) controller this input device should be linked to.

Exceptions:
EventException if this input device is not linked to any controller, or if the controller is not an OSDL one.
See also:
isLinkedToController

Definition at line 33 of file OSDLInputDevice.cc.

Friends And Related Function Documentation

friend class OSDL::Events::JoystickHandler [friend]

Reimplemented from OSDL::Events::Joystick.

Definition at line 49 of file OSDLClassicalJoystick.h.

Member Data Documentation

const AxisPosition ClassicalJoystick::DefaultDeadZoneExtent [static]

Definition at line 121 of file OSDLClassicalJoystick.h.

AxisPosition OSDL::Events::ClassicalJoystick::_deadZoneExtentFirstAxis [protected]

Stores the dead zone extent for first axis.

If d is the dead zone value, then a reported joystick axis value in :

Definition at line 188 of file OSDLClassicalJoystick.h.

AxisPosition OSDL::Events::ClassicalJoystick::_deadZoneExtentSecondAxis [protected]

Stores the dead zone extent for first axis.

If d is the dead zone value, then a reported joystick axis value in :

Definition at line 202 of file OSDLClassicalJoystick.h.

std::string OSDL::Events::Joystick::_name [protected, inherited]

The implementation dependent name of this joystick, if any.

Definition at line 370 of file OSDLJoystick.h.

Referenced by OSDL::Events::Joystick::getName().

JoystickNumber OSDL::Events::Joystick::_index [protected, inherited]

The number of this joystick in platform list.

Definition at line 374 of file OSDLJoystick.h.

Referenced by OSDL::Events::Joystick::getIndex(), OSDL::Events::Joystick::isOpen(), and OSDL::Events::Joystick::open().

RawJoystick* OSDL::Events::Joystick::_internalJoystick [protected, inherited]

The internal raw joystick being used.

Definition at line 378 of file OSDLJoystick.h.

Referenced by OSDL::Events::Joystick::close(), OSDL::Events::Joystick::getAbscissaPosition(), OSDL::Events::Joystick::getIndex(), OSDL::Events::Joystick::getOrdinatePosition(), OSDL::Events::Joystick::isOpen(), OSDL::Events::Joystick::open(), and OSDL::Events::Joystick::update().

JoystickAxesCount OSDL::Events::Joystick::_axisCount [protected, inherited]

The number of axes for this joystick.

Definition at line 382 of file OSDLJoystick.h.

Referenced by OSDL::Events::Joystick::getAbscissaPosition(), OSDL::Events::Joystick::getNumberOfAxes(), OSDL::Events::Joystick::getOrdinatePosition(), and OSDL::Events::Joystick::update().

JoystickTrackballsCount OSDL::Events::Joystick::_trackballCount [protected, inherited]

The number of trackballs for this joystick.

Definition at line 386 of file OSDLJoystick.h.

Referenced by OSDL::Events::Joystick::getNumberOfTrackballs(), and OSDL::Events::Joystick::update().

JoystickHatsCount OSDL::Events::Joystick::_hatCount [protected, inherited]

The number of hats for this joystick.

Definition at line 390 of file OSDLJoystick.h.

Referenced by OSDL::Events::Joystick::getNumberOfHats(), and OSDL::Events::Joystick::update().

JoystickButtonsCount OSDL::Events::Joystick::_buttonCount [protected, inherited]

The number of buttons for this joystick.

Definition at line 394 of file OSDLJoystick.h.

Referenced by OSDL::Events::Joystick::getNumberOfButtons(), and OSDL::Events::Joystick::update().

The documentation for this class was generated from the following files:
Generated on Fri Mar 30 14:47:26 2007 for OSDL by  doxygen 1.5.1