migrate away from the deprecated FXRMotionControllerData in favor of FXRMotionControllerState and FXRHandTrackingState on UE 5.5+

Handbook/src/appendix/changelog.md

@@ -5,6 +5,40 @@ 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).
 
+## [Unreleased]
+
+This is a minor release with some breaking API and ABI changes, focusing mainly on migrating away from the deprecated `FXRMotionControllerData` in favor of `FXRMotionControllerState` and `FXRHandTrackingState` on Unreal Engine `5.5+`.
+
+### Added
+
+- Completed support for the upcoming Unreal Engine `5.5` release.
+- Added `USGVirtualHandComponent::GetMotionControllerState()` and the equivalent Blueprint function`UVirtualHandComponentKismetLibrary::GetMotionControllerState` on UE `5.5+`.
+- Added `USGVirtualHandComponent::GetHandTrackingState()` and the equivalent Blueprint function `UVirtualHandComponentKismetLibrary::GetHandTrackingState` on UE `5.5+`.
+- Added `USGWristTrackerComponent::GetMotionControllerState()` and the equivalent Blueprint function `UWristTrackerComponentKismetLibrary::GetMotionControllerState` on UE `5.5+`.
+- Added `USGWristTrackerComponent::GetHandTrackingState()` and the equivalent Blueprint function `UWristTrackerComponentKismetLibrary::GetHandTrackingState` on UE `5.5+`.
+- Added a variant of `FSGDebugVirtualHand::Draw()` and the equivalent Blueprint function `USGDebugVirtualHandKismetLibrary::Draw_FXRHandTrackingState()` which accept `FXRHandTrackingState` on UE `5.5+`.
+- Added the new member `bTracked` to the `FSGXRHandState` struct.
+- Added `FSGXRTracker::GetMotionControllerState()` and the equivalent Blueprint function `USGXRTrackerKismetLibrary::GetMotionControllerState()`.
+- Added `FSGXRTracker::GetHandTrackingState()` and the equivalent Blueprint function `USGXRTrackerKismetLibrary::GetHandTrackingState()`.
+
+### Fixed
+
+- Additional minor fixes and improvements that may not be listed here.
+
+### Changed
+
+- Replaced all internal usages of the `FXRMotionControllerData` struct with either `FXRMotionControllerState` or `FXRHandTrackingState` on UE `5.5+`.
+- Deprecated `USGVirtualHandComponent::GetMotionControllerData()` on UE `5.5+`.
+- Deprecated `USGWristTrackerComponent::GetMotionControllerData()` on UE `5.5+`.
+- Deprecated the variant of `FSGDebugVirtualHand::Draw()` which accepts `FXRMotionControllerData` as a parameter on UE `5.5+`.
+- Renamed `USGDebugVirtualHandKismetLibrary::Draw` to `USGDebugVirtualHandKismetLibrary::Draw_FXRMotionControllerData` for more clarification.
+- Renamed an `FSGXRHandState` member from `bReceivedJointPoses` to `bHasReceivedJointPoses`.
+- Changed the `FSGXRTracker::GetAllKeypointStates()` signature on UE `5.5+` to match the `IHandTracker` interface API changes.
+- The animation system on UE `5.5+` has been revamped to utilize `FXRHandTrackingState` instead of `FXRMotionControllerData`.
+- The wrist tracking system on UE `5.5+` has been revamped to utilize `FXRHandTrackingState` instead of `FXRMotionControllerData`.
+- The hand interaction manipulation on UE `5.5+` has been revamped to utilize `FXRHandTrackingState`.
+- The virtual hand debugging system on UE `5.5+` has been revamped to utilize `FXRHandTrackingState`.
+
 ## [2.1.3] - 2024-10-11
 
 ### Added

Handbook/src/appendix/planned-features-completion-status.md

@@ -1,6 +1,6 @@
 ## Planned Features Completion Status
 
-### Implemented as of v2.1.x
+### Implemented as of v2.2.x
 
 - [X] Full SenseGlove low-level core API access through Unreal C++.
 - [X] Full SenseGlove low-level core API access through Blueprint.
@@ -28,17 +28,18 @@
 - [X] C++/Blueprint interaction events such as OnGrabStateUpdated, OnTouchStateUpdated, OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch.
 - [X] A fall back to HMD and wrist tracker hardware auto-detection mechanism when automatic detection of the wrist tracker hardware is desired.
 - [X] OpenXR-compatible hand tracking (XR_EXT_hand_tracking) support.
-- [X] FXRMotionControllerData compatible hand animation system.
-- [X] FXRMotionControllerData compatible wrist tracking system.
-- [X] FXRMotionControllerData compatible hand interaction manipulation system.
+- [X] `FXRMotionControllerData` compatible hand animation system on UE versions `5.2`, `5.3`, and `5.4`.
+- [X] `FXRHandTrackingState` compatible hand animation system on UE versions `5.5+`.
+- [X] `FXRMotionControllerData` compatible wrist tracking system on UE versions `5.2`, `5.3`, and `5.4`.
+- [X] `FXRHandTrackingState` compatible wrist tracking system on UE versions `5.5+`.
+- [X] `FXRMotionControllerData` compatible hand interaction manipulation system on UE versions `5.2`, `5.3`, and `5.4`.
+- [X] `FXRHandTrackingState` compatible hand interaction manipulation system on UE versions `5.5+`.
 - [X] 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.
 - [X] 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.
 - [X] A flexible virtual hand animation system that can take the mesh bone's transforms into account for a more reliable hand animation.
 - [X] Ability to manage the Engine Scalability Settings through the SenseGlove plugin in order to change the graphics settings on the fly.
 
-### Upcoming features planned for the v2.2.x release
-
-- [ ] Migrating away from the deprecated `FXRMotionControllerData` in favor of `FXRMotionControllerState` and `FXRHandTrackingState`.
+### Upcoming features planned for the v2.3.x release
 
 ### Planned features long-term