utility::event::HandEvent Class Reference

Abstract base class for hand events. More...

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

Inheritance diagram for utility::event::HandEvent:

Collaboration diagram for utility::event::HandEvent:

Public Types
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
	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

Abstract base class for hand events.

Represents events related to hand tracking, such as gesture recognition or hand pose updates. Specific hand event types should derive from this class.

Definition at line 44 of file hand_event.hpp.

Member Enumeration Documentation

HandType

enum class utility::event::HandEvent::HandType

strong

Hand types for hand events. Defines the type of hand involved in the event (e.g., left or right).

Enumerator
Unknown	Unknown hand
Left	Left hand
Right	Right hand

Definition at line 51 of file hand_event.hpp.

Member Function Documentation

getAim()

graphic::PoseF utility::event::HandEvent::getAim ( void  ) const

noexcept

Get aim pose.

Returns

Aim pose.

Definition at line 60 of file hand_event.cpp.

getGrip()

graphic::PoseF utility::event::HandEvent::getGrip ( void  ) const

noexcept

Get grip pose.

Returns

Grip pose.

Definition at line 71 of file hand_event.cpp.

getGripSurface()

graphic::PoseF utility::event::HandEvent::getGripSurface ( void  ) const

noexcept

Get grip_surface pose.

Returns

Grip-surface pose.

Definition at line 83 of file hand_event.cpp.

getHandType()

HandEvent::HandType utility::event::HandEvent::getHandType ( void  ) const

noexcept

Get the type of hand involved in the event.

Returns

The type of hand (left or right).

Definition at line 38 of file hand_event.cpp.

Here is the caller graph for this function:

getPose()

graphic::PoseF utility::event::HandEvent::getPose ( void  ) const

noexcept

Get the pose of the hand.

Returns

The pose of the hand.

Definition at line 49 of file hand_event.cpp.

setAim()

HandEvent & utility::event::HandEvent::setAim ( const graphic::PoseF &  aim )

noexcept

Set aim pose.

Parameters

aim

Aim pose.

Returns

Reference to this HandEvent.

Definition at line 54 of file hand_event.cpp.

setGrip()

HandEvent & utility::event::HandEvent::setGrip ( const graphic::PoseF &  grip )

noexcept

Set grip pose.

Parameters

grip	Grip pose.

Returns

Reference to this HandEvent.

Definition at line 65 of file hand_event.cpp.

setGripSurface()

HandEvent & utility::event::HandEvent::setGripSurface ( const graphic::PoseF &  gripSurface )

noexcept

Set grip_surface pose.

Parameters

gripSurface

Grip-surface pose.

Returns

Reference to this HandEvent.

Definition at line 77 of file hand_event.cpp.

setHandType()

HandEvent & utility::event::HandEvent::setHandType ( const HandType  handType )

noexcept

Set the type of hand involved in the event.

Parameters

handType

The type of hand (left or right).

Returns

Reference to this HandEvent for method chaining.

Definition at line 32 of file hand_event.cpp.

setPose()

HandEvent & utility::event::HandEvent::setPose ( const graphic::PoseF &  pose )

noexcept

Set the pose of the hand.

Parameters

pose	The pose of the hand.

Returns

Reference to this HandEvent for method chaining.

Definition at line 43 of file hand_event.cpp.

---

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

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