Plugin/Source/SenseGloveCoreKismet/Public/SGCoreKismet/SGHapticGloveQuickCalibrationKismetLibrary.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 "SGCore/SGHapticGloveQuickCalibration.h"
#include "SGCore/SGSensorRange.h"
#include "SGKismet/SGBlueprintFunctionLibrary.h"

#include "SGHapticGloveQuickCalibrationKismetLibrary.generated.h"

/**
 *
 */
UCLASS(meta=(ScriptName = "SesneGloveHapticGloveQuickCalibrationKismetLibrary"))
class SENSEGLOVECOREKISMET_API USGHapticGloveQuickCalibrationKismetLibrary final : public USGBlueprintFunctionLibrary
{
    GENERATED_BODY()

public:
    /**
     *
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration",
        meta=(WorldContext="WorldContextObject"))
    static USGHapticGloveQuickCalibration* MakeHapticGloveQuickCalibration(UObject* WorldContextObject);

    /**
     * Create a new instance of a QuickCalibration for Haptic Gloves.
     */
    UFUNCTION(BlueprintCallable, DisplayName="Make Haptic Glove Quick Calibration",
        Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration",
        meta=(WorldContext="WorldContextObject"))
    static USGHapticGloveQuickCalibration* MakeHapticGloveQuickCalibration_GTC_AET(
        UObject* WorldContextObject,
        const USGHapticGlove* GloveToCalibrate,
        float AutoEndTimeout);

    /**
     * Default time in seconds, to end this sequence. 15 seconds is very quick for some people. 
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration")
    static float GetDefaultAutoEndTimeout();

    /**
     * Time, in seconds, after which this sequence stops gathering data. Based on the deltaSeconds variable passed in the Update() function.
     */
    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration")
    static float GetAutoEndTimeout(const USGHapticGloveQuickCalibration* HapticGloveQuickCalibration);

    /**
     * When compiling the final profile, we use a Weighted Moving Average filter with this period to filer out some outliers.
     */
    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration")
    static int32 GetSmoothingSamples(const USGHapticGloveQuickCalibration* HapticGloveQuickCalibration);

    /**
     * The min/max values recorded during this calibration sequence.
     */
    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration",
        meta=(WorldContext="WorldContextObject"))
    static USGSensorRange* GetSensorRange(UObject* WorldContextObject,
                                          const USGHapticGloveQuickCalibration* HapticGloveQuickCalibration);

    /**
     * A temporary profile to apply the sensorRange to. Used to generate a 'preview' HandPose.
     */
    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration",
        meta=(WorldContext="WorldContextObject"))
    static USGHandProfile* GetTemporaryProfile(UObject* WorldContextObject,
                                               const USGHapticGloveQuickCalibration* HapticGloveQuickCalibration);

    /**
     * Determines if the user has moved enough so that we can animate.
     */
    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration")
    static bool CanAnimate(const USGHapticGloveQuickCalibration* HapticGloveQuickCalibration);

    /**
     * This sequence autocompletes after its autoEndTime has elapsed.
     */
    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration")
    static bool AutoCompleted(const USGHapticGloveQuickCalibration* HapticGloveQuickCalibration);

    /**
     * Resets data points, min/max ranges and profile.
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration")
    static void Reset(USGHapticGloveQuickCalibration* HapticGloveQuickCalibration);

    /**
     * Update this calibration sequence with new data. We use deltaSeconds to check for things like stability.
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration")
    static void Update(USGHapticGloveQuickCalibration* HapticGloveQuickCalibration, float DeltaSeconds);

    /**
     * Add a new datapoint to this sequence's collection. Updates the range and profile used to generate a preview.
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration")
    static void AddDataPoint(USGHapticGloveQuickCalibration* HapticGloveQuickCalibration,
                             const TArray<FVector>& CalibrationData);

    /**
     * After we confirm the current step, we're basically done.
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration")
    static void ConfirmCurrentStep(USGHapticGloveQuickCalibration* HapticGloveQuickCalibration);

    /**
     * Compile a sensor range from the data points collected while the sequence was running. Smoothed by a Moving Average Filter.
     */
    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration",
        meta=(WorldContext="WorldContextObject"))
    static bool CompileRange(UObject* WorldContextObject,
                             const USGHapticGloveQuickCalibration* HapticGloveQuickCalibration,
                             USGSensorRange*& OutSensorRange);

    /**
     * Returns a 'preview' of what a HandPose with this sequence's current settings would look like.
     */
    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration",
        meta=(WorldContext="WorldContextObject"))
    static bool GetHandPose(UObject* WorldContextObject,
                            const USGHapticGloveQuickCalibration* HapticGloveQuickCalibration, bool bRightHanded,
                            USGHandPose*& OutCurrentHandPose);

    /**
     * Retrieve instructions on what to do during the current step.
     */
    UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Calibration | Haptic Glove Quick Calibration")
    static FString GetCurrentInstruction(const USGHapticGloveQuickCalibration* HapticGloveQuickCalibration,
                                         const FString& NextStepKey = "");
};