class InputDevice

Bases: TypedReferenceCount

This is a structure representing a single input device. Input devices may have zero or more buttons, pointers, or axes associated with them, and optionally a motion tracker.

These devices are brought under a common interface because there is such a large range of devices out there that may support any number of these types of axes, we couldn’t even begin to cover them with type-specific subclasses.

Use the various has_() and get_num_() methods to determine information about the device capabilities. For instance, has_keyboard() will give an indication that you can receive keystroke events from this device, and get_num_buttons() will tell you that the device may send button events.

There is the DeviceType enumeration, however, which will (if known) contain identification of the general category of devices this fits in, such as keyboard, mouse, gamepad, or flight stick.

New in version 1.10.0.

Inheritance diagram

Inheritance diagram of InputDevice

typedef pvector<InputDevice::AxisState> InputDevice::Axes

alias of pvector< AxisState >

enum Axis
enumerator none = 0
enumerator x = 1

Generic translational axes

enumerator y = 2
enumerator z = 3
enumerator yaw = 4

Generic rotational axes, used by joysticks and 3D mice

enumerator pitch = 5
enumerator roll = 6
enumerator left_x = 7


enumerator left_y = 8
enumerator left_trigger = 9
enumerator right_x = 10
enumerator right_y = 11
enumerator right_trigger = 12
enumerator throttle = 13

Flight stick specific

enumerator rudder = 14

When available separately from yaw

enumerator wheel = 15

Steering wheel / pedals

enumerator accelerator = 16
enumerator brake = 17
enumerator pressure = 18

Pen pressure

class AxisState
AxisState(InputDevice::AxisState const&) = default
class BatteryData
BatteryData(void) = default
BatteryData(InputDevice::BatteryData const&) = default
class ButtonState
ButtonState(InputDevice::ButtonState const&) = default
typedef pvector<InputDevice::ButtonState> InputDevice::Buttons

alias of pvector< ButtonState >

enum DeviceClass

This enum contains information that can be used to identify the type of input device.

enumerator unknown = 0

It is not known what type of device this is.

enumerator virtual_device = 1

This means that the device doesn’t correspond to a physical device, but rather to a dynamic source of input events.

enumerator keyboard = 2

A physical, alphabetical keyboard.

enumerator mouse = 3
enumerator touch = 4
enumerator gamepad = 5

A gamepad with action buttons, a D-pad, and thumbsticks.

enumerator flight_stick = 6
enumerator steering_wheel = 7
enumerator dance_pad = 8
enumerator hmd = 9

Head-mounted display.

enumerator spatial_mouse = 10

3D mouse, such as produced by 3Dconnexion.

enumerator digitizer = 11

A graphics tablet with stylus/pen.

enum Feature
enumerator pointer = 0

The device provides absolute screen coordinates.

enumerator keyboard = 1

The device has an interface for providing text input.

enumerator tracker = 2

The device has a motion tracker, such as an HMD.

enumerator vibration = 3

The device can produce force feedback.

enumerator battery = 4

The device provides information about battery life.

enum State
enumerator S_unknown = 0
enumerator S_up = 1
enumerator S_down = 2
void disable_pointer_events(void)

Disables the generation of mouse-movement events.

void enable_pointer_events(void)

Enables the generation of mouse-movement events.

AxisState find_axis(InputDevice::Axis axis) const

Returns the first AnalogAxis found with the given axis, or throw an assert if the axis was not found in the list.

ButtonState find_button(ButtonHandle handle) const

Returns the first ButtonState found with the given axis, or throw an assert if the button handle was not found in the list.

PointerTo<ButtonEventList> get_button_events(void)

Returns the list of recently-generated ButtonEvents. The list is also cleared.

static TypeHandle get_class_type(void)
PointerTo<PointerEventList> get_pointer_events(void)

Returns a PointerEventList containing all the recent pointer events. Clears the list.

bool has_button_event(void) const

Returns true if this device has a pending button event (a mouse button or keyboard button down/up), false otherwise. If this returns true, the particular event may be extracted via get_button_event().

bool has_feature(InputDevice::Feature feature) const

Determine supported features

Returns true if the device supports the indicated feature.

bool has_pointer_event(void) const

Returns true if this device has a pending pointer event (a mouse movement), or false otherwise. If this returns true, the particular event may be extracted via get_pointer_event().

void map_axis(std::size_t index, Axis axis)

Associates the indicated Axis with the axis of the indicated index number. Pass Axis::none to turn off any association.

It is not necessary to call this if you simply want to query the state of the various axes by index number.

void map_button(std::size_t index, ButtonHandle handle)

Associate buttons/axes with symbolic handles.

Associates the indicated ButtonHandle with the button of the indicated index number. When the given button index changes state, a corresponding ButtonEvent will be generated with the given ButtonHandle. Pass ButtonHandle::none() to turn off any association.

It is not necessary to call this if you simply want to query the state of the various buttons by index number; this is only necessary in order to generate ButtonEvents when the buttons change state.

virtual void output(std::ostream &out) const

Writes a one-line string describing the device.

void poll(void)

Polls the input device for new activity, to ensure it contains the latest events. This will only have any effect for some types of input devices; others may be updated automatically, and this method will be a no-op.

void set_vibration(double strong, double weak)

Enable rumble force-feedback effects

Sets the strength of the vibration effect, if supported. The values are clamped to 0-1 range. The first value axes the low-frequency rumble motor, whereas the second axes the high-frequency motor, if present.