[XRI3] Update MRTK3 to support XRI 3.0

[AMollis]

In an upcoming major release of MRTK3, packages will be updated to provide minimum support of XRI 3.0.

Work can be tracked by watching this branch:

• https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/tree/feature/XRI3

With the new input changes from XRI3, the controller-based classes are now obsolete and have been deprecated to reflect this. The functionality of the controller classes can be found in a combination of the standard TrackedPoseDriver as well as the input properties on the individual interactors where that input makes sense.

MRTK3 will be updated to remove dependencies on the obsolete controller-based classes, and where needed, mark usages of the controller-based cases as obsolete.

The goals of this release are as follows:

• MRTK3 Rig Prefabs will remain as is, and be marked as obsolete and deprecated. A new rig will be created (see below).
• MRTK3 controllerswill remain functional but be marked as obsolete and deprecated.
• MRTK3 will add a new rig prefab that uses existing MRTK3 interactors (similar to old-MRTK3 rig), but remove all references to the deprecated XRI3 control behaviors and classes.
• MRTK3 controller lookup class will be deprecated. Where possible, usages of this class will be removed. Otherwise, deprecated code paths will only be utilized by the deprecated rig, and new code paths will be added for the new rig.
• MRTK3 interactors will be updated to support new XRI3 patterns. For example, XRI controller usages will be deprecated and removed where possible.
• MRTK3 code will be updated to support new XRI3 patterns. For example, XRI controller usages will be deprecated and removed where possible.
• MRTK3 tests will be updated to validate MRTK3 interactor controllerless implementations.
• MRTK3 tests will be updated to validate the new MRTK3 rig.
• The release supporting XRI@3.0 must remove existing obsolete code (see [XRI3] Remove obsolete methods (with XRI 3.0 Updates) #531)
• Fix: [TRACKING] Enable ObjectManipulatorGazeHover Unity-test in org.mixedrealitytoolkit.spatialmanipulation/Tests/Runtime/ObjectManipulatorTests.cs for XRI3 migration #735
• Fix: [TRACKING] Enable TapToPlaceFollowsRightHandRay Unity-test in org.mixedrealitytoolkit.spatialmanipulation/Tests/Runtime/SolverTapToPlaceTests.cs for XRI3 migration #736
• Fix: [TRACKING] Enable TapToPlaceFollowsLeftHandRay Unity-test in org.mixedrealitytoolkit.spatialmanipulation/Tests/Runtime/SolverTapToPlaceTests.cs for XRI3 migration #737
• Fix: [TRACKING] Enable ScaleObjectTest Unity-test in org.mixedrealitytoolkit.spatialmanipulation/Tests/Runtime/TransformViaInteractorTests.cs for XRI3 migration #738
• Fix: [Tracking] Create Unity-tests equivalent to GazeFallbackWhenEyeGazeLosesTrackingTest() and GazeFallbackWhenEyeGazeIsDisabledTest() once new MRTKRig for XRI3 migration settles down #747
• In MRTK's new XRI3 rig, implement workaround for missing select actions on devices without interaction profiles for hands, such as Varjo and Quest. Some of the logic in ArticulatedHandController.cs was moved to GazePinchInteractor.cs, however some logic hasn't found a home yet. This chunk of code in ArticulatedHandController.cs needs to be added somewhere in the new MRTK/XRI3 Rig. In particular the logic to manually update selectInteractionState and uiPressInteractionState is not happening in the MRTK3/XRI3 rig.
• Fix SpatialMouseInteractorSmokeTest
• Create document with specific steps on how to upgrade MRTK 3 to XRI 3 that we can share with developers.
• ObjectManipulator updated to not use deprecated XRI3 components in new rig
• RiggedHandMeshVisualizer updated to not use deprecated XRI3 components in new rig
• FlatScreenModeDetector updated to not use deprecated XRI3 components in new rig
• InteractionModeManager updated to not use deprecated XRI3 components in new rig
• HandJointInteractor updated to not use deprecated XRI3 components in new rig
• MRTKRayInteractor updated to not use deprecated XRI3 components in new rig
• Fix: [BUG] [XRI3] Quest Controllers does not invoke hover effects on Far Interaction #768
• Fix Sample: [XRI3] Eye gaze recording sample is not working #878
• Fix Sample: [XRI3] Solver Target "Hand Ray" does not work in XRI3 feature branch #877
• Fix Sample: [XRI3] Spatial Mouse Scene Description panel incorrectly scales entire scene when manipulated  #876
• Fix Regression: [XRI3] [BUG] Spatial mouse manipulation are relative to scene origin instead of head pose #880
• Implement: [XRI3] Split out "airtap" from "grab" as distinct IXRInputButtonReaders #860
• Implement: [XRI3] Consider deprecating IPoseSource in favor of assignable tracked pose drivers #859
• Preview Release 1: [XRI3] [RELEASE] [PREVIEW] August public preview release of XRI3 support #778

Post release:

• Implement: [XRI3] [FEATURE REQUEST] ObjectManipulator support for XRSocketInteractor parameters Hover Socket Snapping and Socket Scale Mode #621

‼️ Using new XRI3 interactors in place of the existing MRTK3 interactors is not in scope for this release. Long term, it is desired that MRTK3 starts relying on XRI interactors instead of custom ones. This work is tracked via #67.

[shaynie]

@ms-RistoRK will be looking at this upgrade for the next couple sprints.
Expected to require major release bump
Talked to Unity:
Namespaces have changed
process is to upgrade to pre-release 2, THEN upgrade to release and then not running the migration tool.

[bd-jimmy]

Would it make sense to upgrade the project to 2022 LTS and 2023 LTS first? I see some slight upgrades for those versions.

[shaynie]

Created feature/XRI3 branch on 4/17/24.

[shaynie]

Risto is currently working on a new MRTK rig prefab without controller behaviors.
Old prefab will remain but deprecated

[shaynie]

Unity 6 tech preview to be released in June.

[AMollis]

Before we ship this version....deprecated MRTK3 method/classes should be removed.

• [XRI3] Remove obsolete methods (with XRI 3.0 Updates) #531

[shaynie]

Holding in discussion until the XRI 3 PR is committed

[AMollis]

Updated the "details" of the issue, so goals are clearer

[AMollis]

XRI3 branch still has some usages of deprecated XRI classes

ObjectManipulator

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.spatialmanipulation\ObjectManipulator\ObjectManipulator.cs(1065,17): warning CS0618: 'XRBaseInputInteractor.xrController' is obsolete: 'xrController has been deprecated in version 3.0.0.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.spatialmanipulation\ObjectManipulator\ObjectManipulator.cs(1065,54): warning CS0618: 'ActionBasedController' is obsolete: 'ActionBasedController has been deprecated in version 3.0.0. Its functionality has been distributed into different components.'

RiggedHandMeshVisualizer

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\Visualizers\RiggedHandVisualizer\RiggedHandMeshVisualizer.cs(77,17): warning CS0618: 'XRBaseController' is obsolete: 'XRBaseController has been deprecated in version 3.0.0. Its functionality has been distributed into different components.'

FlatScreenModeDetector

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\FlatScreenModeDetector.cs(34,13): warning CS0618: 'FlatScreenModeDetector.controllerLookup' is obsolete: 'Deprecated, please use MixedReality.Toolkit.Input.TrackedPoseDriverLookup instead.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\FlatScreenModeDetector.cs(34,47): warning CS0618: 'ControllerLookup' is obsolete: 'Deprecated, please use MixedReality.Toolkit.Input.TrackedPoseDriverLookup instead.'

InteractionModeManager

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\InteractionModeManager.cs(74,87): warning CS0618: 'XRController' is obsolete: 'XRController has been deprecated in version 3.0.0. Its functionality has been distributed into different components.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\InteractionModeManager.cs(74,22): warning CS0618: 'XRController' is obsolete: 'XRController has been deprecated in version 3.0.0. Its functionality has been distributed into different components.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\InteractionModeManager.cs(215,36): warning CS0618: 'XRBaseInputInteractor.xrController' is obsolete: 'xrController has been deprecated in version 3.0.0.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\InteractionModeManager.cs(252,36): warning CS0618: 'XRBaseInputInteractor.xrController' is obsolete: 'xrController has been deprecated in version 3.0.0.'

HandJointInteractor

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\Interactors\HandJointInteractor.cs(35,53): warning CS0618: 'XRBaseInputInteractor.xrController' is obsolete: 'xrController has been deprecated in version 3.0.0.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\Interactors\HandJointInteractor.cs(35,69): warning CS0612: 'ArticulatedHandController' is obsolete
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\Interactors\HandJointInteractor.cs(52,43): warning CS0618: 'XRBaseInputInteractor.xrController' is obsolete: 'xrController has been deprecated in version 3.0.0.'

MRTKRayInteractor

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\Interactors\Ray\MRTKRayInteractor.cs(53,53): warning CS0618: 'XRBaseInputInteractor.isUISelectActive' is obsolete: 'isUISelectActive has been deprecated in version 3.0.0. Use a serialized XRInputButtonProvider to read button input instead.'

[AMollis]

XRI3 branch still has some usages of deprecated XRI classes

ObjectManipulator

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.spatialmanipulation\ObjectManipulator\ObjectManipulator.cs(1065,17): warning CS0618: 'XRBaseInputInteractor.xrController' is obsolete: 'xrController has been deprecated in version 3.0.0.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.spatialmanipulation\ObjectManipulator\ObjectManipulator.cs(1065,54): warning CS0618: 'ActionBasedController' is obsolete: 'ActionBasedController has been deprecated in version 3.0.0. Its functionality has been distributed into different components.'

RiggedHandMeshVisualizer

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\Visualizers\RiggedHandVisualizer\RiggedHandMeshVisualizer.cs(77,17): warning CS0618: 'XRBaseController' is obsolete: 'XRBaseController has been deprecated in version 3.0.0. Its functionality has been distributed into different components.'

FlatScreenModeDetector

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\FlatScreenModeDetector.cs(34,13): warning CS0618: 'FlatScreenModeDetector.controllerLookup' is obsolete: 'Deprecated, please use MixedReality.Toolkit.Input.TrackedPoseDriverLookup instead.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\FlatScreenModeDetector.cs(34,47): warning CS0618: 'ControllerLookup' is obsolete: 'Deprecated, please use MixedReality.Toolkit.Input.TrackedPoseDriverLookup instead.'

InteractionModeManager

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\InteractionModeManager.cs(74,87): warning CS0618: 'XRController' is obsolete: 'XRController has been deprecated in version 3.0.0. Its functionality has been distributed into different components.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\InteractionModeManager.cs(74,22): warning CS0618: 'XRController' is obsolete: 'XRController has been deprecated in version 3.0.0. Its functionality has been distributed into different components.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\InteractionModeManager.cs(215,36): warning CS0618: 'XRBaseInputInteractor.xrController' is obsolete: 'xrController has been deprecated in version 3.0.0.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\InteractionModes\InteractionModeManager.cs(252,36): warning CS0618: 'XRBaseInputInteractor.xrController' is obsolete: 'xrController has been deprecated in version 3.0.0.'

HandJointInteractor

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\Interactors\HandJointInteractor.cs(35,53): warning CS0618: 'XRBaseInputInteractor.xrController' is obsolete: 'xrController has been deprecated in version 3.0.0.'
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\Interactors\HandJointInteractor.cs(35,69): warning CS0612: 'ArticulatedHandController' is obsolete
• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\Interactors\HandJointInteractor.cs(52,43): warning CS0618: 'XRBaseInputInteractor.xrController' is obsolete: 'xrController has been deprecated in version 3.0.0.'

MRTKRayInteractor

• C:\dev\repos\mrtk3-atm\org.mixedrealitytoolkit.input\Interactors\Ray\MRTKRayInteractor.cs(53,53): warning CS0618: 'XRBaseInputInteractor.isUISelectActive' is obsolete: 'isUISelectActive has been deprecated in version 3.0.0. Use a serialized XRInputButtonProvider to read button input instead.'

These issues have been resolved in the XRI3 feature branch