Merge XRI3 update into main

Pipelines/Config/settings.yaml

@@ -4,4 +4,4 @@ variables:
   # match (see scripts/packaging/versionmetadata.ps1)
   # ProjectSettings/ProjectSettings.asset:  bundleVersion: x.x.x
   # ProjectSettings/ProjectSettings.asset:  metroPackageVersion: x.x.x.0
-  ProjectVersion: 3.0.0        # used for overall build number of sample projects
+  ProjectVersion: 4.0.0        # used for overall build number of sample projects

Pipelines/Scripts/update-versions.ps1

@@ -160,7 +160,7 @@ Get-ChildItem -Path $PackagesRoot -Filter "package.json" -Recurse | ForEach-Obje
     Write-Output "Patching CHANGELOG.md version to [$version$tag] - $year-$month-$day"
     $escapedVersion = [regex]::Escape($version)
     Get-ChildItem -Path $packagePath/CHANGELOG.md -Recurse | ForEach-Object {
-        (Get-Content -Path $_ -Raw) -Replace "## (\[$escapedVersion(-[a-zA-Z0-9.]+)?\] - \b\d{4}\b-\b(0[1-9]|1[0-2])\b-\b(0[1-9]|[12][0-9]|3[01])\b|Unreleased)", "## [$version$tag] - $year-$month-$day" | Set-Content -Path $_ -NoNewline
+        (Get-Content -Path $_ -Raw) -Replace "## (\[$escapedVersion-development([a-zA-Z0-9.]+)?\] - \b\d{4}\b-\b(0[1-9]|1[0-2])\b-\b(0[1-9]|[12][0-9]|3[01])\b|\[?Unreleased\]?)", "## [$version$tag] - $year-$month-$day" | Set-Content -Path $_ -NoNewline
     }
 }
 

README.md

@@ -80,6 +80,26 @@ This project welcomes contributions, suggestions, and feedback. All contribution
 
 For more information on how to contribute Mixed Reality Toolkit for Unity Project, please read [CONTRIBUTING.md](./CONTRIBUTING.md).
 
+## MRTK3 XRI2 to XRI3 migration guide
+
+MRTK3 has been upgraded to use [Unity's XR Interaction Toolkit 3+](https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.0/manual/whats-new-3.0.html).  As part of the upgrade several changes were made to properly consume XRI 3 package and adhere to the new patterns.  In a nutshell, the main changes are summarized as follows:
+
+* New controller prefabs and a new rig have been created following the new XRI3 pattern.
+  * The old controllers and rig have been marked as osbolete and renamed as "Obsolete MRTK XR Rig", "Obsolete MRTK LeftHand Controller", "Obsolete MRTK RightHand Controller", "Obsolete MRTK Hand Controller", "Obsolete MRTK Interaction Manager", and "Obsolete MRTK Gaze Controller".
+  * The new controllers and rig retake the original names of the obsolete controllers.
+* New controllers structure have been modified so that all of them have the same structure.
+* The deprecated XRI2 XRController component has been removed from the controllers and its input actions have been moved to their interactors.
+    * The new controllers now have a Tracked Pose Driver components that holds references to the device's position, rotation, and tracking state input actions.
+* Interactors now have a Tracked Pose Driver field that holds a reference to the Tracked Pose Driver component of the parent controller.
+* Interactors now have a Mode Managed Root that holds a reference to the parent controller GameObject.
+* Added new unity-tests for the new XRI3 functionality + components.
+* Updated several unity-tests.
+* Updated several scripts so that they work with both obsolete XRI2 and new XRI3 prefabs.
+* Updated all scenes to use the new XRI3 rig + controllers.
+    * Made a copy of the old HandInteractionExamples scene and renamed as ObsoleteHandInteractionExample, this scene still consumes the old rig + controllers.
+
+A more detailed explanation of the changes can be found in [XRI2TOXRI3MIGRATIONGUIDE.md](./XRI2TOXRI3MIGRATIONGUIDE.md).  The guide can also help others as a path for migrating their own solutions or MRTK3 forks from XRI2 to XRI3.
+
 ## Governance
 
 For information on how the Mixed Reality Toolkit for Unity Project is governed, please read [GOVERNANCE.md](./GOVERNANCE.md).

UnityProjects/MRTKDevTemplate/Assets/Prefabs/Whiteboard/pen.prefab

@@ -10,7 +10,7 @@ GameObject:
   m_Component:
   - component: {fileID: 2002339756}
   - component: {fileID: 2002339758}
-  - component: {fileID: 2002339757}
+  - component: {fileID: 1066413309105225662}
   - component: {fileID: 2002339759}
   m_Layer: 0
   m_Name: Pen Interactor
@@ -26,13 +26,13 @@ Transform:
   m_PrefabInstance: {fileID: 0}
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 2002339755}
+  serializedVersion: 2
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: -0.0123}
   m_LocalScale: {x: 1, y: 1, z: 1}
   m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 2415827607033482817}
