bump the plugin version to v2.0.2

bump the plugin version to v2.0.1
do not call FSGHandLayer::ResetCalibration on every backend initialization
2024-04-25 12:56:52 +02:00 · 2024-04-15 15:10:34 +02:00 · 2024-04-15 15:10:34 +02:00 · 2024-04-15 15:10:33 +02:00 · 2024-04-15 15:10:31 +02:00 · 2024-04-15 15:10:30 +02:00
88 changed files with 216 additions and 228 deletions
@@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

+## [2.0.2] - 2024-04-25
+
+This is a patch release with no code changes.
+
+### Added
+
+- Introduce official Unreal Engine 5.4 support to the Unreal Engine Marketplace.
+
+### Changed
+
+- Updated the Platform Support Matrix with the latest changes. This is the last release to support Unreal Engine 5.1 as we no longer are able to push updates for this release to the Unreal Engine Marketplace. The v2.0.1 release for Unreal Engine 5.1 can be obtained from the Unreal Engine Marketplace, and v2.0.2 through our Microsoft Azure DevOps repositories. Please note that there are no actual code changes between these two releases and in terms of functionality they are almost identical.
+
+## [2.0.1] - 2024-04-15
+
+This is a bugfix release.
+
+### Fixed
+
+- Fix a bug inside both SGVirtualHandComponent and SGWristTrackerComponent where the connected glove's UObject instance gets destroyed and re-instantiated every frame. With this fix now the glove instance will be created or destroyed only when a glove connects to or disconnects from the system.
+- Update the outdated Platform Support Matrix and its remarks section to reflect the latest status information.
+- Fix the wrong header file description sections for the header files inside <code>SenseGloveKismet/Public/SGKismet/</code>.
+
+### Changed
+
+- SenseGlove libraries have been updated to v2.102.0-35d4de3f.
+- Together, SenseGlove libraries v2.102.0-35d4de3f and SenseCom v1.6.1 remove the need to call ResetCalibration every time and are able to store and load calibration profiles from disk.
+- SesenGloveBackend module is no longer calling FSGHandLayer::ResetCalibration on every backend initialization.
+
 ## [2.0.0] - 2024-03-22

 This is the second major release of the SenseGlove Unreal Engine Plugin adding support for Nova 2 with enormous breaking changes to the current C++ and Blueprint APIs.
