utility::event::HandSqueezeEvent Class Reference

Hand squeeze event. More...

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

Inheritance diagram for utility::event::HandSqueezeEvent:

Collaboration diagram for utility::event::HandSqueezeEvent:

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

Public Member Functions
	HandSqueezeEvent (void)
	Default constructor.
	~HandSqueezeEvent (void) override
	Default destructor.
HandSqueezeEvent &	setValue (const float value) noexcept
	Set squeeze value.
float	getValue (void) const noexcept
	Get squeeze value.
HandSqueezeEvent &	setForce (const float force) noexcept
	Set squeeze force value.
float	getForce (void) const noexcept
	Get squeeze force value.
HandSqueezeEvent &	setTouched (const bool touched) noexcept
	Set touched state.
bool	isTouched (void) const noexcept
	Get touched state.
HandSqueezeEvent &	setButtonPressed (const bool clicked) noexcept
	Set clicked state.
bool	isButtonPressed (void) const noexcept
	Get clicked 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 squeeze event.

Models .../input/squeeze/value and optional related squeeze components.

Definition at line 37 of file hand_squeeze_event.hpp.

Member Function Documentation

getForce()

float utility::event::HandSqueezeEvent::getForce ( void  ) const

noexcept

Get squeeze force value.

Returns

Force value in [0, 1].

Definition at line 64 of file hand_squeeze_event.cpp.

getValue()

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

noexcept

Get squeeze value.

Returns

Squeeze value in [0, 1].

Definition at line 53 of file hand_squeeze_event.cpp.

isButtonPressed()

bool utility::event::HandSqueezeEvent::isButtonPressed ( void  ) const

noexcept

Get clicked state.

Returns

True if clicked.

Definition at line 87 of file hand_squeeze_event.cpp.

isTouched()

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

noexcept

Get touched state.

Returns

True if touched.

Definition at line 75 of file hand_squeeze_event.cpp.

setButtonPressed()

HandSqueezeEvent & utility::event::HandSqueezeEvent::setButtonPressed ( const bool  clicked )

noexcept

Set clicked state.

Parameters

clicked

True if clicked.

Returns

Reference to this HandSqueezeEvent.

Definition at line 81 of file hand_squeeze_event.cpp.

setForce()

HandSqueezeEvent & utility::event::HandSqueezeEvent::setForce ( const float  force )

noexcept

Set squeeze force value.

Parameters

force

Force value.

Returns

Reference to this HandSqueezeEvent.

Definition at line 58 of file hand_squeeze_event.cpp.

setTouched()

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

noexcept

Set touched state.

Parameters

touched

True if touched.

Returns

Reference to this HandSqueezeEvent.

Definition at line 69 of file hand_squeeze_event.cpp.

setValue()

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

noexcept

Set squeeze value.

Parameters

value

Squeeze value.

Returns

Reference to this HandSqueezeEvent.

Definition at line 47 of file hand_squeeze_event.cpp.

---

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

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