-  m_RootOrder: 0
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!114 &2002339758
 MonoBehaviour:
@@ -47,11 +47,9 @@ MonoBehaviour:
   m_Name: 
   m_EditorClassIdentifier: 
   m_InteractionManager: {fileID: 0}
-  m_InteractionLayerMask:
-    serializedVersion: 2
-    m_Bits: 4294967295
   m_InteractionLayers:
     m_Bits: 4294967295
+  m_Handedness: 0
   m_AttachTransform: {fileID: 0}
   m_KeepSelectedTargetValid: 1
   m_DisableVisualsWhenBlockedInGroup: 1
@@ -71,42 +69,51 @@ MonoBehaviour:
       m_Calls: []
   m_StartingHoverFilters: []
   m_StartingSelectFilters: []
-  m_OnHoverEntered:
-    m_PersistentCalls:
-      m_Calls: []
-  m_OnHoverExited:
-    m_PersistentCalls:
-      m_Calls: []
-  m_OnSelectEntered:
-    m_PersistentCalls:
-      m_Calls: []
-  m_OnSelectExited:
-    m_PersistentCalls:
-      m_Calls: []
---- !u!135 &2002339757
-SphereCollider:
+--- !u!136 &1066413309105225662
+CapsuleCollider:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
   m_PrefabInstance: {fileID: 0}
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 2002339755}
   m_Material: {fileID: 0}
+  m_IncludeLayers:
+    serializedVersion: 2
+    m_Bits: 0
+  m_ExcludeLayers:
+    serializedVersion: 2
+    m_Bits: 0
+  m_LayerOverridePriority: 0
   m_IsTrigger: 1
+  m_ProvidesContacts: 0
   m_Enabled: 1
   serializedVersion: 2
   m_Radius: 0.0005
-  m_Center: {x: 0, y: 0, z: 0.0004}
+  m_Height: 0.003
+  m_Direction: 2
+  m_Center: {x: 0, y: 0, z: 0.0008}
 --- !u!54 &2002339759
 Rigidbody:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
   m_PrefabInstance: {fileID: 0}
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 2002339755}
-  serializedVersion: 2
+  serializedVersion: 4
   m_Mass: 1
   m_Drag: 0
   m_AngularDrag: 0.05
+  m_CenterOfMass: {x: 0, y: 0, z: 0}
+  m_InertiaTensor: {x: 1, y: 1, z: 1}
+  m_InertiaRotation: {x: 0, y: 0, z: 0, w: 1}
+  m_IncludeLayers:
+    serializedVersion: 2
+    m_Bits: 0
+  m_ExcludeLayers:
+    serializedVersion: 2
+    m_Bits: 0
+  m_ImplicitCom: 1
+  m_ImplicitTensor: 1
   m_UseGravity: 1
   m_IsKinematic: 1
   m_Interpolate: 0
