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

#include <JoystickEvent.h>

Implements an event notifying changes about a directionnal hat on a device (like a joystick). More...

Detailed Description

Implements an event notifying changes about a directionnal hat on a device (like a joystick).

Public Member Functions
	HatEvent (const int, const State)
	Constructor. More...
virtual	~HatEvent ()
	Default destructor. More...

Accessors
int	getIndex () const
	Retrieves the index of the hat. More...
State	getState () const
	Retrieves the state of the hat. More...
virtual const char *	getClassName () const

Constructor details

HatEvent()

sofa::core::objectmodel::JoystickEvent::HatEvent::HatEvent	(	const int	index,
		const State	state
	)

Constructor.

Parameters

index	the hat's index
state	the hat's state

~HatEvent()

sofa::core::objectmodel::JoystickEvent::HatEvent::~HatEvent ( )

virtual

Default destructor.

Function details

getClassName()

virtual const char* sofa::core::objectmodel::JoystickEvent::HatEvent::getClassName ( ) const

inlinevirtual

getIndex()

int sofa::core::objectmodel::JoystickEvent::HatEvent::getIndex

(

)

const

Retrieves the index of the hat.

Returns

the hat's index

getState()

JoystickEvent::HatEvent::State sofa::core::objectmodel::JoystickEvent::HatEvent::getState

(

)

const

Retrieves the state of the hat.

Returns

the hat's state

Enum details

State

enum sofa::core::objectmodel::JoystickEvent::HatEvent::State

Defines possible hat states.

Enumerator
CENTERED
UP
RIGHT
DOWN
LEFT
UP_RIGHT
DOWN_RIGHT
DOWN_LEFT
UP_LEFT