improve the changelog formatting as much as possible
This commit is contained in:
Mamadou Babaei
+180
-179
@@ -34,6 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
- Added [SGBLE and SGBLExx Rust Dependency Licenses](../license/sgble-sgblexx-rust-dependencies.html).
|
||||
- Bumped the [mdbook-epub](https://github.com/Michael-F-Bryan/mdbook-epub) crate to [`cac03b7f4b151f106f7f05b13da4c33fc098dd2c`](https://github.com/Michael-F-Bryan/mdbook-epub/commit/cac03b7f4b151f106f7f05b13da4c33fc098dd2c).
|
||||
- List the third-party tutorials inside the [Extra Resources](../appendix/extra-resources.html#third-party-tutorials) section in a categorized manner.
|
||||
- Improved changelog formatting.
|
||||
- Additional minor fixes and improvements that may not be listed here.
|
||||
|
||||
## [2.4.2] - 2025-02-17
|
||||
@@ -253,7 +254,7 @@ This is a bugfix release with no actual plugin code changes, mostly addressing i
|
||||
|
||||
### Removed
|
||||
|
||||
- Removed Android NDK r25 armv7 and x86 dependencies brought back by mistake while merging v2.1.0 from the dev branch to the master branch.
|
||||
- Removed Android NDK `r25` `armv7` and `x86` dependencies brought back by mistake while merging `v2.1.0` from the dev branch to the master branch.
|
||||
|
||||
## [2.1.0] - 2024-08-16
|
||||
|
||||
@@ -262,92 +263,92 @@ This is a minor release focusing mainly on bringing OpenXR-compatible hand track
|
||||
### Added
|
||||
|
||||
- Added SenseGloveTracking and module which provides OpenXR-compatible hand tracking by implementing `XR_EXT_hand_tracking` support, HMD auto-detection, and SenseGlove device tracking.
|
||||
- Added USenseGloveTrackingKismet module in order to expose part of the SenseGloveTracking functionality to Blueprint.
|
||||
- Added FSGXRTracker, the underlying main class that implements the OpenXR compatibility.
|
||||
- Added USGXRTrackerKismetLibrary in order to allow Blueprint to retrieve the FXRMotionControllerData directly from our tracking module.
|
||||
- Added the SGTrackingTypes header to the SenseGloveTypes module in order to define and share SenseGloveTracking module types through this header across the plugin modules.
|
||||
- Added `USenseGloveTrackingKismet` module in order to expose part of the SenseGloveTracking functionality to Blueprint.
|
||||
- Added `FSGXRTracker`, the underlying main class that implements the OpenXR compatibility.
|
||||
- Added `USGXRTrackerKismetLibrary` in order to allow Blueprint to retrieve the `FXRMotionControllerData` directly from our tracking module.
|
||||
- Added the `SGTrackingTypes` header to the `SenseGloveTypes` module in order to define and share `SenseGloveTracking` module types through this header across the plugin modules.
|
||||
- A fallback to HMD and wrist tracker hardware auto-detection mechanism has been added to be triggered in situations when automatic detection of the wrist tracker hardware is desired, e.g., either by not setting it explicitly, or setting it to the default None value. Please note that this is still highly experimental and HTC VIVE Focus 3 and HTC XR Elite cannot be distinguished in the current iteration. Though, since the tracker devices and offsets for both headsets are the same in the end it does not make a difference if both headsets are detected as each other.
|
||||
- Added ESGHeadMountedDisplayDevice enum with supported HMDs list.
|
||||
- Added ESGViveHMDDetectionPriority enum in order to choose which headset we attempt to detect between VIVE Focus 3 and VIVE XR Elite as we cannot distinguish them, yet.
|
||||
- Added the FSGHMDTracker utility class, in order to easily gather information about the HMD device at runtime.
|
||||
- Added USGHMDTrackerKismetLibrary which exposes the equivalent C++ HMD auto-detection functionality to Blueprint.
|
||||
- Added FSGHMDTrackingSettings config struct.
|
||||
- Added the FSGGloveTracer utility class, in order to easily check the left or right glove connectivity or retrieve the connected glove instances.
|
||||
- Added USGGloveTrackerKismetLibrary which exposes the equivalent C++ functionality to Blueprint.
|
||||
- Added FSGGloveTrackingSettings config struct.
|
||||
- Added FSGTrackingSettings config struct.
|
||||
- Added FSGHandTrackingSettings config struct.
|
||||
- Added FSGWristTrackingDebuggingSettings config struct.
|
||||
- Added FSGVirtualHandSettings config struct.
|
||||
- Added FSGVirtualHandAnimationSettings config struct.
|
||||
- Added FSGVirtualHandDebuggingSettings config struct.
|
||||
- Added FSGVirtualHandGrabSettings config struct.
|
||||
- Added FSGVirtualHandHapticsSettings config struct.
|
||||
- Added FSGVirtualHandMeshSettings config struct.
|
||||
- Added FSGVirtualHandPhalangesLengthSettings config struct.
|
||||
- Added FSGVirtualHandTouchSettings config struct.
|
||||
- Added USGVirtualHandComponent::OnHandVisibilityChanged() event in order to notify other components/actors whenever the virtual hand mesh appears or disappears (for example, this could happen when a glove is connected/disconnected).
|
||||
- GetMotionControllerData() has been introduced to the USGVitualHandComponent in order to retrieve the OpenXR-compatible glove data in Unreal's FXRMotionControllerData format.
|
||||
- Added FSGVirtualHandAnimInstanceProxy::GetMotionControllerData and many more accessor methods usable only by child classes to allow consumption of the data required for manipulating the virtual hand mesh animations.
|
||||
- GetMotionControllerData() has been introduced to the USGWristTrackerComponent in order to retrieve the OpenXR-compatible glove data in Unreal's FXRMotionControllerData format.
|
||||
- Added USGGrabComponent::SimulatePhysics() method.
|
||||
- Added FSGDebugCube.
|
||||
- Added FSGDebugCubeSettings.
|
||||
- Added the SenseGloveDebugKismet module in order to allow drawing of debugging, cubes, gizmos, and virtual hands from Blueprint.
|
||||
- Added USGDebugCubeKismetLibrary in order to expose the FSGDebugCube functionalities to Blueprint.
|
||||
- Added USGDebugGizmoKismetLibrary in order to expose the FSGDebugGizmo functionalities to Blueprint.
|
||||
- Added USGDebugVirtualHandKismetLibrary in order to expose the FSGDebugVirtualHand functionalities to Blueprint.
|
||||
- Added a new static Draw() method overload to DebugGizmo which allows passing an FQuat instead of a FRotator.
|
||||
- Introduced a new FXRMotionControllerData compatible hand animation system with the ability to take the mesh bone's transforms into account for a more reliable hand animation.
|
||||
- Introduced a new FXRMotionControllerData compatible wrist tracking system.
|
||||
- Introduced a new FXRMotionControllerData compatible hand interaction manipulation system.
|
||||
- Added `ESGHeadMountedDisplayDevice` enum with supported HMDs list.
|
||||
- Added `ESGViveHMDDetectionPriority` enum in order to choose which headset we attempt to detect between VIVE Focus 3 and VIVE XR Elite as we cannot distinguish them, yet.
|
||||
- Added the `FSGHMDTracker` utility class, in order to easily gather information about the HMD device at runtime.
|
||||
- Added `USGHMDTrackerKismetLibrary` which exposes the equivalent C++ HMD auto-detection functionality to Blueprint.
|
||||
- Added `FSGHMDTrackingSettings` config struct.
|
||||
- Added the `FSGGloveTracer` utility class, in order to easily check the left or right glove connectivity or retrieve the connected glove instances.
|
||||
- Added `USGGloveTrackerKismetLibrary` which exposes the equivalent C++ functionality to Blueprint.
|
||||
- Added `FSGGloveTrackingSettings` config struct.
|
||||
- Added `FSGTrackingSettings` config struct.
|
||||
- Added `FSGHandTrackingSettings` config struct.
|
||||
- Added `FSGWristTrackingDebuggingSettings` config struct.
|
||||
- Added `FSGVirtualHandSettings` config struct.
|
||||
- Added `FSGVirtualHandAnimationSettings` config struct.
|
||||
- Added `FSGVirtualHandDebuggingSettings` config struct.
|
||||
- Added `FSGVirtualHandGrabSettings` config struct.
|
||||
- Added `FSGVirtualHandHapticsSettings` config struct.
|
||||
- Added `FSGVirtualHandMeshSettings` config struct.
|
||||
- Added `FSGVirtualHandPhalangesLengthSettings` config struct.
|
||||
- Added `FSGVirtualHandTouchSettings` config struct.
|
||||
- Added `USGVirtualHandComponent::OnHandVisibilityChanged()` event in order to notify other components/actors whenever the virtual hand mesh appears or disappears (for example, this could happen when a glove is connected/disconnected).
|
||||
- `GetMotionControllerData()` has been introduced to the `USGVitualHandComponent` in order to retrieve the OpenXR-compatible glove data in Unreal's `FXRMotionControllerData` format.
|
||||
- Added `FSGVirtualHandAnimInstanceProxy::GetMotionControllerData()` and many more accessor methods usable only by child classes to allow consumption of the data required for manipulating the virtual hand mesh animations.
|
||||
- `GetMotionControllerData()` has been introduced to the `USGWristTrackerComponent` in order to retrieve the OpenXR-compatible glove data in Unreal's `FXRMotionControllerData` format.
|
||||
- Added `USGGrabComponent::SimulatePhysics()` method.
|
||||
- Added `FSGDebugCube`.
|
||||
- Added `FSGDebugCubeSettings`.
|
||||
- Added the `SenseGloveDebugKismet` module in order to allow drawing of debugging, cubes, gizmos, and virtual hands from Blueprint.
|
||||
- Added `USGDebugCubeKismetLibrary` in order to expose the `FSGDebugCube` functionalities to Blueprint.
|
||||
- Added `USGDebugGizmoKismetLibrary` in order to expose the `FSGDebugGizmo` functionalities to Blueprint.
|
||||
- Added`USGDebugVirtualHandKismetLibrary` in order to expose the `FSGDebugVirtualHand` functionalities to Blueprint.
|
||||
- Added a new static `Draw()` method overload to `DebugGizmo` which allows passing an `FQuat` instead of a `FRotator`.
|
||||
- Introduced a new `FXRMotionControllerData` compatible hand animation system with the ability to take the mesh bone's transforms into account for a more reliable hand animation.
|
||||
- Introduced a new `FXRMotionControllerData` compatible wrist tracking system.
|
||||
- Introduced a new `FXRMotionControllerData` compatible hand interaction manipulation system.
|
||||
- Added the ability to fallback to hand tracking when a glove is not present and use the bare hands for interactions, or a combination of glove and hand tracking if no motion controller input is detected.
|
||||
- Added the SenseGlove grab/touch sockets one-click-setup ability on any Epic-compliant virtual hand mesh from within the Unreal Editor's Content Browser, Skeleton Editor, or Skeletal Mesh Editor by extending the Unreal Editor.
|
||||
- Added FSGAssetUtils editor-only class.
|
||||
- Added FSGContentBrowserExtension editor-only class.
|
||||
- Added FSGPluginStyle editor-only class.
|
||||
- Added FSGSocketsEditor editor-only class.
|
||||
- Added FSGSocketsEditorCommands editor-only class.
|
||||
- Added the FSGInitializationSettings config struct in order to control how the plugin is initialized.
|
||||
- Introduced the FSGGameUserSettings for managing the Engine Scalability Settings through the SenseGlove plugin in order to change the graphics settings on the fly.
|
||||
- Added USGGameUserSettingsKismetLibrary in order to allow all the Engine Scalability Settings to be managed from the Blueprint side.
|
||||
- Added FSGGameUserSettingsSettings config struct.
|
||||
- Added the SenseGlove console commands: SG_GetEngineScalabilitySettings() and SG_SetEngineScalabilitySettings(Scalability).
|
||||
- Added SGHardwareBenchmarkingSettings config struct.
|
||||
- Introduced ESGEngineScalabilitySettings enum.
|
||||
- Added FSGVirtualHandSettingsOverrides config struct used by the new settings override system.
|
||||
- Added SGWristTrackingSettingsOverrides config structured by the new settings override system.
|
||||
- Added support for Android API level 32 in addition to the API level 29.
|
||||
- Added `FSGAssetUtils` editor-only class.
|
||||
- Added `FSGContentBrowserExtension` editor-only class.
|
||||
- Added `FSGPluginStyle` editor-only class.
|
||||
- Added `FSGSocketsEdito`r editor-only class.
|
||||
- Added `FSGSocketsEditorCommands` editor-only class.
|
||||
- Added the `FSGInitializationSettings` config struct in order to control how the plugin is initialized.
|
||||
- Introduced the `FSGGameUserSettings` for managing the Engine Scalability Settings through the SenseGlove plugin in order to change the graphics settings on the fly.
|
||||
- Added `USGGameUserSettingsKismetLibrary` in order to allow all the Engine Scalability Settings to be managed from the Blueprint side.
|
||||
- Added `FSGGameUserSettingsSettings` config struct.
|
||||
- Added the SenseGlove console commands: `SG_GetEngineScalabilitySettings()` and `SG_SetEngineScalabilitySettings(Scalability)`.
|
||||
- Added `SGHardwareBenchmarkingSettings` config struct.
|
||||
- Introduced `ESGEngineScalabilitySettings` enum.
|
||||
- Added `FSGVirtualHandSettingsOverrides` config struct used by the new settings override system.
|
||||
- Added `SGWristTrackingSettingsOverrides` config structured by the new settings override system.
|
||||
- Added support for Android API level `32` in addition to the API level `29`.
|
||||
- Introduced the SenseGlove Unreal Engine Handbook as an attempt at documenting the SenseGlove Unreal Engine Plugin.
|
||||
- Merged the `pack` utility branch to the plugin's source code at `/Packager` which adds the SenseGlove Unreal Engine Marketplace Packager v0.4.0-a65bb20 binaries and configurations.
|
||||
- Merged the `pack` utility branch to the plugin's source code at `/Packager` which adds the SenseGlove Unreal Engine Marketplace Packager `v0.4.0-a65bb20` binaries and configurations.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed a bug when the virtual hand inside the game is not visible but still collides with other objects inside the scene, mistakenly triggering events like OnGrabStateUpdated and OnTouchStateUpdated.
|
||||
- Fixed a bug where USGGrabComponent's `bAffectPhysicsState` does not enables physics on its owning actor at `BeginPlay()`.
|
||||
- Fixed a bug when the virtual hand inside the game is not visible but still collides with other objects inside the scene, mistakenly triggering events like `OnGrabStateUpdated` and `OnTouchStateUpdated`.
|
||||
- Fixed a bug where `USGGrabComponent`'s `bAffectPhysicsState` does not enables physics on its owning actor at `BeginPlay()`.
|
||||
- Fixed various wrong Kismet script names and their class exports.
|
||||
- Fixed the display name for various overloads of the Blueprint-exposed function `Queue Command Vibro Level` to expose sensible display names.
|
||||
- Some Android UPL tweaks, permission, and build fixes.
|
||||
- Many other large and small fixes and improvements that might not be listed here.
|
||||
- A few small bugfixes that have already been backported to the v2.0.x series.
|
||||
- A few small bugfixes that have already been backported to the `v2.0.x` series.
|
||||
|
||||
### Changed
|
||||
|
||||
- Now, if bValidateIfDefaultClassesAreSGCompliant option from FSGInitializationSettings is enabled (default) the SenseGlove plugin checks for default SenseGlove-compliant GameMode, GameInstance, etc, at module initialization and tries to set to default, native SenseGlove classes, if any of those default classes are not a SenseGlove or a SenseGlove-derived class.
|
||||
- The USGSettings has been fully revamped with more customizations added and categorized in a different manner adding many new structs and removing some, in order to have fine-grained control over the various aspects and functionality of the plugin components.
|
||||
- The USGSettings constructor visibility has been changed from public to private.
|
||||
- The Settings override system has been overhauled as well affecting how we override settings from the USGVirtualHandComponent and USGWristTrackerComponent.
|
||||
- The SenseGlove libraries have been updated to v2.104.1-55fddbd2.
|
||||
- GetHandPose() has been replaced by GetMotionControllerData inside USGVirtualHandComponent (see the relevant entry in the Added and Removed sections).
|
||||
- Many functions inside USGVirtualHandComponent for retrieving bone names or reference transforms has been renamed to return different data types; e.g. GetLeftHandFingerBoneNames(), GetRightHandFingerBoneNames(), GetLeftHandFingerBoneName(), and GetRightHandFingerBoneName() renamed to GetLeftHandBoneNames(), GetRightHandBoneNames(), GetLeftHandBoneName(), and GetRightHandBoneName() respectively.
|
||||
- bHiddenInGameIfNoGloveDetected UPROPERTY from USGVirtualHandComponent has been renamed to bVisibleWhenHandDataUnavailable and accordingly all of its getters and setters; bVisibleWhenHandDataUnavailable = false now acts as bHiddenInGameIfNoGloveDetected = true, and vice-versa.
|
||||
- USGWristTrackerComponent now uses FXRMotionControllerData for wrist tracking instead of calculating the wrist location by calling the SenseGlove API.
|
||||
- FSGVirtualHandAnimInstanceProxy now relies on FXRMotionControllerData to animate the hands instead of a TMap of bone names and rotations which allows it to also apply the bone locations.
|
||||
- Now, if `bValidateIfDefaultClassesAreSGCompliant` option from `FSGInitializationSettings` is enabled (default) the SenseGlove plugin checks for default SenseGlove-compliant `GameMode`, `GameInstance`, etc, at module initialization and tries to set to default, native SenseGlove classes, if any of those default classes are not a SenseGlove or a SenseGlove-derived class.
|
||||
- The`USGSettings` has been fully revamped with more customizations added and categorized in a different manner adding many new structs and removing some, in order to have fine-grained control over the various aspects and functionality of the plugin components.
|
||||
- The `USGSettings` constructor visibility has been changed from public to private.
|
||||
- The Settings override system has been overhauled as well affecting how we override settings from the `USGVirtualHandComponent` and `USGWristTrackerComponent`.
|
||||
- The SenseGlove libraries have been updated to `v2.104.1-55fddbd2`.
|
||||
- `GetHandPose()` has been replaced by `GetMotionControllerData()` inside `USGVirtualHandComponent` (see the relevant entry in the Added and Removed sections).
|
||||
- Many functions inside `USGVirtualHandComponent` for retrieving bone names or reference transforms has been renamed to return different data types; e.g. `GetLeftHandFingerBoneNames()`, `GetRightHandFingerBoneNames()`, `GetLeftHandFingerBoneName()`, and `GetRightHandFingerBoneName()` renamed to `GetLeftHandBoneNames()`, `GetRightHandBoneNames()`, `GetLeftHandBoneName()`, and `GetRightHandBoneName()` respectively.
|
||||
- `bHiddenInGameIfNoGloveDetected` uproperty from `USGVirtualHandComponent` has been renamed to `bVisibleWhenHandDataUnavailable` and accordingly all of its getters and setters; `bVisibleWhenHandDataUnavailable = false` now acts as `bHiddenInGameIfNoGloveDetected = true`, and vice-versa.
|
||||
- `USGWristTrackerComponent` now uses `FXRMotionControllerData` for wrist tracking instead of calculating the wrist location by calling the SenseGlove API.
|
||||
- `FSGVirtualHandAnimInstanceProxy` now relies on `FXRMotionControllerData` to animate the hands instead of a `TMap` of bone names and rotations which allows it to also apply the bone locations.
|
||||
- The new OpenXR animation system now takes into account the mesh bone's transforms for a more reliable hand animation.
|
||||
- FSGDebugVirtualHand::Draw now accepts a FXRMotionControllerData parameter instead of all WristLocation, WristRotation, JointPositions, and JointRotations parameters.
|
||||
- FSGDebugVirtualHandSettings has been renamed to FSGVirtualHandDebuggingSettings.
|
||||
- The value for USGGrabComponent's AttachmentSocketName uproperty now defaults to the value of the plugin's GrabAttachPointSocketName instead of Name_NONE.
|
||||
- The USGGrabComponent now enables `bGravityEnabled`, `bSimulatePhysics`, and calls `WakeRigidBody` on its owning actor at `BeginPlay()` if `bAffectPhysicsState` is enabled.
|
||||
- `FSGDebugVirtualHand::Draw()` now accepts a `FXRMotionControllerData` parameter instead of all `WristLocation`, `WristRotation`, `JointPositions`, and `JointRotations` parameters.
|
||||
- `FSGDebugVirtualHandSettings` has been renamed to `FSGVirtualHandDebuggingSettings`.
|
||||
- The value for `USGGrabComponent`'s `AttachmentSocketName` uproperty now defaults to the value of the plugin's `GrabAttachPointSocketName` instead of `Name_NONE`.
|
||||
- The `SGGrabComponent` now enables `bGravityEnabled`, `bSimulatePhysics`, and calls `WakeRigidBody` on its owning actor at `BeginPlay()` if `bAffectPhysicsState` is enabled.
|
||||
- Updated the Directory Structure section of the main README file to reflect the latest toolchain support status.
|
||||
- The `/CHANGELOG.md` file has been migrated to `/Handbook/src/overview/changelog.md`
|
||||
- The `/LICENSE.md` file has been migrated to `/Handbook/src/license/senseglove-unreal-engine-plugin.md`
|
||||
@@ -362,19 +363,19 @@ This is a minor release focusing mainly on bringing OpenXR-compatible hand track
|
||||
|
||||
### Removed
|
||||
|
||||
- Dropped support for Unreal Engine 5.1 and Epic Native Toolchain v20 (used to build UE 5.0 and 5.1 Linux dependencies).
|
||||
- Dropped support for Unreal Engine `5.1` and Epic Native Toolchain `v20` (used to build UE `5.0` and `5.1` Linux dependencies).
|
||||
- Removed the Allbreaker virtual hand model as it's no longer compatible with the SenseGlove plugin.
|
||||
- Removed ASGVirtualHandActor as it was experimental and we no longer maintain it and haven't been doing so for a long time.
|
||||
- Removed FSGVirtualHandAnimInstanceProxy::GetBonesRotations().
|
||||
- Removed USGVirtualHandComponent::GetHandPose() and it's no longer possible to get the hand pose data from USGVirtualHandComponent as GetHandPose() has been removed. If you need it, you could always use the SenseGlove low-level API to retrieve it from the glove.
|
||||
- Removed also GetFingerBoneName(), GetFingerBoneRefTransform(), GetFingerBoneRefRotation() and GetFingerBoneRefRotation() from USGVirtualHandComponent.
|
||||
- Removed some remnants of UE 5.1 and older releases from the C++ code.
|
||||
- Removed `ASGVirtualHandActor` as it was experimental and we no longer maintain it and haven't been doing so for a long time.
|
||||
- Removed `FSGVirtualHandAnimInstanceProxy::GetBonesRotations()`.
|
||||
- Removed `USGVirtualHandComponent::GetHandPose()` and it's no longer possible to get the hand pose data from `USGVirtualHandComponent` as `GetHandPose()` has been removed. If you need it, you could always use the SenseGlove low-level API to retrieve it from the glove.
|
||||
- Removed also `GetFingerBoneName()`, `GetFingerBoneRefTransform()`, `GetFingerBoneRefRotation()` and `GetFingerBoneRefRotation()` from `USGVirtualHandComponent`.
|
||||
- Removed some remnants of UE `5.1` and older releases from the C++ code.
|
||||
- Removed the `pack` utility branch and merge it to the plugin's source code at `/Packager`.
|
||||
|
||||
### Known Issues
|
||||
|
||||
- With the new OpenXR release, the separation of the real and virtual hand rendering is broken. The reason is the animation system now uses the OpenXR data in the world transforms which yields better animations, but comes at the cost of overriding the the hand position set by the wrist tracker component's position and rotation. If `FXRMotionControllerData` is invalid and `bVisibleWhenHandDataUnavailable` is enabled for example, the system works as expected, since the animation system won't proceed to animate the hand meshes without valid `FXRMotionControllerData`. Since the animation system is only aware of the hand mesh it's animating versus the real hand and virtual hand meshes it means either it should become aware of the physics events like begin and end overlap events and also the real vs virtual hands, or it should resort back to animating the virtual hand meshes in local or component space. This release marks this feature as broken for now until we come up with a reasonable solution in the future.
|
||||
- The `UXRDeviceVisualizationComponent` provided by Unreal Engine is used in the SGPawn class as ControllerVisualizerLeft and ControllerVisualizerRight for implementing the wrist tracking hardware visualization feature. However, it is not compatible with the new OpenXR system in certain scenarios. For instance, when the motion controllers serve as wrist tracking hardware since the SenseGlove plugin is now introduced to the engine as an `OpenXRHandTracking` system, it causes the UXRDeviceVisualizationComponent to visualize the wrist tracking hardware at coordinates (0.0f, 0.0f, 0.0f) instead of their actual location and rotation in the world. This happens because the component incorrectly registers them as inactive, possibly because it's assumed hand tracking and motion controllers cannot be in use at the same time. Currently, we use this feature solely for debugging, and we have an alternative in the form of wrist-tracking debug gizmos, which can be toggled on or off via the settings system. In future releases, we might remove this feature due to its incompatibility, unless we find a solution to make the `UXRDeviceVisualizationComponent` work with the new system. Alternatively, we may develop our own version of the `UXRDeviceVisualizationComponent`.
|
||||
- The `UXRDeviceVisualizationComponent` provided by Unreal Engine is used in the `SGPawn` class as `ControllerVisualizerLeft` and `ControllerVisualizerRight` for implementing the wrist tracking hardware visualization feature. However, it is not compatible with the new OpenXR system in certain scenarios. For instance, when the motion controllers serve as wrist tracking hardware since the SenseGlove plugin is now introduced to the engine as an `OpenXRHandTracking` system, it causes the `UXRDeviceVisualizationComponent` to visualize the wrist tracking hardware at coordinates (`0.0f`, `0.0f`, `0.0f`) instead of their actual location and rotation in the world. This happens because the component incorrectly registers them as inactive, possibly because it's assumed hand tracking and motion controllers cannot be in use at the same time. Currently, we use this feature solely for debugging, and we have an alternative in the form of wrist-tracking debug gizmos, which can be toggled on or off via the settings system. In future releases, we might remove this feature due to its incompatibility, unless we find a solution to make the `UXRDeviceVisualizationComponent` work with the new system. Alternatively, we may develop our own version of the `UXRDeviceVisualizationComponent`.
|
||||
- Although the SenseGlove OpenXR implementation is fully compatible with the `IOpenXRHMD` interface and the `FOpenXRHMD` `XRTrackingSystem`, it is not compatible with the `FOculusXRHMD` backend provided by the Meta XR plugin. The same issue likely applies to the VIVE OpenXR plugin. So, if these plugins are enabled in your project, the SenseGlove OpenXR will not function as intended, effectively breaking the plugin's functionality. It seems these plugins are necessary in order to make the fallback to the hand-tracking feature work on Android. While we may add support and compatibility with Meta XR and VIVE OpenXR plugins in the future, for the time being, if your project requires these plugins, we advise continuing with the `v2.0.x` release of the SenseGlove Unreal Engine plugin until this issue is addressed.
|
||||
|
||||
## [2.0.8] - 2024-07-15
|
||||
@@ -383,23 +384,23 @@ This is a bugfix release that contains a somewhat important bugfix backported fr
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fix a bug where the SGPawn right-hand grab colliders' default size is mistakenly set to the default value for the left-hand grab colliders at CDO initialization time.
|
||||
- Fix a bug where the `SGPawn` right-hand grab colliders' default size is mistakenly set to the default value for the left-hand grab colliders at CDO initialization time.
|
||||
|
||||
## [2.0.7] - 2024-05-29
|
||||
|
||||
This is a bugfix release with no actual plugin code changes, only fixing issues with binary assets incompatible with UE versions earlier than 5.4.
|
||||
This is a bugfix release with no actual plugin code changes, only fixing issues with binary assets incompatible with UE versions earlier than `5.4`.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Make the Allbreaker assets compatible with UE5.1+ again as the v2.0.5 update breaks compatibility with UE versions earlier than 5.4, thus leaving the engine unable to load those assets.
|
||||
- Make the Allbreaker assets compatible with UE5.1+ again as the `v2.0.5` update breaks compatibility with UE versions earlier than `5.4`, thus leaving the engine unable to load those assets.
|
||||
|
||||
## [2.0.6] - 2024-05-29
|
||||
|
||||
This is a bugfix release with no actual plugin code changes, only removing development/test assets from UE 5.3 that were never meant to be shipped.
|
||||
This is a bugfix release with no actual plugin code changes, only removing development/test assets from UE `5.3` that were never meant to be shipped.
|
||||
|
||||
### Removed
|
||||
|
||||
- Removed the dev/test virtual hand models that leaked into the 5.3 branch.
|
||||
- Removed the dev/test virtual hand models that leaked into the `5.3` branch.
|
||||
|
||||
### Fixed
|
||||
|
||||
@@ -418,21 +419,21 @@ This is a bugfix release with no actual plugin's code change.
|
||||
### Fixed
|
||||
|
||||
- Fix our in-house Unreal Engine Marketplace submission tool's configurations where the Content folder (containing the Allbreaker hand model) is mistakenly ignored during the submission. This release reintroduces the Virtual Hand Model and its material missing from the previous release.
|
||||
- Fix the SenseGlove.uproject's wrong versioning submitted to the Unreal Engine Marketplace.
|
||||
- Fix the `SenseGlove.uproject`'s wrong versioning submitted to the Unreal Engine Marketplace.
|
||||
|
||||
## [2.0.3] - 2024-05-15
|
||||
|
||||
This is a bugfix release addressing mostly RunUAT build issues on Unreal Engine 5.4.
|
||||
This is a bugfix release addressing mostly RunUAT build issues on Unreal Engine `5.4`.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fix UE 5.4 RunUAT build issue: "Asking CppCompileEnvironment for a single Architecture, but it has multiple Architectures (arm64, x64)", affecting SenseGloveConnectImpl and SenseGloveCoreImpl modues.
|
||||
- Improved target platform detection when building SenseGloveConnectImpl and SenseGloveCoreImpl modules and also distinguishing the x64 builds from arm64 on Microsoft Windows.
|
||||
- Fix other UE 5.4 RunUAT build issues, mostly caused by missing headers.
|
||||
- Fix UE `5.4` RunUAT build issue: "Asking CppCompileEnvironment for a single Architecture, but it has multiple Architectures (arm64, x64)", affecting `SenseGloveConnectImpl` and `SenseGloveCoreImpl` modues.
|
||||
- Improved target platform detection when building `SenseGloveConnectImpl` and `SenseGloveCoreImpl` modules and also distinguishing the `x64` builds from `arm64` on Microsoft Windows.
|
||||
- Fix other UE `5.4` RunUAT build issues, mostly caused by missing headers.
|
||||
|
||||
### Removed
|
||||
|
||||
- Removed support for Android armeabi-v7a and x86 architectures as they are no longer supported by the supported engine versions.
|
||||
- Removed support for Android `armeabi-v7a` and `x86` architectures as they are no longer supported by the supported engine versions.
|
||||
|
||||
## [2.0.2] - 2024-04-25
|
||||
|
||||
@@ -440,11 +441,11 @@ This is a patch release with no code changes.
|
||||
|
||||
### Added
|
||||
|
||||
- Introduce official Unreal Engine 5.4 support to the Unreal Engine Marketplace.
|
||||
- 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.
|
||||
- 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
|
||||
|
||||
@@ -452,15 +453,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.
|
||||
- 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 `SenseGloveKismet/Public/SGKismet/`.
|
||||
|
||||
### 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.
|
||||
- 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
|
||||
|
||||
@@ -471,37 +472,37 @@ This is the second major release of the SenseGlove Unreal Engine Plugin adding s
|
||||
- Added support for the SenseGlove Nova 2 devices.
|
||||
- Added support for Quest 3 controllers.
|
||||
- Various classes have been added to the API in order to implement the new functionalities and features from the latest upstream SenseGlove libraries.
|
||||
- Added initial support for the upcoming Unreal Engine 5.4 release.
|
||||
- Added initial support for the upcoming Unreal Engine `5.4` release.
|
||||
- Added a pair of default production-ready virtual hand meshes for the left and right hands, courtesy of [Allbreaker LLC Columbia](https://www.allbreaker.co/). For usage and redistribution, please consult the [LICENSE-THIRD-PARTY.md](LICENSE-THIRD-PARTY.md) file.
|
||||
|
||||
### Fixed
|
||||
|
||||
- A few critical bug fixes that have already been backported to the v1.x.x series through v1.9.3 to v1.9.8 releases.
|
||||
- Revamped the way we do FVector <-> SGVect3D, FQuat <-> SGQuat, and SenseGlove <-> Unreal Engine angles conversions in order to properly translate between the SenseGlove and Unreal Engine coordinate systems.
|
||||
- A few critical bug fixes that have already been backported to the `v1.x.x` series through `v1.9.3` to `v1.9.8` releases.
|
||||
- Revamped the way we do `FVector` <-> `SGVect3D`, `FQuat` <-> `SGQuat`, and SenseGlove <-> Unreal Engine angles conversions in order to properly translate between the SenseGlove and Unreal Engine coordinate systems.
|
||||
- Allow the C++ compiler the opportunity to perform RVO/NRVO if applicable.
|
||||
- Fix the modules' order inside the .uplugin file.
|
||||
- Fix a build issue inside FSGArrayUtils::FromStdVector introduced by newer MVSC updates due to stricter implicit uint64 to int32 conversions.
|
||||
- Fix a build issues inside FSGArrayUtils when performing non-Unity builds due to the missing <string> header.
|
||||
- Fix other build issues in USGDevice, USGNovaGloveSensorData, FSGDeviceImpl, and FSGSenseGloveVarsImpl when performing non-Unity builds due to the missing relevant headers.
|
||||
- Fix the modules' order inside the `.uplugin` file.
|
||||
- Fix a build issue inside `FSGArrayUtils::FromStdVector()` introduced by newer MVSC updates due to stricter implicit `uint64` to `int32` conversions.
|
||||
- Fix a build issues inside `FSGArrayUtils` when performing non-Unity builds due to the missing `<string>` header.
|
||||
- Fix other build issues in `USGDevice`, `USGNovaGloveSensorData`, `FSGDeviceImpl`, and `FSGSenseGloveVarsImpl` when performing non-Unity builds due to the missing relevant headers.
|
||||
- Fix changelog formatting.
|
||||
- Some other improverment and fixes.
|
||||
|
||||
### Changed
|
||||
|
||||
- SenseGlove libraries have been updated to v2.101.12-62b1be11.
|
||||
- SenseGlove libraries have been updated to `v2.101.12-62b1be11`.
|
||||
- The SenseGlove Unreal Engine Plugin now declares the OpenXR plugin as a dependency, so that the OpenXR plugin will be enabled automatically as soon as the SenseGlove Unreal Engine Plugin gets enabled.
|
||||
- Various classes and parts of the API have been changed in order to reflect and adhere to upstream SenseGlove libraries.
|
||||
- Reverse the Platform Support Matrix order from newer Unreal Engine versions to the older ones.
|
||||
- Clarify the engine support policy in the main readme file by adding the corresponding references from the Epic Marketplace Guidelines and a URL to their guidelines page.
|
||||
- The SGTouchComponent uproperties BuzzDuration and BuzzLevel now utilize different different names in order to correspond to the underlying API changes. They have been renamed to VibrotactileDuration and VibrotacktileLevel.
|
||||
- The SGTouchComponent uproperties ForceFeedbackLevel and BuzzLevel (now VibrotacktileLevel) parameters type have changed from int32 to float with the value range varying between 0.0f to 1.0f instead of 1 to 100 in order to correspond to the underlying API changes.
|
||||
- The SGVirtualHandComponent now assumes the default grab point's name as GenericGrabPoint instead of GrabPoint as default if not specified in the Unreal Blueprint Editor.
|
||||
- The SGPawn on UE 5.2+ now utilizes UXRDeviceVisualizationComponent in order to properly display the controller meshes shipped with Unreal Engine's OpenXR plugin, or a user-provided mesh. On UE 5.1 this could still be set on the WristTrackerLeft and WristTrackerRight components. Please note that despite the fact that on UE 5.2+ it's still possible to utilize the WristTrackerLeft and WristTrackerRight for setting the controller meshes, this has been deprecated in UE 5.2+ and is no longer supported.
|
||||
- The `SGTouchComponent` uproperties BuzzDuration and BuzzLevel now utilize different different names in order to correspond to the underlying API changes. They have been renamed to `VibrotactileDuration` and `VibrotactileLevel`.
|
||||
- The `SGTouchComponent` uproperties ForceFeedbackLevel and BuzzLevel (now `VibrotactileLevel`) parameters type have changed from `int32` to `float` with the value range varying between `0.0f` to `1.0f` instead of `1` to `100` in order to correspond to the underlying API changes.
|
||||
- The `SGVirtualHandComponent` now assumes the default grab point's name as `GenericGrabPoint` instead of `GrabPoint` as default if not specified in the Unreal Blueprint Editor.
|
||||
- The `SGPawn` on UE `5.2+` now utilizes `UXRDeviceVisualizationComponent` in order to properly display the controller meshes shipped with Unreal Engine's OpenXR plugin, or a user-provided mesh. On UE `5.1` this could still be set on the `WristTrackerLeft` and `WristTrackerRight` components. Please note that despite the fact that on UE `5.2+` it's still possible to utilize the `WristTrackerLeft` and `WristTrackerRight` for setting the controller meshes, this has been deprecated in UE `5.2+` and is no longer supported.
|
||||
|
||||
### Removed
|
||||
|
||||
- Various classes and parts of the API have been removed in order to reflect and adhere to upstream SenseGlove libraries.
|
||||
- Removed the redundant SGIC_int32_Ref interop type.
|
||||
- Removed the redundant `SGIC_int32_Ref` interop type.
|
||||
|
||||
## [1.9.8] - 2024-03-12
|
||||
|
||||
@@ -510,14 +511,14 @@ This is a bugfix release that contains bugfixes backported from the next major r
|
||||
### Fixed
|
||||
|
||||
- Fix a bug where the right-hand mesh is always hidden inside the game no matter whether the right glove is connected or not.
|
||||
- Fix a crash inside the USGHandPose::FromHandAngles method.
|
||||
- Some performance optimizations by utilizing MoveTemp in return statements.
|
||||
- Fix a crash inside the `USGHandPose::FromHandAngles()` method.
|
||||
- Some performance optimizations by utilizing `MoveTemp` in return statements.
|
||||
- Some improvements applied to the source code.
|
||||
- Some other minor fixes.
|
||||
|
||||
### Changed
|
||||
|
||||
- The BonesRotations TMap is no longer a public field of FSGVirtualHandAnimInstanceProxy and instead could be retrieved by calling the GetBonesRotations() method.
|
||||
- The BonesRotations TMap is no longer a public field of `FSGVirtualHandAnimInstanceProxy` and instead could be retrieved by calling the `GetBonesRotations()` method.
|
||||
|
||||
## [1.9.7] - 2024-02-18
|
||||
|
||||
@@ -525,8 +526,8 @@ This is a bugfix release that contains bugfixes backported from the next major r
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fix various bugs inside the SGPlayerController which occur when the thumb and pinky fingers are simultaneously touching different SGTouchComponents, or only one of them is in touch with such a component. In this case pinky's buzz and force-feedback levels are determined from the SGTouchComponent that is in collision with the thumb instead of the one that is touched by the pinky. Or, the pinky could ignore the buzz and force-feedback level if the thumb is not in collision with an SGTouchComponent. Or, the pinky could have reacted with a buzz or force feedback while only the thumb is in contact with an SGTouchComponent.
|
||||
- Fix the BuzzDuration UPROPERTY range in order not to get clamped at 100.0f and also use float values for ClampMin and UIMin specifiers instead of integer values.
|
||||
- Fix various bugs inside the `SGPlayerController` which occur when the thumb and pinky fingers are simultaneously touching different `SGTouchComponents`, or only one of them is in touch with such a component. In this case pinky's buzz and force-feedback levels are determined from the `SGTouchComponent` that is in collision with the thumb instead of the one that is touched by the pinky. Or, the pinky could ignore the buzz and force-feedback level if the thumb is not in collision with an `SGTouchComponent`. Or, the pinky could have reacted with a buzz or force feedback while only the thumb is in contact with an `SGTouchComponent`.
|
||||
- Fix the `BuzzDuration` uproperty range in order not to get clamped at `100.0f` and also use `float` values for `ClampMin` and `UIMin` specifiers instead of integer values.
|
||||
|
||||
## [1.9.6] - 2024-02-14
|
||||
|
||||
@@ -534,7 +535,7 @@ 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.
|
||||
- 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
|
||||
|
||||
@@ -542,7 +543,7 @@ 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.
|
||||
- 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
|
||||
|
||||
@@ -550,7 +551,7 @@ This is a bugfix release addressing mostly Blueprint API issues with ABI breakin
|
||||
|
||||
### 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.
|
||||
- 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
|
||||
@@ -559,15 +560,15 @@ This is a hotfix release addressing a few critical issues that might result in c
|
||||
|
||||
### 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.
|
||||
- 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.
|
||||
- Fix the wrong version numbers inside the paltform support matrix and the main `.uplugin` file.
|
||||
- Minor changelog fixes.
|
||||
- Bumped the copyright years.
|
||||
|
||||
@@ -579,69 +580,69 @@ This is a hotfix release addressing a few critical issues that might result in c
|
||||
|
||||
### Fixed
|
||||
|
||||
- A bug where the released actor is going to be NULL whenever the OnActorReleased event fires.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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 `#ifdef`s on all supported engine versions.
|
||||
|
||||
### Changed
|
||||
|
||||
- SenseGlove libraries have been updated to v2.12.0-19c9854.
|
||||
- SGCoreImpl/SGPlatform has been moved to SGBuildHacks/SGPlatform.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- Introduce the real hands to the `SenseGlove` module (`SGPawn`) API.
|
||||
- Added separation of the virtual and real hand rendering.
|
||||
|
||||
### Fixed
|
||||
@@ -651,7 +652,7 @@ This is a hotfix release addressing a few critical issues that might result in c
|
||||
|
||||
### Changed
|
||||
|
||||
- SenseGlove libraries have been updated to v2.11.0-b775a05.
|
||||
- SenseGlove libraries have been updated to `v2.11.0-b775a05`.
|
||||
|
||||
## [1.5.3] - 2023-07-19
|
||||
|
||||
@@ -663,7 +664,7 @@ This is a hotfix release mostly addressing Android Bluetooth performance issues.
|
||||
|
||||
### Changed
|
||||
|
||||
- SenseGlove libraries have been updated to v2.10.1-3b0e7c9.
|
||||
- SenseGlove libraries have been updated to `v2.10.1-3b0e7c9`.
|
||||
|
||||
## [1.5.2] - 2023-07-19
|
||||
|
||||
@@ -671,7 +672,7 @@ 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.
|
||||
- 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
|
||||
@@ -691,7 +692,7 @@ This release breaks ABI/API compatibility with the previous versions in some are
|
||||
|
||||
- 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.
|
||||
- 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
|
||||
|
||||
@@ -699,12 +700,12 @@ This release breaks ABI/API compatibility with the previous versions in some are
|
||||
|
||||
### Changed
|
||||
|
||||
- Fully refactored the top-level configurations in the settings system into USTRUCTs.
|
||||
- SenseGlove libraries have been updated to v2.10.0-12133ac.
|
||||
- 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.
|
||||
- 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.
|
||||
@@ -724,7 +725,7 @@ 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.
|
||||
- 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.
|
||||
|
||||
@@ -747,19 +748,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 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.
|
||||
- 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.
|
||||
- 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
|
||||
@@ -768,7 +769,7 @@ This release breaks ABI/API compatibility with the previous versions.
|
||||
|
||||
### 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.
|
||||
- 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 three 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
|
||||
|
||||
@@ -794,9 +795,9 @@ This release breaks ABI/API compatibility with the previous versions in addition
|
||||
|
||||
### Changed
|
||||
|
||||
- Breaking API/ABI changes in the Settings and the main SenseGlove module due to some settings refactoring.
|
||||
- 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.
|
||||
- SenseGlove libraries have been updated to `v2.6.0-aac3d56`.
|
||||
|
||||
## [1.2.1] - 2023-03-30
|
||||
|
||||
@@ -810,29 +811,29 @@ This release breaks ABI/API compatibility with the previous versions.
|
||||
|
||||
### Added
|
||||
|
||||
- Android / Oculus on-device glove calibration.
|
||||
- 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).
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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
|
||||
|
||||
@@ -842,8 +843,8 @@ This release breaks ABI/API compatibility with the previous versions.
|
||||
|
||||
### 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.
|
||||
- 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
|
||||
|
||||
@@ -852,7 +853,7 @@ This release breaks ABI/API compatibility with the previous versions.
|
||||
|
||||
### Changed
|
||||
|
||||
- Bump SenseGlove libraries to v2.1.2-95ec6e7.
|
||||
- Bump SenseGlove libraries to `v2.1.2-95ec6e7`.
|
||||
|
||||
## [1.1.0] - 2023-02-03
|
||||
|
||||
@@ -860,7 +861,7 @@ This release breaks ABI/API compatibility with the previous versions.
|
||||
|
||||
- Whitelist Android as a target platform.
|
||||
- Introduce Android support.
|
||||
- Add third-party library SGConnect for Android v1.1.0.
|
||||
- Add third-party library SGConnect for Android `v1.1.0`.
|
||||
|
||||
### Fixed
|
||||
|
||||
@@ -868,12 +869,12 @@ This release breaks ABI/API compatibility with the previous versions.
|
||||
|
||||
### Changed
|
||||
|
||||
- SGConnect and SGCore libraries have been updated to v2.1.1-0569c74.
|
||||
- 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.
|
||||
- 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
|
||||
|
||||
@@ -881,11 +882,11 @@ This is a minor release focusing mostly on adherence to the Unreal Engine Market
|
||||
|
||||
### Added
|
||||
|
||||
- Added support for MSVC 2017
|
||||
- Added support for MSVC 2017.
|
||||
|
||||
### Changed
|
||||
|
||||
- Updated SenseGlove libraries (SGCore/SGConnect) to v2.0.4.
|
||||
- Updated SenseGlove libraries (SGCore/SGConnect) to `v2.0.4`.
|
||||
|
||||
## [1.0.3] - 2022-11-29
|
||||
|
||||
@@ -901,7 +902,7 @@ This is a minor release focusing on adherence to the Unreal Engine Marketplace G
|
||||
|
||||
### Added
|
||||
|
||||
- Added the newly acquired Unreal Engine Market Place Offer ID to the .uplugin file.
|
||||
- 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.
|
||||
@@ -926,4 +927,4 @@ This is a minor release focusing on adherence to the Unreal Engine Marketplace G
|
||||
|
||||
### Added
|
||||
|
||||
- Initial public release of the SenseGlove haptic API for Unreal Engine with support for Microsoft Windows and GNU/Linux.
|
||||
- Initial public release of the SenseGlove haptic API for Unreal Engine with support for Microsoft Windows and GNU/Linux.
|
||||
Reference in New Issue
Block a user