@@ -8,10 +8,10 @@ This repository relies on Git LFS for storing binary blobs (e.g. third-party lib

 |          | **Windows (MSVC 2017)** | **Windows (MSVC 2019)** | **Windows (MSVC 2022)** | **Linux x86-64 (Native Toolchain)** | **Linux AArch64 (Native Toolchain)** | **Android (NDK)** | **UE Marketplace Version** | **Azure DevOps Version** |
 |----------|:-----------------------:|:-----------------------:|:-----------------------:|:-----------------------------------:|:------------------------------------:|:-----------------:|:--------------------------:|:------------------------:|
-| **5.4**  |            ❌            |            ❌            |         ✅ v2.0.x        |               ✅ v2.0.x              |               ✅ v2.0.x               |  ✅ v2.0.x (r25b)  |              ❌             |             ❌            |
-| **5.3**  |            ❌            |         ✅ v2.0.x        |         ✅ v2.0.x        |               ✅ v2.0.x              |               ✅ v2.0.x               |  ✅ v2.0.x (r25b)  |          ✅ v2.0.0          |         ✅ v2.0.0         |
-| **5.2**  |            ❌            |         ✅ v2.0.x        |         ✅ v2.0.x        |               ✅ v2.0.x              |               ✅ v2.0.x               |  ✅ v2.0.x (r25b)  |          ✅ v2.0.0          |         ✅ v2.0.0         |
-| **5.1**  |            ❌            |         ✅ v2.0.x        |         ✅ v2.0.x        |               ✅ v2.0.x              |               ✅ v2.0.x               |  ✅ v2.0.x (r25b)  |          ✅ v2.0.0          |         ✅ v2.0.0         |
+| **5.4**  |            ❌            |            ❌            |         ✅ v2.0.x        |               ✅ v2.0.x              |               ✅ v2.0.x               |  ✅ v2.0.x (r25b)  |          ✅ v2.0.2          |         ✅ v2.0.2         |
+| **5.3**  |            ❌            |         ✅ v2.0.x        |         ✅ v2.0.x        |               ✅ v2.0.x              |               ✅ v2.0.x               |  ✅ v2.0.x (r25b)  |          ✅ v2.0.2          |         ✅ v2.0.2         |
+| **5.2**  |            ❌            |         ✅ v2.0.x        |         ✅ v2.0.x        |               ✅ v2.0.x              |               ✅ v2.0.x               |  ✅ v2.0.x (r25b)  |          ✅ v2.0.2          |         ✅ v2.0.2         |
+| **5.1**  |            ❌            |         ✅ v2.0.x        |         ✅ v2.0.x        |               ✅ v2.0.x              |               ✅ v2.0.x               |  ✅ v2.0.x (r25b)  |          ⚠️ v2.0.1          |         ✅ v2.0.2         |
 | **5.0**  |            ❌            |         ⚠️ v1.6.x        |         ⚠️ v1.6.x        |               ⚠️ v1.6.x              |               ⚠️ v1.6.x               |  ⚠️ v1.6.x (r21e)  |          ⚠️ v1.6.1          |         ⚠️ v1.6.1         |
 | **4.27** |         ⚠️ v1.4.x        |         ⚠️ v1.4.x        |         ⚠️ v1.4.x        |               ⚠️ v1.4.x              |               ⚠️ v1.4.x               |  ⚠️ v1.4.x (r21e)  |          ⚠️ v1.3.1          |         ⚠️ v1.4.3         |
 | **4.26** |         ⚠️ v1.0.x        |         ⚠️ v1.0.x        |            ❌            |               ⚠️ v1.0.x              |                   ❌                  |         ❌         |              ❌             |         ⚠️ v1.0.4         |
@@ -27,11 +27,9 @@ This repository relies on Git LFS for storing binary blobs (e.g. third-party lib

 Remarks:
 * Per [Epic's Marketplace Guidelines](https://www.unrealengine.com/en-US/marketplace-guidelines) in regards to Code Plugins (sections 2.6.3.d and 3.1.b), we are only able to distribute or update the SenseGlove plugin for the last 3 stable versions of Unreal Engine. As a result, we won't be able to publish updates or bug fixes for the older versions of the Engine except on rare occasions and only through our official repository on Microsoft Azure DevOps.
-* Microsoft Visual Studio 2022 is not supported by Unreal Engine 4.22 through 4.26.
 * All third-party libraries on Windows built against Windows SDK 10.0.
-* Oculus support is only provided through the recommended Android NDK versions by Epic Games.
-* The Unreal Engine 4.27+ support is provided for Android/Oculus development.
-* [wjwwood/serial](https://github.com/wjwwood/serial) requires Android NDK API Level 28+ in order to be built successfully, thus some older NDKs such as r14b.
+* Oculus and VIVE support is only provided through the recommended Android NDK versions by Epic Games.
+* [wjwwood/serial](https://github.com/wjwwood/serial) requires Android NDK API Level 28+ in order to be built successfully.
 * All third-party libraries target Android NDK API Level 29, thus any project relying on the plug-in should be build with the same NDK API Level.

 ## Changelog
@@ -56,7 +54,7 @@ Please note that modules postfixed with **Impl** are intended for interal use an

 ## Planned Features Completion Status

-### Implemented as of v2.0.0
+### Implemented as of v2.0.2

 - [X] Full SenseGlove low-level core API access through Unreal C++.
 - [X] Full SenseGlove low-level core API access through Blueprint.
@@ -264,4 +262,4 @@ The SenseGlove plug-in for Unreal Engine is licensed under the terms of the [MIT

 ### Third-Party Licenses

-Please note that while the SenseGlove plug-in for Unreal Engine is made available under the [MIT License](LICENSE.md), it utilizes a few third-party libraries with permissive free licenses as well, in order to power various components. For a list of these libraries and their own respective open-source licenses take a look at [LICENSE-THIRD-PARTY.md](LICENSE-THIRD-PARTY.md), please.
+Please note that while the SenseGlove plug-in for Unreal Engine is made available under the [MIT License](LICENSE.md), it utilizes a few third-party libraries with permissive free licenses as well, in order to power various components. For a list of these libraries and their own respective open-source licenses take a look at [LICENSE-THIRD-PARTY.md](LICENSE-THIRD-PARTY.md), please.
@@ -1,7 +1,7 @@
 {
 	"FileVersion": 3,
 	"Version": 1,
-	"VersionName": "2.0.0",
+	"VersionName": "2.0.2",
 	"FriendlyName": "SenseGlove",
 	"Description": "Integrating the SenseGlove haptic controller into Unreal Engine",
 	"Category": "Virtual Reality",
@@ -10,6 +10,7 @@
 	"DocsURL": "https://senseglove.gitlab.io/unreal-blueprint-docs/",
 	"MarketplaceURL": "com.epicgames.launcher://ue/marketplace/product/5e1d408f517b4966a269ec1035de0b9e",
 	"SupportURL": "https://www.senseglove.com/support/",
+	"EngineVersion": "5.1.0",
 	"CanContainContent": true,
 	"IsBetaVersion": false,
 	"IsExperimentalVersion": false,
@@ -598,13 +598,18 @@ bool USGVirtualHandComponent::FImpl::CheckGlove() const
        }
    }

-    const bool bGloveWasPresent = IsValid(Owner->Glove);
-    const bool bFoundGlove = USGHapticGlove::GetGlove(Owner, Owner->IsRight(), Owner->Glove);
-
-    if (!bFoundGlove && bGloveWasPresent)
+    bool bGloveConnected;
+    if (!IsValid(Owner->Glove) || !Owner->Glove->IsConnected())
    {
-        SGLOG_ERROR(FString::Printf(TEXT("Could not find a %s glove!"),
-            (Owner->IsRight() ? TEXT("right-handed") : TEXT("left-handed"))));
+        bGloveConnected = USGHapticGlove::GetGlove(Owner, Owner->IsRight(), Owner->Glove);
+        if (!bGloveConnected)
+        {
+            Owner->Glove = nullptr;
+        }
+    }
+    else
+    {
+        bGloveConnected = true;
    }

    const bool bIsEditor = IsEditor();
@@ -613,7 +618,7 @@ bool USGVirtualHandComponent::FImpl::CheckGlove() const
        const bool bIsVisible = Owner->IsVisible();
        if (Owner->bHiddenInGameIfNoGloveDetected)
        {
-            if (bFoundGlove)
+            if (bGloveConnected)
            {
                if (!bIsVisible)
                {
@@ -637,7 +642,7 @@ bool USGVirtualHandComponent::FImpl::CheckGlove() const
        }
    }

-    return bFoundGlove;
+    return bGloveConnected;
 }

 void USGVirtualHandComponent::FImpl::DrawDebugVirtualHand() const
@@ -250,21 +250,22 @@ bool USGWristTrackerComponent::FImpl::CheckGlove() const
        }
    }

-    const bool bGloveWasPresent = IsValid(Owner->Glove);
-    const bool bFoundGlove = USGHapticGlove::GetGlove(Owner, Owner->IsRight(), Owner->Glove);
-
-    if (!bFoundGlove && bGloveWasPresent)
+    bool bGloveConnected;
+    if (!IsValid(Owner->Glove) || !Owner->Glove->IsConnected())
    {
-        SGLOG_ERROR(FString::Printf(TEXT("Could not find a %s glove!"),
-            (Owner->IsRight() ? TEXT("right-handed") : TEXT("left-handed"))));
+        bGloveConnected = USGHapticGlove::GetGlove(Owner, Owner->IsRight(), Owner->Glove);
+        if (!bGloveConnected)
+        {
+            Owner->Glove = nullptr;
+        }
    }
-
-    if (bFoundGlove)
+    else
    {
+        bGloveConnected = true;
        UpdateWristTrackingData();
    }

-    return bFoundGlove;
+    return bGloveConnected;
 }

 void USGWristTrackerComponent::FImpl::UpdateMotionSource() const
@@ -48,7 +48,6 @@
 class UCameraComponent;
 class UPrimitiveComponent;
 class USphereComponent;
-class UXRDeviceVisualizationComponent;

 class USGVirtualHandComponent;
 class USGWristTrackerComponent;
@@ -130,9 +129,6 @@ private:
    UPROPERTY(VisibleAnywhere, Category="SenseGlove", meta=(AllowPrivateAccess="false"))
    USGWristTrackerComponent* WristTrackerLeft;

-    UPROPERTY(VisibleAnywhere, Category="SenseGlove", meta=(AllowPrivateAccess="false"))
-    UXRDeviceVisualizationComponent* ControllerVisualizerLeft;
-
    UPROPERTY(VisibleAnywhere, Category="SenseGlove", meta=(AllowPrivateAccess="false"))
    USGVirtualHandComponent* HandLeft;

@@ -166,9 +162,6 @@ private:
    UPROPERTY(VisibleAnywhere, Category="SenseGlove", meta=(AllowPrivateAccess="false"))
    USGWristTrackerComponent* WristTrackerRight;

-    UPROPERTY(VisibleAnywhere, Category="SenseGlove", meta=(AllowPrivateAccess="false"))
-    UXRDeviceVisualizationComponent* ControllerVisualizerRight;
-
    UPROPERTY(VisibleAnywhere, Category="SenseGlove", meta=(AllowPrivateAccess="false"))
    USGVirtualHandComponent* HandRight;

@@ -118,10 +118,6 @@ bool USGBackend::InitializeBackend()
        FSGDeviceList::Dispose();
        FSGDeviceList::Reinitialize();

-        // Force reset the hands calibration.
-        FSGHandLayer::ResetCalibration(false);
-        FSGHandLayer::ResetCalibration(true);
-
        bBackendInitialized = true;

        return true;
@@ -57,15 +57,6 @@ USGWristTrackerComponent* UPawnKismetLibrary::GetWristTrackerLeft(const ASGPawn*
    return Pawn->GetWristTrackerLeft();
 }

-UXRDeviceVisualizationComponent* UPawnKismetLibrary::GetControllerVisualizerLeft(const ASGPawn* Pawn)
-{
-#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 2
-    return Pawn->GetControllerVisualizerLeft();
-#else  /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 2 */
-    return nullptr;
-#endif  /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 2 */
-}
-
 USGVirtualHandComponent* UPawnKismetLibrary::GetHandLeft(const ASGPawn* Pawn)
 {
    return Pawn->GetHandLeft();
@@ -121,15 +112,6 @@ USGWristTrackerComponent* UPawnKismetLibrary::GetWristTrackerRight(const ASGPawn
    return Pawn->GetWristTrackerRight();
 }

-UXRDeviceVisualizationComponent* UPawnKismetLibrary::GetControllerVisualizerRight(const ASGPawn* Pawn)
-{
-#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 2
-    return Pawn->GetControllerVisualizerRight();
-#else  /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 2 */
-    return nullptr;
-#endif  /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 2 */
-}
-
 USGVirtualHandComponent* UPawnKismetLibrary::GetHandRight(const ASGPawn* Pawn)
 {
    return Pawn->GetHandRight();
@@ -29,9 +29,7 @@
 *
 * @section DESCRIPTION
 *
- * A data class containing the minimum required data for a hand's forward
- * kinematics.
- * Used in both kinematics and calibration.
+ *
 */


@@ -29,9 +29,7 @@
 *
 * @section DESCRIPTION
 *
- * A data class containing the minimum required data for a hand's forward
- * kinematics.
- * Used in both kinematics and calibration.
+ *
 */


@@ -51,7 +49,6 @@

 class UCameraComponent;
 class USphereComponent;
-class UXRDeviceVisualizationComponent;

 class ASGPawn;
 class USGVirtualHandComponent;
@@ -69,9 +66,6 @@ public:
    UFUNCTION(BlueprintPure, Category="SenseGlove | Game Framework | Pawn")
    static USGWristTrackerComponent* GetWristTrackerLeft(const ASGPawn* Pawn);

-    UFUNCTION(BlueprintPure, Category="SenseGlove | Game Framework | Pawn")
-    static UXRDeviceVisualizationComponent* GetControllerVisualizerLeft(const ASGPawn* Pawn);
-
    UFUNCTION(BlueprintPure, Category="SenseGlove | Game Framework | Pawn")
    static USGVirtualHandComponent* GetHandLeft(const ASGPawn* Pawn);

@@ -105,9 +99,6 @@ public:
    UFUNCTION(BlueprintPure, Category="SenseGlove | Game Framework | Pawn")
    static USGWristTrackerComponent* GetWristTrackerRight(const ASGPawn* Pawn);

-    UFUNCTION(BlueprintPure, Category="SenseGlove | Game Framework | Pawn")
-    static UXRDeviceVisualizationComponent* GetControllerVisualizerRight(const ASGPawn* Pawn);
-
    UFUNCTION(BlueprintPure, Category="SenseGlove | Game Framework | Pawn")
    static USGVirtualHandComponent* GetHandRight(const ASGPawn* Pawn);

@@ -29,9 +29,7 @@
 *
 * @section DESCRIPTION
 *
- * A data class containing the minimum required data for a hand's forward
- * kinematics.
- * Used in both kinematics and calibration.
+ *
 */


@@ -29,9 +29,7 @@
 *
 * @section DESCRIPTION
 *
- * A data class containing the minimum required data for a hand's forward
- * kinematics.
- * Used in both kinematics and calibration.
+ *
 */


@@ -29,9 +29,7 @@
 *
 * @section DESCRIPTION
 *
- * A data class containing the minimum required data for a hand's forward
- * kinematics.
- * Used in both kinematics and calibration.
+ *
 */


@@ -29,9 +29,7 @@
 *
 * @section DESCRIPTION
 *
- * A data class containing the minimum required data for a hand's forward
- * kinematics.
- * Used in both kinematics and calibration.
+ *
 */