Plugin/Source/SenseGloveCoreKismet/Public/SGCoreKismet/SGSenseGloveVarsKismetLibrary.h

/**
 * @file
 *
 * @author  Mamadou Babaei <mamadou@senseglove.com>
 *
 * @section LICENSE
 *
 * (The MIT License)
 *
 * Copyright (c) 2020 - 2023 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
 *
 * Contains enumerators and classes to aid in Sense Glove Deserialization.
 */


#pragma once

#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "Math/Quat.h"
#include "Math/Vector.h"

#include "SGKismet/SGBlueprintFunctionLibrary.h"
#include "SGTypes/SGVectorArray.h"

#include "SGSenseGloveVarsKismetLibrary.generated.h"

class USGSenseGloveInfo;

/**
 * "Database" class containing Sense Glove internal variables.
 */
UCLASS(meta=(ScriptName = "SesneGloveVarsKismetLibrary"))
class SENSEGLOVECOREKISMET_API USGSenseGloveVarsKismetLibrary final : public USGBlueprintFunctionLibrary
{
    GENERATED_BODY()

public:
    /**
     * Retrieve a basic ConstantsString for a Sense Glove of a specific Hardware Version. Used for debugging / unit tests.
     *
     * @returns Returns an empty string when an invalid glove version is requested.
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | SG | Sense Glove Vars")
    static FString GetStandardConstantsString(const FString& HardwareVersion, float FirmwareVersion, bool bRightHanded);

    /**
     * Retrieve an example sensor string of a Sense Glove with a particular hardware- and firmware version.
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | SG | Sense Glove Vars")
    static FString GetSensorString(const FString& HardwareVersion, float FirmwareVersion);

    /**
     * Retrieve the starting positions of a particular Sense Glove.
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | SG | Sense Glove Vars")
    static TArray<FVector> GetStartPositions(const FString& HardwareVersion, bool bRightHanded);

    /**
     * Retrieve the starting rotations of a particular Sense Glove.
     */
    UFUNCTION(BlueprintCallable, DisplayName="Get Start Rotations",
        Category="SenseGlove | Core | SG | Sense Glove Vars")
    static TArray<FQuat> GetStartRotations_TArrayFQuat(const FString& HardwareVersion, bool bRightHanded);

    /**
     * Retrieve the starting rotations of a particular Sense Glove.
     */
    UFUNCTION(BlueprintCallable, DisplayName="Get Start Rotations",
        Category="SenseGlove | Core | SG | Sense Glove Vars")
    static TArray<FRotator> GetStartRotations_TArrayFRotator(const FString& HardwareVersion, bool bRightHanded);

    /**
     * Retrieve the glove finger lengths of a particular Sense Glove.
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | SG | Sense Glove Vars")
    static TArray<FSGVectorArray> GetGloveLengths(const FString& HardwareVersion);

    /**
     * Get the number of sensors of a SenseGlove.
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | SG | Sense Glove Vars")
    static int32 GetSensors(const FString& HardwareVersion);

    /**
     * Get the default IMUCorrection for the SenseGlove.
     */
    UFUNCTION(BlueprintCallable, DisplayName="Get Imu Correction", Category="SenseGlove | Core | SG | Sense Glove Vars")
    static FQuat GetImuCorrection_FQuat(const FString& HardwareVersion,
                                        int32 FirmwareVersion, int32 SubFirmwareVersion);

    /**
     * Get the default IMUCorrection for the SenseGlove.
     */
    UFUNCTION(BlueprintCallable, DisplayName="Get Imu Correction", Category="SenseGlove | Core | SG | Sense Glove Vars")
    static FRotator GetImuCorrection_FRotator(const FString& HardwareVersion,
                                              int32 FirmwareVersion, int32 SubFirmwareVersion);

    /**
     * Check all functionality of a SenseGlove.
     */
    UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | SG | Sense Glove Vars")
    static TArray<bool> GetFunctions(const FString& HardwareVersion, int32 FirmwareVersion, int32 SubFirmwareVersion);

    /**
     * Generate a custom glove info.
     */
    UFUNCTION(BlueprintCallable, DisplayName="GenerateGloveModel", Category="SenseGlove | Core | SG | Sense Glove Vars",
        meta=(WorldContext="WorldContextObject"))
    static USGSenseGloveInfo* GenerateGloveModel_HV_FV_SFV_bRH(
        UObject* WorldContextObject,
        const FString& HardwareVersion, int32 FirmwareVersion, int32 SubFirmwareVersion, bool bRightHanded);

    /**
     * Generate a custom glove info.
     */
    UFUNCTION(BlueprintCallable, DisplayName="GenerateGloveModel", Category="SenseGlove | Core | SG | Sense Glove Vars",
        meta=(WorldContext="WorldContextObject"))
    static USGSenseGloveInfo* GenerateGloveModel_HV_FV_SFV_bRH_CI(
        UObject* WorldContextObject,
        const FString& HardwareVersion, int32 FirmwareVersion, int32 SubFirmwareVersion, bool bRightHanded,
        const FString& CustomId);
};