@@ -140,14 +147,14 @@ Transform:
   m_PrefabInstance: {fileID: 0}
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 3084243108605482235}
+  serializedVersion: 2
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: -0, y: 0, z: 0.333}
   m_LocalScale: {x: 8, y: 8, z: 8}
   m_ConstrainProportionsScale: 0
   m_Children:
   - {fileID: 2002339756}
   m_Father: {fileID: 0}
-  m_RootOrder: 0
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!33 &1596919684305715684
 MeshFilter:
@@ -209,8 +216,17 @@ CapsuleCollider:
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 3084243108605482235}
   m_Material: {fileID: 0}
+  m_IncludeLayers:
+    serializedVersion: 2
+    m_Bits: 0
+  m_ExcludeLayers:
+    serializedVersion: 2
+    m_Bits: 0
+  m_LayerOverridePriority: 0
   m_IsTrigger: 0
+  m_ProvidesContacts: 0
   m_Enabled: 1
+  serializedVersion: 2
   m_Radius: 0.0015
   m_Height: 0.025
   m_Direction: 2
@@ -229,13 +245,11 @@ MonoBehaviour:
   m_EditorClassIdentifier: 
   m_InteractionManager: {fileID: 0}
   m_Colliders: []
-  m_InteractionLayerMask:
-    serializedVersion: 2
-    m_Bits: 4294967295
   m_InteractionLayers:
     m_Bits: 1
   m_DistanceCalculationMode: 1
   m_SelectMode: 0
+  m_FocusMode: 1
   m_CustomReticle: {fileID: 0}
   m_AllowGazeInteraction: 0
   m_AllowGazeSelect: 0
@@ -268,42 +282,27 @@ MonoBehaviour:
   m_SelectExited:
     m_PersistentCalls:
       m_Calls: []
-  m_Activated:
-    m_PersistentCalls:
-      m_Calls: []
-  m_Deactivated:
-    m_PersistentCalls:
-      m_Calls: []
-  m_StartingHoverFilters: []
-  m_StartingSelectFilters: []
-  m_StartingInteractionStrengthFilters: []
-  m_OnFirstHoverEntered:
-    m_PersistentCalls:
-      m_Calls: []
-  m_OnLastHoverExited:
-    m_PersistentCalls:
-      m_Calls: []
-  m_OnHoverEntered:
-    m_PersistentCalls:
-      m_Calls: []
-  m_OnHoverExited:
+  m_FirstFocusEntered:
     m_PersistentCalls:
       m_Calls: []
-  m_OnSelectEntered:
+  m_LastFocusExited:
     m_PersistentCalls:
       m_Calls: []
-  m_OnSelectExited:
+  m_FocusEntered:
     m_PersistentCalls:
       m_Calls: []
-  m_OnSelectCanceled:
+  m_FocusExited:
     m_PersistentCalls:
       m_Calls: []
-  m_OnActivate:
+  m_Activated:
     m_PersistentCalls:
       m_Calls: []
-  m_OnDeactivate:
+  m_Deactivated:
     m_PersistentCalls:
       m_Calls: []
+  m_StartingHoverFilters: []
+  m_StartingSelectFilters: []
+  m_StartingInteractionStrengthFilters: []
   isGazePinchSelected:
     active: 0
     onEntered:
@@ -418,6 +417,7 @@ MonoBehaviour:
   hostTransform: {fileID: 2415827607033482817}
   allowedManipulations: 3
   allowedInteractionTypes: 1
+  rigidbodyMovementType: 0
   applyTorque: 1
   springForceSoftness: 0.1
   springTorqueSoftness: 0.1
@@ -440,8 +440,7 @@ MonoBehaviour:
     moveLogicType:
       reference: MixedReality.Toolkit.SpatialManipulation.MoveLogic, MixedReality.Toolkit.SpatialManipulation
     rotateLogicType:
