Merge branch 'release/5.11.0' into 'main'

Release 5.11.0

See merge request xr/integrations/unityplugin!273

Author: MattGrayUH2

.gitlab/merge_request_templates/default.md

@@ -20,12 +20,13 @@ _These tasks are for the merge request creator to tick off when creating a merge
 - [ ] Ensure documentation requirements are met e.g., public API is commented.
 - [ ] Consider any licensing/other legal implications for this MR e.g. notices required by any new libraries.
 - [ ] Add any relevant labels such as `breaking` to this MR.
+- [ ] If this MR closes a Jira issue, make sure the fix version on the JIRA issue is set to the correct one.
 
 ## Reviewer Tasks
 
 _Add any instructions or tasks for the reviewer such as specific test considerations before this can be merged._
 
-[Use emojis in review threads to communicate intent and help contributors.](../../CONTRIBUTING.md#review-threads)
+[Use emojis in review threads to communicate intent and help contributors.](https://gitlab.ultrahaptics.com/xr/integrations/unityplugin/-/blob/develop/CONTRIBUTING.md#review-threads)
 
 - [ ] Code reviewed.
 - [ ] Non-code assets e.g. Unity assets/scenes reviewed.

.gitlab/merge_request_templates/lightweight.md

@@ -13,12 +13,13 @@ _These tasks are for the merge request creator to tick off when creating a merge
 - [ ] Pair review with a member of the QA team.
 - [ ] Add any release testing considerations to the MR for the next release.
 - [ ] Consider any licensing/other legal implications for this MR e.g. notices required by any new libraries.
+- [ ] If this MR closes a Jira issue, make sure the fix version on the JIRA issue is set to the correct one.
 
 ## Reviewer Tasks
 
 _Add any instructions or tasks for the reviewer such as specific test considerations before this can be merged._
 
-[Use emojis in review threads to communicate intent and help contributors.](../../CONTRIBUTING.md#review-threads)
+[Use emojis in review threads to communicate intent and help contributors.](https://gitlab.ultrahaptics.com/xr/integrations/unityplugin/-/blob/develop/CONTRIBUTING.md#review-threads)
 
 - [ ] Code reviewed.
 - [ ] Non-code assets e.g. Unity assets/scenes reviewed.

.gitlab/merge_request_templates/release.md

@@ -2,19 +2,13 @@
 
 This merge request template is for release merge requests.
 
-## Summary
-
-_Summary of the purpose of this merge request._
-
 ## Release Tasks
 
 _These tasks are for the merge request creator to tick off when creating a merge request._
 
 - [ ] Run through the pre-release steps on [Confluence](https://ultrahaptics.atlassian.net/wiki/spaces/SV/pages/3665625233). The rest of the process continues after this merge request is merged.
 - [ ] Check any relevant CHANGELOG files have been updated.
 - [ ] Ensure documentation requirements are met e.g., public API is commented.
-- [ ] Consider any licensing/other legal implications for this MR e.g. notices required by any new libraries.
-- [ ] Add any relevant labels such as `breaking` to this MR.
 - [ ] Ensure package.json files are updated with new package versions and any changes dependency versions.
 - [ ] If this is a major release, action any `Obsolete` items and other breaking considerations.
 - [ ] Check that additional release tasks for each MR contributing to this release have been considered.
@@ -25,6 +19,6 @@ _This task list should be populated from MRs contributing to this release. Can i
 
 - [ ] 
 
-## Closes JIRA Issue
+## JIRA Release
 
-_If this MR closes any JIRA issues list them below in the form `Closes PROJECT-#`_
+_Link to the Jira release for this version. See the [releases page](https://ultrahaptics.atlassian.net/projects/UNITY?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page)._

Packages/Tracking OpenXR/CHANGELOG.md

@@ -6,11 +6,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [docs-website]: https://docs.ultraleap.com/ "Ultraleap Docs"
 
+## [1.0.0-pre.5] - unreleased
+
+### Added
+
+- Added support for `XR_ULTRALEAP_hand_tracking_elbow` which provides elbow tracking if supported on the system.
+
+### Known issues
+
+- Currently the Ultraleap Hand Tracking feature for OpenXR requires the New and Legacy input systems to be enabled, to simultaneously use OpenXR and the Ultraleap Unity Plugin's features.
+- The OpenXR Leap Provider does not currently support the following hand properties (and will return fixed values):
+  - Hand and Finger: `FrameId`
+  - Hand: `Confidence`
+  - Hand: `GrabAngle`
+  - Hand and Finger: `Id` & `HandId` will always return `0` and `1` for the left and right hand respectively
+  - Hand and Finger: `TimeVisible`
+  - Finger: `IsExtended`
+
 ## [1.0.0-pre.4] - 10/06/2022
 
 ### Fixed
 
-- Fixed Hand data provided via the OpenXR Leap Provider was always relative to the scene origin. It now respects any parent transforms applied to the main camera and works correctly with `Tracked Pose Driver`
+- Fixed Hand data provided via the OpenXR Leap Provider was always relative to the scene origin. It now respects any parent transforms applied to the main camera and works correctly with `Tracked Pose Driver`.
 
 ### Known issues
 

Packages/Tracking OpenXR/Runtime/Plugins/android/UltraleapOpenXRUnity.aar

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:2ae7ce5306e1613c1eb213bf59b9ebf557f800934e349a9048e0c409263c5601
-size 33280
+oid sha256:08702946b030636824c139d682f3cb25ed02d35d044a6173ac0fd5242dcd3667
+size 34816

Packages/Tracking OpenXR/Runtime/Plugins/x64/UltraleapOpenXRUnity.dll

@@ -34,7 +34,7 @@ private HandTracker(Handedness handedness)
         /// The current <see cref="HandJointSet"/> that this tracker is tracking.
         /// </summary>
         [PublicAPI]
-        public HandJointSet JointSet => HandJointSet.Default;
+        public HandJointSet JointSet => _handTracking.JointSet;
 
         /// <summary>
         /// The number of joints in the <see cref="JointSet"/> that this tracker is tracking.
@@ -143,6 +143,7 @@ public enum HandJoint
         Elbow
     }
 
+    [PublicAPI]
     public enum HandJointSet
     {
         /// <summary>
@@ -154,7 +155,7 @@ public enum HandJointSet
         /// Default hand-set with the addition of the elbow joint on the forearm.
         /// <remarks>This requires the Ultraleap extension <code>XR_ULTRALEAP_hand_tracking_forearm</code></remarks>
         /// </summary>
-        HandWithForearm = 1000149000
+        [PublicAPI] HandWithForearm = 1000149000
     }
 
     /// <summary>

Packages/Tracking OpenXR/Runtime/Scripts/HandTracker.cs

@@ -24,7 +24,7 @@ namespace Ultraleap.Tracking.OpenXR
         Desc = "Articulated hands using XR_EXT_hand_tracking",
         Category = FeatureCategory.Feature,
         Required = false,
-        OpenxrExtensionStrings = "XR_EXT_hand_tracking",
+        OpenxrExtensionStrings = "XR_EXT_hand_tracking XR_ULTRALEAP_hand_tracking_forearm",
         BuildTargetGroups = new[] {BuildTargetGroup.Standalone, BuildTargetGroup.Android}
     )]
 #endif
@@ -59,7 +59,7 @@ private static class Native
             internal static extern void OnAppSpaceChange(ulong xrSpace);
 
             [DllImport(NativeDLL, EntryPoint = NativePrefix + "CreateHandTrackers", ExactSpelling = true)]
-            internal static extern int CreateHandTrackers();
+            internal static extern int CreateHandTrackers(HandJointSet jointSet);
 
             [DllImport(NativeDLL, EntryPoint = NativePrefix + "DestroyHandTrackers", ExactSpelling = true)]
             internal static extern int DestroyHandTrackers();
@@ -94,6 +94,10 @@ protected override bool OnInstanceCreate(ulong xrInstance)
                 return false;
             }
 
+            JointSet = OpenXRRuntime.IsExtensionEnabled("XR_ULTRALEAP_hand_tracking_forearm")
+                ? HandJointSet.HandWithForearm
+                : HandJointSet.Default;
+
             if (OpenXRRuntime.GetExtensionVersion("XR_EXT_hand_tracking") < 4)
             {
                 Debug.LogWarning("XR_EXT_hand_tracking is not at least version 4, disabling Hand Tracking");
@@ -105,7 +109,7 @@ protected override bool OnInstanceCreate(ulong xrInstance)
 
         protected override void OnSubsystemStart()
         {
-            int result = Native.CreateHandTrackers();
+            int result = Native.CreateHandTrackers(JointSet);
             if (IsResultFailure(result))
             {
                 Debug.LogError($"Failed to create hand-trackers: {Native.ResultToString(result)}");
@@ -132,6 +136,8 @@ internal bool LocateHandJoints(Handedness handedness, FrameTime frameTime, HandJ
             return Convert.ToBoolean(isActive);
         }
 
+        internal HandJointSet JointSet { get; private set; }
+
         // All OpenXR error codes are negative.
         private static bool IsResultFailure(int result) => result < 0;
 

Packages/Tracking OpenXR/Runtime/Scripts/HandTrackingFeature.cs

@@ -1,6 +1,6 @@
 {
   "name": "com.ultraleap.tracking.openxr",
-  "version": "1.0.0-pre.4",
+  "version": "1.0.0-pre.5",
   "displayName": "Ultraleap Tracking OpenXR",
   "description": "Support for OpenXR Hand Tracking",
   "unity": "2020.3",

Packages/Tracking OpenXR/package.json

@@ -1,12 +1,12 @@
 {
   "name": "com.ultraleap.tracking.preview",
-  "version": "5.10.0",
+  "version": "5.11.0",
   "description": "Ultraleap Tracking Preview",
   "displayName": "Ultraleap Tracking Preview",
-  "unity": "2019.4",
+  "unity": "2020.3",
   "license": "Apache-2.0",
   "dependencies": {
-    "com.ultraleap.tracking": "5.9.0"
+    "com.ultraleap.tracking": "5.10.0"
   },
   "keywords": [
     "ultraleap",
@@ -26,7 +26,7 @@
       "description": "A collection of examples for the Preview package",
       "path": "Examples~"
     },
-	{
+    {
       "displayName": "OVR Provider",
       "description": "An experimental compatibility layer to connect Ultraleap interactions with Oculus hand tracking through a Provider",
       "path": "OVR Provider~"