NDEVR
API Documentation
ControllerInterface::HapticFeedback

Represents a haptic feedback output on a controller. More...

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

Public Member Functions

 HapticFeedback (const UUID &id)
 Constructs a HapticFeedback with the given identifier.
 HapticFeedback (const UUID &id, fltp08 intensity)
 Constructs a HapticFeedback with the given identifier and intensity.
Public Member Functions inherited from ControllerInterface::ControllerInput
 ControllerInput (UUID id)
 Constructs a ControllerInput with the given unique identifier.

Public Attributes

UUID feedback_part_id = Constant<UUID>::Invalid
 ID of the associated input (e.g., joystick or trigger). Invalid if a general rumbler.
fltp08 intensity = 0.0
 Feedback intensity from 0 (off) to 1 (maximum).
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 haptic feedback output on a controller.

Definition at line 114 of file ControllerInterface.h.

Constructor & Destructor Documentation

◆ HapticFeedback() [1/2]

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

Constructs a HapticFeedback with the given identifier.

Parameters
[in]idThe unique identifier for this haptic output.

Definition at line 120 of file ControllerInterface.h.

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

◆ HapticFeedback() [2/2]

ControllerInterface::HapticFeedback::HapticFeedback ( const UUID & id,
fltp08 intensity )
inline

Constructs a HapticFeedback with the given identifier and intensity.

Parameters
[in]idThe unique identifier for this haptic output.
[in]intensityThe feedback intensity from 0 (off) to 1 (maximum).

Definition at line 128 of file ControllerInterface.h.

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


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