sofa::core::objectmodel::JoystickEvent Class Reference

JoystickEvent Class. More...

#include <JoystickEvent.h>

Inheritance diagram for sofa::core::objectmodel::JoystickEvent:

[legend]

Collaboration diagram for sofa::core::objectmodel::JoystickEvent:

[legend]

Data Structures
class	AxisEvent
	Implements an event that notifies about axis positions (like analog controls of a joystick). More...
class	ButtonEvent
	Implements the button event for joysticks. More...
class	HatEvent
	Implements an event notifiying changes about a directionnal hat on a device (like a joystick). More...
Public Member Functions
	JoystickEvent ()
	default constructor.
virtual	~JoystickEvent ()
	default destructor.
Axis
const AxisEvent *	getAxisEvent (const int) const
const std::vector< AxisEvent * > &	getAxisEvents (void) const
unsigned int	getAxisEventsSize (void) const
void	addAxisEvent (AxisEvent *)
Button
ButtonEvent *	getButtonEvent (void) const
bool	getButton (unsigned int) const
void	setButtonEvent (ButtonEvent *)
Hat
const HatEvent *	getHatEvent (const int) const
const std::vector< HatEvent * > &	getHatEvents (void) const
unsigned int	getHatEventsSize (void) const
void	addHatEvent (HatEvent *)
Protected Attributes
std::vector< AxisEvent * >	axisEvents
	State of the Analogic Pad.
ButtonEvent *	buttonEvent
	State of the Joystick Buttons.
std::vector< HatEvent * >	hatEvents
	State of the directional cross.

---

Detailed Description

JoystickEvent Class.

Definition at line 67 of file JoystickEvent.h.

---

Constructor & Destructor Documentation

sofa::core::objectmodel::JoystickEvent::JoystickEvent

(

)

default constructor.

Definition at line 138 of file JoystickEvent.cpp.

References buttonEvent.

sofa::core::objectmodel::JoystickEvent::~JoystickEvent

(

)

[virtual]

default destructor.

Definition at line 145 of file JoystickEvent.cpp.

References axisEvents, buttonEvent, and hatEvents.

---

Member Function Documentation

void sofa::core::objectmodel::JoystickEvent::addAxisEvent

(

JoystickEvent::AxisEvent *

aEvent

)

Definition at line 187 of file JoystickEvent.cpp.

References axisEvents.

void sofa::core::objectmodel::JoystickEvent::addHatEvent

(

JoystickEvent::HatEvent *

hEvent

)

Definition at line 247 of file JoystickEvent.cpp.

References hatEvents.

const JoystickEvent::AxisEvent * sofa::core::objectmodel::JoystickEvent::getAxisEvent

(

const int

index

)

const

Definition at line 158 of file JoystickEvent.cpp.

References axisEvents.

const std::vector< JoystickEvent::AxisEvent * > & sofa::core::objectmodel::JoystickEvent::getAxisEvents

(

void

)

const

Definition at line 173 of file JoystickEvent.cpp.

References axisEvents.

unsigned int sofa::core::objectmodel::JoystickEvent::getAxisEventsSize

(

void

)

const

Definition at line 180 of file JoystickEvent.cpp.

References axisEvents.

bool sofa::core::objectmodel::JoystickEvent::getButton

(

unsigned int

buttonIndex

)

const

Definition at line 201 of file JoystickEvent.cpp.

References sofa::core::objectmodel::JoystickEvent::ButtonEvent::getButton(), and getButtonEvent().

JoystickEvent::ButtonEvent * sofa::core::objectmodel::JoystickEvent::getButtonEvent

(

void

)

const

Definition at line 194 of file JoystickEvent.cpp.

References buttonEvent.

Referenced by getButton().

const JoystickEvent::HatEvent * sofa::core::objectmodel::JoystickEvent::getHatEvent

(

const int

index

)

const

Definition at line 218 of file JoystickEvent.cpp.

References hatEvents.

const std::vector< JoystickEvent::HatEvent * > & sofa::core::objectmodel::JoystickEvent::getHatEvents

(

void

)

const

Definition at line 233 of file JoystickEvent.cpp.

References hatEvents.

unsigned int sofa::core::objectmodel::JoystickEvent::getHatEventsSize

(

void

)

const

Definition at line 240 of file JoystickEvent.cpp.

References hatEvents.

void sofa::core::objectmodel::JoystickEvent::setButtonEvent

(

JoystickEvent::ButtonEvent *

bEvent

)

Definition at line 211 of file JoystickEvent.cpp.

References buttonEvent.

---

Field Documentation

std::vector< AxisEvent* > sofa::core::objectmodel::JoystickEvent::axisEvents [protected]

State of the Analogic Pad.

Definition at line 277 of file JoystickEvent.h.

Referenced by addAxisEvent(), getAxisEvent(), getAxisEvents(), getAxisEventsSize(), and ~JoystickEvent().

ButtonEvent* sofa::core::objectmodel::JoystickEvent::buttonEvent [protected]

State of the Joystick Buttons.

Definition at line 278 of file JoystickEvent.h.

Referenced by getButtonEvent(), JoystickEvent(), setButtonEvent(), and ~JoystickEvent().

std::vector< HatEvent* > sofa::core::objectmodel::JoystickEvent::hatEvents [protected]

State of the directional cross.

Definition at line 279 of file JoystickEvent.h.

Referenced by addHatEvent(), getHatEvent(), getHatEvents(), getHatEventsSize(), and ~JoystickEvent().

---

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

• framework/sofa/core/objectmodel/JoystickEvent.h
• framework/sofa/core/objectmodel/JoystickEvent.cpp