Plugin/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.9.6] - 2024-02-14

This is a bugfix release.

Fixed

• Fix a few critical bugs inside the NovaGlove class where the higher levels of the API including constructors, Parse, and NewNovaGlove methods mistakenly instantiate a SenseGloveImpl class instead of a NovaGloveImpl class.

[1.9.5] - 2024-02-09

This is a bugfix release.

Fixed

• Fix a wrong type-casting inside SGDeviceModel::ParseFirmware where OutMainVersion and OutSubVersion arguments are getting passed to the lower levels of the API. This could potentially result in a segfault at the FFI boundary between lower and higher levels of the API.

[1.9.4] - 2024-02-08

This is a bugfix release addressing mostly Blueprint API issues with ABI breaking changes inside the Blueprint layer, backported from the next major release of the plugin as documented below.

Fixed

• Fix the Blueprint Parse function signature for the NovaGloveInfoKismetLibrary where the OutGloveInfo passed by the caller was never actually assigned as it was not getting passed by reference.
• Changelog formatting.

[1.9.3] - 2024-02-03

This is a hotfix release addressing a few critical issues that might result in crashes or malfunctions for users of the low-level SenseGlove API, backported from the next major release of the plugin as documented below.

Fixed

• Fix a potential memory corruption inside one of the SGBasicHandModel constructors where the StartPositions parameter gets passed as the StartRotations parameter to lower levels of the API.
• Fix a potential memory corruption inside one of the SGSenseGloveInfo constructors where the StartPositions parameter gets passed as the Functions parameter to lower levels of the API.
• Fix a potential memory corruption where inside the SGHapticGloveCalibrationSequence::GetCurrentInstruction method, the return statement of the function is getting assigned to the const parameter NextStepKey, thus the return statement of the function will always be empty as well.
• Fix a potential memory corruption where inside one of the overloads of the SGSenseGloveImpl::GetGlovePose method, the out parameter of the method is getting passed as the SensorData parameter to the lower levels of the API.
• Fix multiple Equals methods for a few classes such as SGInterpolationSet, SGNovaGloveHandProfile, SGNovaGloveInfo, SGSenseGloveHandProfile, SenseGloveInfo, SenseGlovePose, where the Equal method compares the current instance against itself instead of the other instance passed to as the parameter to the method.
• Removed a redundant code statement inside the SGNovaGloveImpl::GetSubFirmwareVersion method.
• Some minor const correctness fixes.
• Some other minor code fixes and improvements.
• Fix the wrong version numbers inside the paltform support matrix and the main .uplugin file.
• Minor changelog fixes.
• Bumped the copyright years.

[1.9.2] - 2023-11-03

Added

• Added a list of planned features and their completion status to the main README file.

Fixed

• A bug where the released actor is going to be NULL whenever the OnActorReleased event fires.

[1.9.1] - 2023-10-11

Fixed

• Add the missing Unreal Engine C++ header to files that rely on the ENGINE_*_VERSION macros in order to fix the Epic Store build failures on UE 5.3.

[1.9.0] - 2023-10-10

Changed

• The BlueprintImplementableEvent UFUNCTION specifier for the OnGrabStateUpdated, OnTouchStateUpdated, OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch events have been changed to BlueprintNativeEvent in order to allow them to be implemented from the child C++ classes as well. This won't break any existing Blueprint code that relies on the previous BlueprintImplementableEvent signature.

Fixed

• Add a missing release note entry for the v1.8.0 release to the changelog file.

[1.8.0] - 2023-10-10

Added

• Introduced new SGPawn events: OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch.
• Exposed OnGrabStateUpdated, OnTouchStateUpdated, OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch events to Blueprint as BlueprintImplementableEvent.

Fixed

• Fix a bug where the OnTouchStateUpdated event is mistakenly triggered instead of the OnGrabStateUpdated when the right thumb fingertip grab collider overlaps with a grabbable actor.
• Fix the DECLARE_EVENT macro signature for OnGrabStateUpdated and OnTouchStateUpdated events.

