225 lines
12 KiB
C++
225 lines
12 KiB
C++
/**
|
|
* @file
|
|
*
|
|
* @author Mamadou Babaei <mamadou@senseglove.com>
|
|
*
|
|
* @section LICENSE
|
|
*
|
|
* (The MIT License)
|
|
*
|
|
* Copyright (c) 2020 - 2022 NovaGlove
|
|
*
|
|
* 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 "SGKismet/SGBlueprintFunctionLibrary.h"
|
|
#include "SGTypes/SGCoreTypes.h"
|
|
|
|
#include "SGNovaGloveKismetLibrary.generated.h"
|
|
|
|
class USGBasicHandModel;
|
|
class USGBuzzCommand;
|
|
class USGDevice;
|
|
class USGForceFeedbackCommand;
|
|
class USGHandPose;
|
|
class USGHandProfile;
|
|
class USGNovaGlove;
|
|
class USGNovaGloveHandProfile;
|
|
class USGNovaGloveSensorData;
|
|
class USGThumperCommand;
|
|
|
|
UCLASS(meta=(ScriptName = "SesneGloveNovaGloveKismetLibrary"))
|
|
class SENSEGLOVECOREKISMET_API USGNovaGloveKismetLibrary final : public USGBlueprintFunctionLibrary
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
public:
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static FString GetHapticsByte();
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static FVector GetMinCalibrationRange();
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static USGHandPose* CalculateHandPose(UObject* WorldContextObject,
|
|
const USGBasicHandModel* HandModel,
|
|
const USGNovaGloveSensorData* NovaData,
|
|
const USGNovaGloveHandProfile* Profile);
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static USGDevice* Parse(UObject* WorldContextObject, const FString& ConstantsString);
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static TArray<USGNovaGlove*> GetNovaGloves(UObject* WorldContextObject);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Get Nova Glove", Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static bool GetNovaGlove_OutGlove(UObject* WorldContextObject, USGNovaGlove*& OutGlove);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Get Nova Glove", Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static bool GetNovaGlove_bRightHanded_OutGlove(UObject* WorldContextObject,
|
|
bool bRightHanded, USGNovaGlove*& OutGlove);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Get Calibration Values", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static TArray<FVector> GetCalibrationValues_SensorData(const USGNovaGloveSensorData* SensorData);
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static void CalibrateInterpolation(UObject* WorldContextObject,
|
|
const TArray<FVector>& MinValues, const TArray<FVector>& MaxValues,
|
|
USGNovaGloveHandProfile*& OutProfile);
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static void CalculateGloveLocation(const FVector& ReferencePosition, const FQuat& ReferenceRotation,
|
|
ESGPositionalTrackingHardware TrackingHardware, bool bRightHanded,
|
|
FVector& OutGlovePosition, FQuat& OutGloveRotation);
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static void CalculateWristLocation(const FVector& ReferencePosition, const FQuat& ReferenceRotation,
|
|
ESGPositionalTrackingHardware TrackingHardware, bool bRightHanded,
|
|
FVector& OutWristPosition, FQuat& OutWristRotation);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="To Bytes", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static FString ToBytes_ThumperCommand(const USGThumperCommand* ThumperCommand);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="To Bytes", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static FString ToBytes_ForceFeedbackCommand(const USGForceFeedbackCommand* ForceFeedbackCommand);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="To Bytes", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static FString ToBytes_BuzzCommand(const USGBuzzCommand* BuzzCommand);
|
|
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static ESGDeviceType GetDeviceType(const USGNovaGlove* NovaGlove);
|
|
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static FString GetDeviceId(const USGNovaGlove* NovaGlove);
|
|
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static FString GetHardwareVersion(const USGNovaGlove* NovaGlove);
|
|
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static int32 GetFirmwareVersion(const USGNovaGlove* NovaGlove);
|
|
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static int32 GetSubFirmwareVersion(const USGNovaGlove* NovaGlove);
|
|
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static bool HasBattery(const USGNovaGlove* NovaGlove);
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static bool IsCharging(UPARAM(ref) USGNovaGlove* NovaGlove);
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static bool GetBatteryLevel(UPARAM(ref) USGNovaGlove* NovaGlove, float& OutBatteryLevel);
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static bool GetSensorData(UObject* WorldContextObject,
|
|
UPARAM(ref) USGNovaGlove* NovaGlove, USGNovaGloveSensorData*& OutSensorData);
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static bool GetImuRotation(UPARAM(ref) USGNovaGlove* NovaGlove, FQuat& OutImu);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Get Hand Pose", Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static bool GetHandPose_HandModel_Profile_OutHandPose(UObject* WorldContextObject,
|
|
UPARAM(ref) USGNovaGlove* NovaGlove,
|
|
const USGBasicHandModel* HandModel,
|
|
const USGNovaGloveHandProfile* Profile,
|
|
USGHandPose*& OutHandPose);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Get Hand Pose", Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static bool GetHandPose_HandGeometry_HandProfile_OutHandPose(UObject* WorldContextObject,
|
|
UPARAM(ref) USGNovaGlove* NovaGlove,
|
|
const USGBasicHandModel* HandGeometry,
|
|
const USGHandProfile* HandProfile,
|
|
USGHandPose*& OutHandPose);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Get Hand Pose", Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static bool GetHandPose_HandProfile_OutHandPose(UObject* WorldContextObject,
|
|
UPARAM(ref) USGNovaGlove* NovaGlove,
|
|
const USGHandProfile* HandProfile,
|
|
USGHandPose*& OutHandPose);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Send Haptics", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static void SendHaptics_ForceFeedbackCommand(UPARAM(ref) USGNovaGlove* NovaGlove,
|
|
const USGForceFeedbackCommand* ForceFeedbackCommand);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Send Haptics", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static void SendHaptics_BuzzCommand(UPARAM(ref) USGNovaGlove* NovaGlove,
|
|
const USGBuzzCommand* BuzzCommand);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Send Haptics", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static void SendHaptics_ThumperCommand(UPARAM(ref) USGNovaGlove* NovaGlove,
|
|
const USGThumperCommand* ThumperCommand);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Send Haptics", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static void SendHaptics_ForceFeedbackCommand_BuzzCommand_ThumperCommand(
|
|
UPARAM(ref) USGNovaGlove* NovaGlove,
|
|
const USGForceFeedbackCommand* ForceFeedbackCommand,
|
|
const USGBuzzCommand* BuzzCommand,
|
|
const USGThumperCommand* ThumperCommand);
|
|
|
|
UFUNCTION(BlueprintCallable, DisplayName="Get Calibration Values", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static bool GetCalibrationValues_OutValues(UPARAM(ref) USGNovaGlove* NovaGlove,
|
|
TArray<FVector>& OutValues);
|
|
|
|
UFUNCTION(BlueprintPure, DisplayName="Apply Calibration", Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static void ApplyCalibration_HandProfile(UObject* WorldContextObject,
|
|
const USGNovaGlove* NovaGlove,
|
|
USGHandProfile*& OutProfile);
|
|
|
|
UFUNCTION(BlueprintPure, DisplayName="Apply Calibration", Category="SenseGlove | Core | Nova | Nova Glove",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static void ApplyCalibration_NovaGloveHandProfile(UObject* WorldContextObject,
|
|
const USGNovaGlove* NovaGlove,
|
|
USGNovaGloveHandProfile*& OutProfile);
|
|
|
|
UFUNCTION(BlueprintPure, DisplayName="Get Glove Location", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static void GetGloveLocation_ReferencePosition_ReferenceRotation_TrackingHardware_OutGlovePosition_OutGloveRotation(
|
|
const USGNovaGlove* NovaGlove,
|
|
const FVector& ReferencePosition, const FQuat& ReferenceRotation,
|
|
ESGPositionalTrackingHardware TrackingHardware,
|
|
FVector& OutGlovePosition, FQuat& OutGloveRotation);
|
|
|
|
UFUNCTION(BlueprintPure, DisplayName="Get Wrist Location", Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static void
|
|
GetWristLocation_GetWristLocation_ReferencePosition_ReferenceRotation_TrackingHardware_OutWristPosition_OutWristRotation(
|
|
const USGNovaGlove* NovaGlove,
|
|
const FVector& ReferencePosition, const FQuat& ReferenceRotation,
|
|
ESGPositionalTrackingHardware TrackingHardware,
|
|
FVector& OutWristPosition, FQuat& OutWristRotation);
|
|
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Nova | Nova Glove")
|
|
static FString ToString(const USGNovaGlove* NovaGlove);
|
|
}; |