nom::JoystickEventHandler Class Reference

Internal management of hot-pluggable joystick devices handling. More...

#include <JoystickEventHandler.hpp>

Public Member Functions
nom::size_type	num_joysticks () const
	Get the number of accessible joysticks.
Joystick *	joystick (JoystickID dev_id) const
bool	joystick_exists (JoystickID dev_id)
	Query for the existence of an attached joystick.
Joystick *	add_joystick (JoystickIndex device_index)
	Append a game controller to the active devices pool.
bool	remove_joystick (JoystickID dev_id)
	Remove a connected joystick from the joystick event pool.

Private Types
typedef std::map< JoystickID, std::unique_ptr< Joystick > >	joysticks

Private Attributes
joysticks	joysticks_
	Active joysticks event pool.

Detailed Description

Internal management of hot-pluggable joystick devices handling.

Definition at line 44 of file JoystickEventHandler.hpp.

Member Typedef Documentation

joysticks

typedef std::map<JoystickID, std::unique_ptr<Joystick> > nom::JoystickEventHandler::joysticks

private

Definition at line 75 of file JoystickEventHandler.hpp.

Member Function Documentation

add_joystick()

Joystick * nom::JoystickEventHandler::add_joystick

(

JoystickIndex

device_index

)

Append a game controller to the active devices pool.

Returns

A non-owned pointer to the game controller device on success, or NULL on failure, such as when the device can not be opened.

joystick_exists()

bool nom::JoystickEventHandler::joystick_exists

(

JoystickID

dev_id

)

Query for the existence of an attached joystick.

Returns

Boolean TRUE when the joystick exists, and boolean FALSE when the joystick does not exist.

remove_joystick()

bool nom::JoystickEventHandler::remove_joystick

(

JoystickID

dev_id

)

Remove a connected joystick from the joystick event pool.

Returns

Boolean TRUE when the joystick exists, and boolean FALSE when the joystick does not exist.

Member Data Documentation

joysticks_

joysticks nom::JoystickEventHandler::joysticks_

private

Active joysticks event pool.

Remarks

This is a mapping of the current joysticks that are available to the end-user for use. Without this mapping, the end-user would be responsible for the management of each joystick's life-time; we must hold onto the device reference at the time of the SDL event, else we aren't able to use it beyond that frame – the same is true of removal events.

Definition at line 85 of file JoystickEventHandler.hpp.

---

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

• /home/jeff/Projects/nomlib.git/include/nomlib/system/JoystickEventHandler.hpp