Merge branch 'release/5.10.0' into 'main'

Release 5.10.0

See merge request xr/integrations/unityplugin!259

Author: JuliaRonnebergerUL

.gitlab-ci.yml

@@ -385,6 +385,7 @@ export-unitypackages:
 
     PACKAGE_IMPORT_PATH_Tracking_Preview:       "$UNITYPLUGIN_ASSETS_PATH/Tracking Preview"
     EXAMPLES_SUBPATH_Tracking_Preview:          "Examples~"
+    OVRPROVIDER_SUBPATH_Tracking_Preview:       "OVR Provider~"
     UNITYPACKAGE_OUTPUT_PATH_Tracking_Preview:  "$UNITYPACKAGES_OUTPUT_PATH/Tracking Preview.unitypackage"
 
     PACKAGE_IMPORT_PATH_Tracking_OpenXR:       "$UNITYPLUGIN_ASSETS_PATH/Tracking OpenXR"
@@ -420,11 +421,11 @@ export-unitypackages:
     #########################
     # Export .unitypackages #
     #########################
-    - Export-UnityPackage -PackageRootPath "$PACKAGE_PATH_Tracking" -PackageImportPath "$PACKAGE_IMPORT_PATH_Tracking" -PackageOutputPath "$UNITYPACKAGE_OUTPUT_PATH_Tracking" -ExamplesSubPath "$EXAMPLES_SUBPATH_Tracking" -ErrorVariable ExportErrors
+    - Export-UnityPackage -PackageRootPath "$PACKAGE_PATH_Tracking" -PackageImportPath "$PACKAGE_IMPORT_PATH_Tracking" -PackageOutputPath "$UNITYPACKAGE_OUTPUT_PATH_Tracking" -ExtraHiddenSubPaths "$EXAMPLES_SUBPATH_Tracking" -ErrorVariable ExportErrors
     - if ($ExportErrors) { echo "Failed to generate Tracking.unitypackage"; exit 1; }
-    - Export-UnityPackage -PackageRootPath "$PACKAGE_PATH_Tracking_Preview" -PackageImportPath "$PACKAGE_IMPORT_PATH_Tracking_Preview" -PackageOutputPath "$UNITYPACKAGE_OUTPUT_PATH_Tracking_Preview" -ExamplesSubPath "$EXAMPLES_SUBPATH_Tracking_Preview" -ErrorVariable ExportErrors
+    - Export-UnityPackage -PackageRootPath "$PACKAGE_PATH_Tracking_Preview" -PackageImportPath "$PACKAGE_IMPORT_PATH_Tracking_Preview" -PackageOutputPath "$UNITYPACKAGE_OUTPUT_PATH_Tracking_Preview" -ExtraHiddenSubPaths "$EXAMPLES_SUBPATH_Tracking_Preview","$OVRPROVIDER_SUBPATH_Tracking_Preview" -ErrorVariable ExportErrors
     - if ($ExportErrors) { echo "Failed to generate Tracking Preview.unitypackage"; exit 1; }
-    - Export-UnityPackage -PackageRootPath "$PACKAGE_PATH_Tracking_OpenXR" -PackageImportPath "$PACKAGE_IMPORT_PATH_Tracking_OpenXR" -PackageOutputPath "$UNITYPACKAGE_OUTPUT_PATH_Tracking_OpenXR" -ExamplesSubPath "$EXAMPLES_SUBPATH_Tracking_OpenXR" -ErrorVariable ExportErrors
+    - Export-UnityPackage -PackageRootPath "$PACKAGE_PATH_Tracking_OpenXR" -PackageImportPath "$PACKAGE_IMPORT_PATH_Tracking_OpenXR" -PackageOutputPath "$UNITYPACKAGE_OUTPUT_PATH_Tracking_OpenXR" -ExtraHiddenSubPaths "$EXAMPLES_SUBPATH_Tracking_OpenXR" -ErrorVariable ExportErrors
     - if ($ExportErrors) { echo "Failed to generate Tracking OpenXR.unitypackage"; exit 1; }
 
     ############################

CI/Scripts/ExportUnityPackage.ps1

@@ -21,7 +21,7 @@ function global:Export-VersionTxt
 }
 
 # Exports a unitypackage at the package root path with the given ImportPath when importing into unity.
-# Optionally provide an examples subpath with trailing '~' - examples will be exported as a second unitypackage.
+# Optionally provide extra subpaths with trailing '~' - these will be exported as extra unitypackages.
 # Example:
 #  Export-UnityPackage "Packages/MyPackage" "Assets/ThirdParty" "MyPackage.unitypackage" "Examples~"
 #  This will create bundle the content of "Packages/MyPackage" into the output package file "MyPackage.unitypackage".
