hand_haptic_event.hpp

/*
 Copyright (c) 2026 ETIB Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
 the Software without restriction, including without limitation the rights to
 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is furnished to do
 so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
#pragma once
 
#include <cstdint>
#include <memory>
 
#include "utility/event/hand_event.hpp"
 
namespace utility::event
{
 
    class HandHapticEvent: public HandEvent
    {
        private:
        float _amplitude { 1.0F };
 
        float _frequencyHz { 0.0F };
 
        std::int64_t _durationNs { 0 };
 
        public:
        class Factory: public Event::AbstractFactory
        {
            public:
            ~Factory(void) override;
 
            std::shared_ptr<Event> create(void) const override;
 
            std::shared_ptr<HandHapticEvent> createTyped(void) const;
        };
 
        explicit HandHapticEvent(void);
 
        ~HandHapticEvent(void) override;
 
        HandHapticEvent &setAmplitude(const float amplitude) noexcept;
 
        float getAmplitude(void) const noexcept;
 
        HandHapticEvent &setFrequency(const float frequency) noexcept;
 
        float getFrequency(void) const noexcept;
 
        HandHapticEvent &setDuration(const std::int64_t duration) noexcept;
 
        std::int64_t getDuration(void) const noexcept;
 
        HandHapticEvent &setFrequencyHz(const float frequencyHz) noexcept;
 
        float getFrequencyHz(void) const noexcept;
 
        HandHapticEvent &setDurationNs(const std::int64_t durationNs) noexcept;
 
        std::int64_t getDurationNs(void) const noexcept;
    };
 
}    // namespace utility::event