[1.7.0] - 2023-09-14

Added

• Introduce SGGameInstance, a customized SenseGlove game instance for future use.
• Added the new SenseGloveBackend and SenseGloveBackendKismet modules.
• Added SG_CPP20 C++ macro for C++20 detection, which is now default from UE 5.3 onwards.
• Added SG_CAPTURE_THIS C++ macro as a workaround for error C4855: implicit capture of 'this' via '[=]' is deprecated in /std:c++20 in order to build the same lambda captures without extra #ifdefs on all supported engine versions.

Changed

• SenseGlove libraries have been updated to v2.12.0-19c9854.
• SGCoreImpl/SGPlatform has been moved to SGBuildHacks/SGPlatform.

Fixed

• Proper initialization of the SenseGlove backend in order to fix a bug in certain situations where SGConnect::Init() gets called every frame.
• Some other minor fixes and improvements.

[1.6.1] - 2023-08-14

Fixed

• Fix Unreal Engine 5.0 build issues.
• Minor documentation fixes.

[1.6.0] - 2023-08-14

Added

• Added support for the upcoming Unreal Engine 5.3.
• Now, the hand's velocity is applied to grabbed actors after being released from the hand.
• Introduce the real hands to the SenseGlove module (SGPawn) API.
• Added separation of the virtual and real hand rendering.

Fixed

• Fix the wrong default debug virtual hand gizmo colors when initialized using the default constructor.
• Some minor performance fixes and improvements.

Changed

• SenseGlove libraries have been updated to v2.11.0-b775a05.

[1.5.3] - 2023-07-19

This is a hotfix release mostly addressing Android Bluetooth performance issues.

Fixed

• Minor changelog fixes.

Changed

• SenseGlove libraries have been updated to v2.10.1-3b0e7c9.

[1.5.2] - 2023-07-19

This is a hotfix release mostly addressing Android-related issues.

Fixed

• Fix a build issue with Android shipping builds due to sgconnect.jar not getting copied automatically in the AFSProject which is compiled for shipping builds when AndroidFileServer (AFS) is enabled.
• Minor changelog fixes and some source code formatting fixes.

[1.5.1] - 2023-07-13

This is a hotfix release addressing a few critical issues introduced by the recent changes.

Fixed

• Fix a wrist tracker bug where left and right hands' wrist trackers are mistakenly tracking the opposite hand's motion source.
• Fix a bug where the right hand is not able to do grab or release.

[1.5.0] - 2023-06-16

This release breaks ABI/API compatibility with the previous versions in some areas as documented below.

Added

• Added HTC VIVE Focus 3 positional tracking hardware enum.
• Added support for the Meta Quest Pro, HTC VIVE, and HTC VIVE Focus 3 positional tracking hardware.
• Added two options to the wrist tracker settings (to the global plugin settings and the overrides in the wrist tracker component) in order to be able to specify a custom motion source for the left and right hands, so that it allows SteamVR-based trackers such as HTC VIVE or HTC VIVE Focus 3 to operate with the SGPawn.

Fixed

• Fix a bug where SteamVR trackers such as HTC VIVE and HTC VIVE Focus 3's wrist orientation and location were not being tracked.

Changed

• Fully refactored the top-level configurations in the settings system into USTRUCTs.
• SenseGlove libraries have been updated to v2.10.0-12133ac.

Removed

• Dropped support for the Epic Native Toolchain v19, MSVC v141 (Visual Studio 2017), and thus Unreal Engine 4.27 as it has been marked as deprecated since v1.4.x.
• Removed any kind of support for Oculus Touch (Oculus Rift S and Oculus Quest 1) positional tracking hardware, thus the enum as well.
• Removed any kind of support for Pico Neo 2 positional tracking hardware, thus the enum as well.
• Removed any kind of support for Pico Neo 3 positional tracking hardware, thus the enum as well.

