utility::event::HandTriggerEvent Class Reference

Hand trigger event. More...

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

Inheritance diagram for utility::event::HandTriggerEvent:

Collaboration diagram for utility::event::HandTriggerEvent:

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

Public Member Functions
	HandTriggerEvent (void)
	Default constructor.
HandTriggerEvent &	setValue (const float value) noexcept
	Set trigger value.
float	getValue (void) const noexcept
	Get trigger value.
HandTriggerEvent &	setTouched (const bool touched) noexcept
	Set touched state.
bool	isTouched (void) const noexcept
	Get touched state.
HandTriggerEvent &	setProximity (const bool proximity) noexcept
	Set proximity state.
bool	isProximity (void) const noexcept
	Get proximity state.
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.

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...

Detailed Description

Hand trigger event.

Definition at line 35 of file hand_trigger_event.hpp.

Member Function Documentation

getValue()

float utility::event::HandTriggerEvent::getValue ( void  ) const

noexcept

Get trigger value.

Returns

Value in [0, 1].

Definition at line 53 of file hand_trigger_event.cpp.

isProximity()

bool utility::event::HandTriggerEvent::isProximity ( void  ) const

noexcept

Get proximity state.

Returns

True if in proximity.

Definition at line 76 of file hand_trigger_event.cpp.

isTouched()

bool utility::event::HandTriggerEvent::isTouched ( void  ) const

noexcept

Get touched state.

Returns

True if touched.

Definition at line 64 of file hand_trigger_event.cpp.

setProximity()

HandTriggerEvent & utility::event::HandTriggerEvent::setProximity ( const bool  proximity )

noexcept

Set proximity state.

Parameters

proximity

True if in proximity.

Returns

Reference to this HandTriggerEvent.

Definition at line 70 of file hand_trigger_event.cpp.

setTouched()

HandTriggerEvent & utility::event::HandTriggerEvent::setTouched ( const bool  touched )

noexcept

Set touched state.

Parameters

touched

True if touched.

Returns

Reference to this HandTriggerEvent.

Definition at line 58 of file hand_trigger_event.cpp.

setValue()

HandTriggerEvent & utility::event::HandTriggerEvent::setValue ( const float  value )

noexcept

Set trigger value.

Parameters

value

Trigger value.

Returns

Reference to this HandTriggerEvent.

Definition at line 47 of file hand_trigger_event.cpp.

---

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

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