121 lines
4.2 KiB
C++
121 lines
4.2 KiB
C++
/**
|
|
* @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
|
|
*
|
|
* 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 "SGCore/SGSenseGloveInfo.h"
|
|
|
|
#include "SGSenseGloveVars.generated.h"
|
|
|
|
/**
|
|
* "Database" class containing Sense Glove internal variables.
|
|
*/
|
|
USTRUCT()
|
|
struct SENSEGLOVECORE_API FSGSenseGloveVars
|
|
{
|
|
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.
|
|
*/
|
|
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.
|
|
*/
|
|
static FString GetSensorString(const FString& HardwareVersion, float FirmwareVersion);
|
|
|
|
/**
|
|
* Retrieve the starting positions of a particular Sense Glove.
|
|
*/
|
|
static TArray<FVector> GetStartPositions(const FString& HardwareVersion, bool bRightHanded);
|
|
|
|
/**
|
|
* Retrieve the starting rotations of a particular Sense Glove.
|
|
*/
|
|
static TArray<FQuat> GetStartRotationsQ(const FString& HardwareVersion, bool bRightHanded);
|
|
|
|
/**
|
|
* Retrieve the starting rotations of a particular Sense Glove.
|
|
*/
|
|
static TArray<FRotator> GetStartRotations(const FString& HardwareVersion, bool bRightHanded);
|
|
|
|
/**
|
|
* Retrieve the glove finger lengths of a particular Sense Glove.
|
|
*/
|
|
static TArray<TArray<FVector>> GetGloveLengths(const FString& HardwareVersion);
|
|
|
|
/**
|
|
* Get the number of sensors of a SenseGlove.
|
|
*/
|
|
static int32 GetSensors(const FString& HardwareVersion);
|
|
|
|
/**
|
|
* Get the default IMUCorrection for the SenseGlove.
|
|
*/
|
|
static FQuat GetImuCorrectionQ(const FString& HardwareVersion, int32 FirmwareVersion, int32 SubFirmwareVersion);
|
|
|
|
/**
|
|
* Get the default IMUCorrection for the SenseGlove.
|
|
*/
|
|
static FRotator GetImuCorrection(const FString& HardwareVersion, int32 FirmwareVersion, int32 SubFirmwareVersion);
|
|
|
|
/**
|
|
* Check all functionality of a SenseGlove.
|
|
*/
|
|
static TArray<bool> GetFunctions(const FString& HardwareVersion, int32 FirmwareVersion, int32 SubFirmwareVersion);
|
|
|
|
/**
|
|
* Generate a custom glove info.
|
|
*/
|
|
static USGSenseGloveInfo* GenerateGloveModel(UObject* Outer, const FString& HardwareVersion, int32 FirmwareVersion,
|
|
int32 SubFirmwareVersion, bool bRightHanded);
|
|
|
|
/**
|
|
* Generate a custom glove info.
|
|
*/
|
|
static USGSenseGloveInfo* GenerateGloveModel(UObject* Outer, const FString& HardwareVersion, int32 FirmwareVersion,
|
|
int32 SubFirmwareVersion, bool bRightHanded, const FString& CustomId);
|
|
};
|