[1.4.3] - 2023-06-01

This is a hotfix release addressing a critical Android crash.

Fixed

• Fix a critical Android crash that happens where the default development hand meshes are not found, which means almost always since we don't ship any default virtual hand mesh at the moment.
• Minor changelog release formatting fix in order to stay consistent.

[1.4.2] - 2023-06-01

This is a hotfix release addressing a few critical issues.

Fixed

• Fix build issues with certain compilers when the Unreal Engine version is older than 5.2.
• Reintroduced the Virtual Hand and the Wrist Tracker debug gizmos which have temporarily been disabled due to a bug in the settings system.
• Some minor changelog fixes.

[1.4.1] - 2023-05-29

This is a bugfix release with a focus on Android build issues.

Fixed

• Fix an Android Gradle build issue that happens when the game's package name won't start with com.senseglove.*.
• Suppress a grade warning for non-arm64 architectures when the build target is Android.

Removed

• Remove dead Gradle code from the Android module.

[1.4.0] - 2023-05-19

This release breaks ABI/API compatibility with the previous versions.

Added

• Added support for the stable release of Unreal Engine 5.2 (the preview release has been supported since v1.2.0).
• Added Linux AArch64 platform support.
• Added a new Grab component that can turn any actor into a grabbable object.
• Added a new Touch component that enables haptic feedback such as Buzz and Force-Feedback commands.
• Added an optional feature in order to automatically stop all haptics on the EndPlay event, wherever the virtual hand component is used. By default, it's enabled.

Fixed

• Fix Blueprint signatures for USGVirtualHandComponentKismetLibrary and make all the Blueprint exposed functions static.

Changed

