Plugin/Source/SenseGloveCoreImpl/Public/SGCoreImpl/SGHapticGloveCalibrationCheckImpl.h

/**
 * @file
 *
 * @author  Mamadou Babaei <mamadou@senseglove.com>
 *
 * @section LICENSE
 *
 * (The MIT License)
 *
 * Copyright (c) 2020 - 2022 SenseGlove
 *
 * 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.
 *
 * @section DESCRIPTION
 *
 *
 */


#pragma once

#include "Containers/Array.h"
#include "Math/Vector.h"
#include "Runtime/Launch/Resources/Version.h"
#include "Templates/UniquePtr.h"

#include "SGTypes/SGCoreTypes.h"

namespace SGCore
{
    namespace Calibration
    {
        class HapticGloveCalibrationCheck;
    }
}

class FSGSensorRangeImpl;

class SENSEGLOVECOREIMPL_API FSGHapticGloveCalibrationCheckImpl
{
public:
    typedef SGCore::Calibration::HapticGloveCalibrationCheck FHapticGloveCalibrationCheckType;

public:
    static float GetSenseGloveThreshold();

    static float GetNovaGloveThreshold();

    static float GetSenseGloveMinFlexion();

    static float GetNovaGloveMinFlexion();

    static float GetSenseGloveMinAbduction();

    static float GetNovaGloveMinAbduction();

public:
    static bool NeedsCheck(ESGDeviceType DeviceType);

    static int32 OutOfBounds(const FSGSensorRangeImpl& PreviousRange, const TArray<FVector>& CurrentValues,
                             ESGDeviceType DeviceType);

    static bool MovedMinimum(const TArray<FVector>& CurrentRange, ESGDeviceType DeviceType);

    static bool MatchesLast(const TArray<FVector>& CurrentRange, const TArray<FVector>& LastRange,
                            ESGDeviceType DeviceType);

private:
    struct FImpl;

    struct FImplDeleter
    {
        void operator()(const FImpl* P) const;
    };

    TUniquePtr<FImpl, FImplDeleter> Pimpl;
    FImplDeleter PimplDeleter;

public:
    FSGHapticGloveCalibrationCheckImpl();

    explicit FSGHapticGloveCalibrationCheckImpl(const FSGSensorRangeImpl& LastCalibrationRange);

public:
    /**
     * The cast from underlying type constructor.
     */
    explicit FSGHapticGloveCalibrationCheckImpl(
        const FHapticGloveCalibrationCheckType& HapticGloveCalibrationCheck);

public:
    /**
     * The copy constructor.
     */
    FSGHapticGloveCalibrationCheckImpl(const FSGHapticGloveCalibrationCheckImpl& Rhs);

    /**
     * The move constructor.
     */
    FSGHapticGloveCalibrationCheckImpl(FSGHapticGloveCalibrationCheckImpl&& Rhs)
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
        noexcept
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
        ;

public:
    /**
     * The destructor.
     */
    virtual ~FSGHapticGloveCalibrationCheckImpl();

public:
    /**
     * The copy assignment operator.
     */
    FSGHapticGloveCalibrationCheckImpl& operator=(const FSGHapticGloveCalibrationCheckImpl& Rhs);

    /**
     * The move assignment operator.
     */
    FSGHapticGloveCalibrationCheckImpl& operator=(FSGHapticGloveCalibrationCheckImpl&& Rhs)
#if ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 )
        noexcept
#endif  /* ENGINE_MAJOR_VERSION == 5 || ( ENGINE_MAJOR_VERSION == 4 && ENGINE_MINOR_VERSION > 24 ) */
        ;

public:
    /**
     * The cast to underlying type method.
     */
    const FHapticGloveCalibrationCheckType& ToHapticGloveCalibrationCheck() const;

public:
    FSGSensorRangeImpl GetLastSensorRange() const;
    void SetLastSensorRange(const FSGSensorRangeImpl& LastSensorRange);

public:
    ESGCalibrationStage GetCalibrationStage() const;

    bool ReachedConclusion() const;

public:
    virtual void Reset();

    void CheckRange(const TArray<FVector>& CurrentValues, float DeltaSeconds, ESGDeviceType DeviceType);
};