@@ -33,9 +33,23 @@ function global:Export-UnityPackage
         [Parameter(Mandatory)][string] $PackageRootPath,
         [Parameter(Mandatory)][string] $PackageImportPath,
         [Parameter(Mandatory)][string] $PackageOutputPath,
-        [ValidateScript({[string]::IsNullOrEmpty($_) -or $($(Test-Path $(Join-Path $PackageRootPath $_) -PathType Container) -and $_.EndsWith('~'))}, ErrorMessage = "If provided, example path must be an existing subdirectory hidden with a trailing '~'")]
-        [string]
-        $ExamplesSubPath = $null
+        [ValidateScript(
+            {
+                foreach($item in $_)
+                {
+                    if([string]::IsNullOrEmpty($item) -or $($(Test-Path $(Join-Path $PackageRootPath $item) -PathType Container) -and $item.EndsWith('~')))
+                    {
+                        $true
+                    }
+                    else
+                    {
+                        throw "Could not find hidden subpath '$item'."
+                    }
+                }
+            },
+            ErrorMessage = "If provided, hidden folder paths must be an existing subdirectory with a trailing '~'")]
+        [string[]]
+        $ExtraHiddenSubPaths = $null
     )
     function Export-UnityPackage-Impl
     {
@@ -135,17 +149,23 @@ function global:Export-UnityPackage
 
     Export-UnityPackage-Impl -ExportPath $PackageRootPath -ImportPath $PackageImportPath -Output $PackageOutputPath
 
-    if ($ExamplesSubPath)
+    if ($ExtraHiddenSubPaths)
     {
-        $ExamplesUnhiddenSubPath = $ExamplesSubPath.TrimEnd('~')
-        $ExamplesHiddenPath = Join-Path $PackageRootPath $ExamplesSubPath
-        $ExamplesRootPath = Join-Path $PackageRootPath $ExamplesUnhiddenSubPath
+		foreach ($SubPath in $ExtraHiddenSubPaths)
+		{
+			$UnhiddenSubPath = $SubPath.TrimEnd('~')
+
+			$OriginalPath = Join-Path $PackageRootPath $SubPath
+			$NewPath = Join-Path $PackageRootPath $UnhiddenSubPath
 
-        Move-Item $ExamplesHiddenPath $ExamplesRootPath
+			Move-Item $OriginalPath $NewPath
 
-        $ExamplesImportPath = Join-Path $PackageImportPath $ExamplesUnhiddenSubPath
-        $ExamplesOutputPath = $PackageOutputPath.Replace(".unitypackage", " Examples.unitypackage")
+			$ExtraUnitypackageImportPath = Join-Path $PackageImportPath $UnhiddenSubPath
+            # Appends the subpath within the package to the name of the generated unitypackage so it's unique
+            $ExtraUnitypackageOutputPath = $PackageOutputPath.Replace(".unitypackage", " $UnhiddenSubPath.unitypackage")
 
-        Export-UnityPackage-Impl -ExportPath $ExamplesRootPath -ImportPath $ExamplesImportPath -Output $ExamplesOutputPath
+			Export-UnityPackage-Impl -ExportPath $NewPath -ImportPath $ExtraUnitypackageImportPath -Output $ExtraUnitypackageOutputPath
+		}
     }
+	# loop through list of samples and generate example packages
 }

Packages/Tracking OpenXR/CHANGELOG.md

@@ -6,6 +6,25 @@ 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.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`
+
+### 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`
+- The elbow joint is not currently tracked and the OpenXR Leap Provider infers the elbow/forearm from the hand-data.
+
+
 ## [1.0.0-pre.3] - 19/04/2022
 
 ### Added
@@ -22,7 +41,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Known issues
 
