utility::event::HandHapticTriggerEvent Class Reference

Hand haptic event for /output/haptic_trigger (XR_VERSION_1_1). More...

#include <headers/utility/event/hand_haptic_trigger_event.hpp>

Inheritance diagram for utility::event::HandHapticTriggerEvent:

Collaboration diagram for utility::event::HandHapticTriggerEvent:

Classes
class	Factory
	Factory for creating HandHapticTriggerEvent instances. More...

Additional Inherited Members
Public Types inherited from utility::event::HandEvent
enum class	HandType { Unknown = 0 , Left = 1 , Right = 2 }
	Hand types for hand events. Defines the type of hand involved in the event (e.g., left or right). More...
Public Member Functions inherited from utility::event::HandHapticEvent
	HandHapticEvent (void)
	Default constructor.
	~HandHapticEvent (void) override
	Default destructor.
HandHapticEvent &	setAmplitude (const float amplitude) noexcept
	Set haptic amplitude.
float	getAmplitude (void) const noexcept
	Get haptic amplitude.
HandHapticEvent &	setFrequency (const float frequency) noexcept
	Set the frequency of the vibration in Hz.
float	getFrequency (void) const noexcept
	Get the frequency of the vibration in Hz.
HandHapticEvent &	setDuration (const std::int64_t duration) noexcept
	Set the number of nanoseconds the vibration should last.
std::int64_t	getDuration (void) const noexcept
	Get the number of nanoseconds the vibration should last.
HandHapticEvent &	setFrequencyHz (const float frequencyHz) noexcept
	Backward-compatible alias for setFrequency.
float	getFrequencyHz (void) const noexcept
	Backward-compatible alias for getFrequency.
HandHapticEvent &	setDurationNs (const std::int64_t durationNs) noexcept
	Backward-compatible alias for setDuration.
std::int64_t	getDurationNs (void) const noexcept
	Backward-compatible alias for getDuration.
Public Member Functions inherited from utility::event::HandEvent
	HandEvent (void)
	Default constructor.
virtual	~HandEvent (void) override
	Default destructor.
HandEvent &	setHandType (const HandType handType) noexcept
	Set the type of hand involved in the event.
HandType	getHandType (void) const noexcept
	Get the type of hand involved in the event.
HandEvent &	setPose (const graphic::PoseF &pose) noexcept
	Set the pose of the hand.
graphic::PoseF	getPose (void) const noexcept
	Get the pose of the hand.
HandEvent &	setAim (const graphic::PoseF &aim) noexcept
	Set aim pose.
graphic::PoseF	getAim (void) const noexcept
	Get aim pose.
HandEvent &	setGrip (const graphic::PoseF &grip) noexcept
	Set grip pose.
graphic::PoseF	getGrip (void) const noexcept
	Get grip pose.
HandEvent &	setGripSurface (const graphic::PoseF &gripSurface) noexcept
	Set grip_surface pose.
graphic::PoseF	getGripSurface (void) const noexcept
	Get grip_surface pose.
Public Member Functions inherited from utility::event::Event
	Event (void)=default
	Default constructor.
virtual	~Event (void)=default
	Virtual destructor.

Detailed Description

Hand haptic event for /output/haptic_trigger (XR_VERSION_1_1).

Definition at line 35 of file hand_haptic_trigger_event.hpp.

---

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

• headers/utility/event/hand_haptic_trigger_event.hpp
• sources/event/hand_haptic_trigger_event.cpp