-      reference: MixedReality.Toolkit.SpatialManipulation.RotateLogic,
-        MixedReality.Toolkit.SpatialManipulation
+      reference: MixedReality.Toolkit.SpatialManipulation.RotateLogic, MixedReality.Toolkit.SpatialManipulation
     scaleLogicType:
       reference: MixedReality.Toolkit.SpatialManipulation.ScaleLogic, MixedReality.Toolkit.SpatialManipulation
 --- !u!114 &2741574062440155178

UnityProjects/MRTKDevTemplate/Assets/Profiles/MRTKSamplesProfile.asset

@@ -14,20 +14,16 @@ MonoBehaviour:
   m_EditorClassIdentifier: 
   isCustomProfile: 0
   loadedSubsystems:
-  - reference: MixedReality.Toolkit.Diagnostics.MRTKPerformanceStatsSubsystem,
-      MixedReality.Toolkit.Diagnostics
-  - reference: MixedReality.Toolkit.Speech.Windows.WindowsDictationSubsystem,
-      MixedReality.Toolkit.Speech.Windows
+  - reference: MixedReality.Toolkit.Input.UnityHandsSubsystem, MixedReality.Toolkit.Input
+  - reference: MixedReality.Toolkit.Diagnostics.MRTKPerformanceStatsSubsystem, MixedReality.Toolkit.Diagnostics
+  - reference: MixedReality.Toolkit.Speech.Windows.WindowsDictationSubsystem, MixedReality.Toolkit.Speech.Windows
   - reference: MixedReality.Toolkit.Speech.Windows.WindowsKeywordRecognitionSubsystem,
       MixedReality.Toolkit.Speech.Windows
   - reference: MixedReality.Toolkit.Speech.Windows.WindowsTextToSpeechSubsystem,
       MixedReality.Toolkit.Speech.Windows
-  - reference: MixedReality.Toolkit.Accessibility.MRTKAccessibilitySubsystem,
-      MixedReality.Toolkit.Accessibility
-  - reference: MixedReality.Toolkit.Input.OpenXRHandsSubsystem, MixedReality.Toolkit.Input
+  - reference: MixedReality.Toolkit.Accessibility.MRTKAccessibilitySubsystem, MixedReality.Toolkit.Accessibility
   - reference: MixedReality.Toolkit.Input.SyntheticHandsSubsystem, MixedReality.Toolkit.Input
-  - reference: MixedReality.Toolkit.Input.MRTKHandsAggregatorSubsystem,
-      MixedReality.Toolkit.Input
+  - reference: MixedReality.Toolkit.Input.MRTKHandsAggregatorSubsystem, MixedReality.Toolkit.Input
   subsystemConfigs:
     entries:
     - key:
@@ -47,11 +43,8 @@ MonoBehaviour:
           MixedReality.Toolkit.Accessibility
       value: {fileID: 11400000, guid: 3aa94a99d7ce5e845a6a78409e004670, type: 2}
     - key:
-        reference: MixedReality.Toolkit.Input.SyntheticHandsSubsystem,
-          MixedReality.Toolkit.Input
+        reference: MixedReality.Toolkit.Input.SyntheticHandsSubsystem, MixedReality.Toolkit.Input
       value: {fileID: 11400000, guid: c45788af2ca823a4a904bf8762ff126d, type: 2}
     - key:
-        reference: MixedReality.Toolkit.Input.MRTKHandsAggregatorSubsystem,
-          MixedReality.Toolkit.Input
+        reference: MixedReality.Toolkit.Input.MRTKHandsAggregatorSubsystem, MixedReality.Toolkit.Input
       value: {fileID: 11400000, guid: b8da41358d218754494ea49599e7b0fb, type: 2}
-  <SpatializationMixer>k__BackingField: {fileID: 3526612193736648505, guid: c4ec596b04ef53f4581688939092e813, type: 2}