-- Hand data provided via the OpenXR Leap Provider is currently always relative to the scene origin. It will not respect any parent transforms applied to the main camera.
 - 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`

Packages/Tracking OpenXR/Editor/Scripts/OpenXRLeapProviderEditor.cs

@@ -1,17 +1,31 @@
 using Leap.Unity;
 using UnityEditor;
+using UnityEngine;
 
 namespace Ultraleap.Tracking.OpenXR
 {
-
     [CustomEditor(typeof(OpenXRLeapProvider))]
     public class OpenXRLeapProviderEditor : CustomEditorBase
     {
         private readonly string[] _testHandPoses = { "HeadMountedA", "HeadMountedB" };
+        private SerializedProperty _mainCamera;
 
         protected override void OnEnable()
         {
             base.OnEnable();
+
+            _mainCamera = serializedObject.FindProperty("_mainCamera");
+            if (_mainCamera.objectReferenceValue == null)
+            {
+                _mainCamera.objectReferenceValue = MainCameraProvider.mainCamera;
+                serializedObject.ApplyModifiedProperties();
+
+                if (_mainCamera.objectReferenceValue != null)
+                {
+                    Debug.Log("Camera.Main automatically assigned");
+                }
+            }
+
             specifyCustomDrawer("editTimePose", DrawCustomEnum);
         }
 
@@ -20,6 +34,5 @@ private void DrawCustomEnum(SerializedProperty property)
             property.enumValueIndex = EditorGUILayout.Popup("Edit Time Pose", property.enumValueIndex, _testHandPoses);
             serializedObject.ApplyModifiedProperties();
         }
-
     }
 }

Packages/Tracking OpenXR/Examples~/Capsule Hands (OpenXR).unity

@@ -431,6 +431,10 @@ PrefabInstance:
       propertyPath: m_Name
       value: Service Provider (OpenXR)
       objectReference: {fileID: 0}
+    - target: {fileID: 6382174844009596092, guid: d774afbb462004749918d3e350ef43ff, type: 3}
+      propertyPath: _mainCamera
+      value: 
+      objectReference: {fileID: 41947977}
     m_RemovedComponents: []
   m_SourcePrefab: {fileID: 100100000, guid: d774afbb462004749918d3e350ef43ff, type: 3}
 --- !u!1 &1966885502

Packages/Tracking OpenXR/Runtime/Prefabs/Service Provider (OpenXR).prefab

@@ -27,6 +27,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 0}
   m_RootOrder: 0
@@ -44,3 +45,4 @@ MonoBehaviour:
   m_Name: 
   m_EditorClassIdentifier: 
   editTimePose: 0
+  _mainCamera: {fileID: 0}

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

@@ -13,18 +13,78 @@ namespace Ultraleap.Tracking.OpenXR
     public class OpenXRLeapProvider : LeapProvider
     {
         private Frame _updateFrame = new Frame();
+        private Frame _currentFrame = new Frame();
+
         private Hand _leftHand = new Hand();
         private Hand _rightHand = new Hand();
 
+        [Tooltip("Specifies the main camera. Falls back to Camera.main if not set")]
+        [SerializeField]
+        private Camera _mainCamera; // Redundant backing field, used to present value in editor at parent level
+        /// <summary>
+        /// Specifies the main camera.
+        /// Falls back to Camera.main if not set.
+        /// </summary>
+        public Camera mainCamera
+        {
+            get
+            {
+                if (_mainCamera != null && _mainCamera != MainCameraProvider.mainCamera)
+                {
+                    MainCameraProvider.mainCamera = _mainCamera;
+                }
+                return _mainCamera;
+            }
+            set
+            {
+                _mainCamera = value;
+                MainCameraProvider.mainCamera = value;
+            }
+        }
+
+        protected void OnEnable()
+        {
+            // Assign the main camera if it looks like one is available and it's not yet been set on the backing field
+            // NB this may be the case if the provider is created via AddComponent, as in MRTK
+            if (mainCamera == null && MainCameraProvider.mainCamera != null)
+            {
+                mainCamera = MainCameraProvider.mainCamera;
+            }
+        }
+
         private void Update()
         {
             PopulateLeapFrame(FrameTime.OnUpdate, ref _updateFrame);
-            DispatchUpdateFrameEvent(_updateFrame);
+
+            Pose trackerTransform = new Pose(Vector3.zero, Quaternion.identity);
+
+#if XR_LEGACY_INPUT_AVAILABLE
+            // Adjust for relative transform if it's in use.
+            var trackedPoseDriver = mainCamera.GetComponent<UnityEngine.SpatialTracking.TrackedPoseDriver>();
+            if (trackedPoseDriver != null && trackedPoseDriver.UseRelativeTransform)
+            {
+                trackerTransform.position += trackedPoseDriver.originPose.position;
+                trackerTransform.rotation *= trackedPoseDriver.originPose.rotation;
+            }
+#endif
+            // Adjust for the camera parent transform if this camera is part of a rig.
+            var parentTransform = mainCamera.transform.parent;
+            if (parentTransform != null)
+            {
+                trackerTransform.position += parentTransform.position;
+                trackerTransform.rotation *= parentTransform.rotation;
+            }
+
+            _currentFrame = _updateFrame.TransformedCopy(new LeapTransform(
+                trackerTransform.position.ToVector(),
+                trackerTransform.rotation.ToLeapQuaternion()));
+
+            DispatchUpdateFrameEvent(_currentFrame);
         }
 
-        void FixedUpdate()
+        private void FixedUpdate()
         {
-            DispatchFixedFrameEvent(_updateFrame);
+            DispatchFixedFrameEvent(_currentFrame);
         }
 
         private void PopulateLeapFrame(FrameTime frameTime, ref Frame leapFrame)
@@ -244,9 +304,9 @@ public override Frame CurrentFrame
             get
             {
 #if UNITY_EDITOR
-                return !Application.isPlaying ? EditTimeFrame : _updateFrame;
+                return !Application.isPlaying ? EditTimeFrame : _currentFrame;
 #else
-                return _updateFrame;
+                return _currentFrame;
 #endif
             }
         }
@@ -266,7 +326,7 @@ private Frame EditTimeFrame
                 (_backingUntransformedEditTimeFrame ??= new Frame()).Hands.Clear();
                 _backingUntransformedEditTimeFrame.Hands.Add(EditTimeLeftHand);
                 _backingUntransformedEditTimeFrame.Hands.Add(EditTimeRightHand);
-                _backingEditTimeFrame.CopyFrom(_backingUntransformedEditTimeFrame).Transform(transform.GetLeapMatrix());
+                _backingEditTimeFrame = _backingUntransformedEditTimeFrame.TransformedCopy(mainCamera.transform.GetLeapMatrix());
                 return _backingEditTimeFrame;
             }
         }

Packages/Tracking OpenXR/Runtime/Ultraleap.Tracking.OpenXR.asmdef

@@ -5,7 +5,8 @@
         "GUID:4847341ff46394e83bb78fbd0652937e",
         "GUID:96aa6ba065960476598f8f643e7252b6",
         "GUID:cec9848704c49724192ff47f9b3e9156",
-        "GUID:2ee0542102ac1084e8d9a910885c1e81"
+        "GUID:2ee0542102ac1084e8d9a910885c1e81",
+        "GUID:ba171b3dd2a51234ab864770f99741a5"
     ],
     "includePlatforms": [
         "Android",
@@ -18,6 +19,12 @@
     "precompiledReferences": [],
     "autoReferenced": true,
     "defineConstraints": [],
-    "versionDefines": [],
+    "versionDefines": [
+        {
+            "name": "com.unity.xr.legacyinputhelpers",
+            "expression": "1.0",
+            "define": "XR_LEGACY_INPUT_AVAILABLE"
+        }
+    ],
     "noEngineReferences": false
 }

Packages/Tracking OpenXR/package.json

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

Packages/Tracking Preview/AggregationProviders/Editor/AggregationProviderConfidenceInterpolationEditor.cs

@@ -13,23 +13,54 @@ namespace Leap.Unity
 {
 
     [CustomEditor(typeof(AggregationProviderConfidenceInterpolation))]
-    public class AggregationProviderConfidenceInterpolationEditor : CustomEditorBase
+    public class AggregationProviderConfidenceInterpolationEditor : CustomEditorBase<AggregationProviderConfidenceInterpolation>
     {
 
         protected override void OnEnable()
         {
             base.OnEnable();
 
             specifyCustomDrawer("jointOcclusionFactor", drawJointOcclusionWarning);
+
+            drawFoldoutInLine();
+
+            addPropertyToFoldout("palmPosFactor", "Palm Factors");
+            addPropertyToFoldout("palmRotFactor", "Palm Factors");
+            addPropertyToFoldout("palmVelocityFactor", "Palm Factors");
+
+            addPropertyToFoldout("jointRotFactor", "Joint Factors");
+            addPropertyToFoldout("jointRotToPalmFactor", "Joint Factors");
+            addPropertyToFoldout("jointOcclusionFactor", "Joint Factors");
+
+            specifyConditionalDrawing("debugJointOrigins",
+                                        "debugHandLeft",
+                                        "debugHandRight",
+                                        "debugColors");
         }
 
         private void drawJointOcclusionWarning(SerializedProperty property)
         {
             EditorGUILayout.PropertyField(property, true);
 
+
             if (property.floatValue != 0)
             {
-                EditorGUILayout.HelpBox("To use jointOcclusion, you must add a Layer for each ServiceProvider named 'JointOcclusion[idx]'. (eg. Add 'JointOcclusion0' and 'JointOcclusion1' when using two source providers.)", MessageType.Warning);
+                bool showWarning = false;
+                string warningText = "To use jointOcclusion, you must add the following Layers: ";
+                for (int i = 0; i < target.providers.Length; i++)
+                {
+                    string layerName = "JointOcclusion" + i.ToString();
+                    if (LayerMask.NameToLayer(layerName) == -1)
+                    {
+                        showWarning = true;
+                        warningText += layerName + ", ";
+                    }
+                }
+
+                if (showWarning)
+                {
+                    EditorGUILayout.HelpBox(warningText.TrimEnd(' ', ','), MessageType.Warning);
+                }
             }
         }