• SenseGlove libraries have been updated to v2.7.1-965f90c with support for Linux AArch64.
• The Virtual Hand and the Wrist Tracker debug gizmos (the intended use is only for SenseGlove developers for really low-level stuff; thus won't affect the users of the plugin at all) have been disabled and will be ignored due to an esoteric bug in the settings systems which has been scheduled to be fixed in the future releases.

Removed

• Removed the redundant SenseGloveCoreTypes module which causes all kinds of packaging issues with certain versions of the engine.

Deprecated

• This is the last release to support Unreal Engine 4.27 and please keep in mind that the current release is not obtainable through the Unreal Engine Marketplace. The latest published version on the Marketplace for 4.27 is v1.3.1. Per Epic's Marketplace policy regarding Code Plugins, 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.

[1.3.1] - 2023-04-28

Fixed

• Fix RunUAT build issues caused by missing headers.
• Minor documentation fixes.

[1.3.0] - 2023-04-28

This release breaks ABI/API compatibility with the previous versions in addition to breaking coordinates systems conversions between Unreal Engine and the SenseGlove libraries.

Added

• A new generic SenseGlove Debug module.
• A debug virtual hand.

Fixed

• Fix the wrist tracker miscalculations for the Quest 2 controllers (other headsets might need fixing as well, in that case, future releases will address that).
• Minor code improvement and fixes.
• Minor documentation fixes.

Changed

• Breaking API/ABI changes in the Settings and the main SenseGlove module due to some settings refactoring.
• Breaking changes in the SenseGlove/Unreal coordinates systems conversions due to underlying changes in the SenseGlove Core Libraries.
• SenseGlove libraries have been updated to v2.6.0-aac3d56.

[1.2.1] - 2023-03-30

Fixed

• Fix RunUAT build issues with Android.

[1.2.0] - 2023-03-28

This release breaks ABI/API compatibility with the previous versions.

Added

• Android / Oculus on-device glove calibration.
• Introduced the animated Virtual Hand Model (as a set of virtual hand and wrist tracker components and an actor) with in-editor animation availability.
• Introduced SGPawn, SGPlayerController, SGGameModeBase, etc classes.
• Added an internal SenseGloveCoreTypes module in order to share common SenseGloveCore types between various modules.
• Segregated Android binaries for NDK r21e (UE 4.27 and 5.0) and r25b (UE 5.1, 5.2).
• Fully functional and stable Linux development support.
• Fully functional and stable Unreal Engine 5.2 preview support has been added.
• Added a Plugin's settings manager and two new modules SenseGloveSettings and SenseGloveSettingsKismet.

Changed

• SenseGlove libraries have been updated to the Linux-aware version: v2.5.0-8069342.
• API has changed to use degrees instead of radians.
• SGCoordinates utility class name has been changed to SGAngles and now the plugin API uses degrees in contrast of SenseGlove libraries by default.
• Migrate common nested array types into the SenseGloveTypes module from the SenseGloveCore module.

Removed

• Removed a few thousand lines of archaic pre-public-release dead code.
• Dropped Android NDK r21b binaries used by the older engine versions.
• Purged the dead code for dropped engine versions by v1.1.1 (4.22, 4.23, 4.24, 4.25, and 4.26) that carried over to the current version.
• Removed redundant SGConnectImpl/SGPlatform.
• Removed redundant SGTypes/SGConnectTypes.

Known Issues

• Wrist Tracker's offsets are a bit off (e.g. on Quest 2), scheduled to be fixed in the next patch release.

[1.1.1] - 2023-02-07

Added

• Initial support for the upcoming Unreal Engine 5.2.
• Add support for Android armeabi-v7a with neon, x86-64, and x86 builds in addition to arm64-v8a.

Fixed

• Fix various Android build issues.
• Some minor fixes and improvements.

Changed

• Bump SenseGlove libraries to v2.1.2-95ec6e7.

[1.1.0] - 2023-02-03

Added

• Whitelist Android as a target platform.
• Introduce Android support.
• Add third-party library SGConnect for Android v1.1.0.

Fixed

• Fix Android build issues caused by the log module.

Changed

• SGConnect and SGCore libraries have been updated to v2.1.1-0569c74.

Removed

• Removed the enum utils class due to ANY_PACKAGE deprecation warnings in Unreal Engine 5.1.
• Support for older versions of the Engine (namely, 4.22, 4.23, 4.24, 4.25, and 4.26) has been dropped.

[1.0.4] - 2022-12-02

This is a minor release focusing mostly on adherence to the Unreal Engine Marketplace Guidelines based on the feedback from Epic Games.

Added

• Added support for MSVC 2017

Changed

• Updated SenseGlove libraries (SGCore/SGConnect) to v2.0.4.

[1.0.3] - 2022-11-29

This is a minor release focusing on adherence to the Unreal Engine Marketplace Guidelines based on the feedback from Epic Games.

Changed

• Adjust Config/FilterPlugin.ini in order to conform to Epic's Market Place Guidelines.

[1.0.2] - 2022-11-27

This is a minor release focusing on adherence to the Unreal Engine Marketplace Guidelines based on the feedback from Epic Games.

Added

• Added the newly acquired Unreal Engine Market Place Offer ID to the .uplugin file.
• List the dotfiles inside the FilterPlugin.ini file as well.
• Add the copyright notice to the source files missing it.
• Add the SenseGlove SDK license to the third-party license file.

Fixed

• Fix the readme typos and errors.
• Minor fixes in the changelog for previous releases.

[1.0.1] - 2022-11-25

Changed

• Exposed SenseGloveTypes as a public dependency in SenseGloveConnect and SenseGloveCore modules, so that the C++ users of the API don't need to explicitly add it as a dependency.
• Cleaned up the redundant headers/modules dependencies from SGCore headers.

Fixed

• Fix RunUAT build issues prior to Epic Store submission.

[1.0.0] - 2022-11-24

Added

• Initial public release of the SenseGlove haptic API for Unreal Engine with support for Microsoft Windows and GNU/Linux.