NB: It's necessary to call an InputSystem instance's update() method in regular intervals. Devices, ActionMaps etc may have their own update() methods which are not automatically called. Take care!
InputDevice is the base class for all input devices.
The following devices are currently implemented: KeyboardDevice, MouseDevice, JoystickDevice. Each device supports specialized functionality to control their behaviour and/or access various information.
Devices are created by an instance of InputSystem. They have to be activated before they can be used.
A device dependant event generator generates common events for certain devices. For example, a KeyboardEventGenerator provides “key up” and “key down” events in the form of signals. A MouseEventGenerator on the other hand may provide signals for mouse cursor and mouse wheel movement as well as mouse button presses.
Device dependant event generators inherit from DeviceEventGenerator. Devices can be attached and detached from an event genreator at runtime. A generator has to be updated in regular intervals using its update() method.
The following device event generators have been implemented: KeyboardEventGenerator, MouseEventGenerator. The JoystickEventGenerator is WIP.
An ActionId uniquely identifies an action, for example, ACTIONID_FORWARD for moving an object… well, forward. Of course, while some of these ids are quite common, more often these kind of ids depend on the application.
An action condition is met when its bool operator() returns true.
Several commonly used input device dependent conditions are implemented in yake::input:
The ActionConditionFactory can be used for quickly creating various default conditions.
An ActionMap maps action conditions to action ids. When a condition is met, the action id for that condition triggers an event. Clients can subscribe to these events. See yake::input::ActionMap in the API docs for more details.