NDEVR
API Documentation
ControllerInterface::ControlButton

Represents a digital button input on a controller. More...

Inheritance diagram for ControllerInterface::ControlButton:
[legend]
Collaboration diagram for ControllerInterface::ControlButton:
[legend]

Public Member Functions

 ControlButton (const UUID &id)
 Constructs a ControlButton with the given identifier.
 ControlButton (const UUID &id, bool pressed)
 Constructs a ControlButton with the given identifier and pressed state.
Public Member Functions inherited from ControllerInterface::ControllerInput
 ControllerInput (UUID id)
 Constructs a ControllerInput with the given unique identifier.

Public Attributes

bool pressed = false
 Whether the button is currently pressed.
Public Attributes inherited from ControllerInterface::ControllerInput
String icon
 Icon resource name for this input.
Bounds< 2, fltp08icon_bounds_location = Constant<Bounds<2, fltp08>>::Invalid
 Position and size of the icon on a controller diagram.
UUID id
 Unique identifier for this input.
TranslatedString name
 Display name of this input.

Detailed Description

Represents a digital button input on a controller.

Definition at line 66 of file ControllerInterface.h.

Constructor & Destructor Documentation

◆ ControlButton() [1/2]

ControllerInterface::ControlButton::ControlButton ( const UUID & id)
inline

Constructs a ControlButton with the given identifier.

Parameters
[in]idThe unique identifier for this button.

Definition at line 72 of file ControllerInterface.h.

References ControllerInterface::ControllerInput::ControllerInput(), and ControllerInterface::ControllerInput::id.

◆ ControlButton() [2/2]

ControllerInterface::ControlButton::ControlButton ( const UUID & id,
bool pressed )
inline

Constructs a ControlButton with the given identifier and pressed state.

Parameters
[in]idThe unique identifier for this button.
[in]pressedWhether the button is currently pressed.

Definition at line 80 of file ControllerInterface.h.

References ControllerInterface::ControllerInput::ControllerInput(), ControllerInterface::ControllerInput::id, and pressed.


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