You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Microsoft Mixed Reality Toolkit 2.5.0 release notes
1
+
# Microsoft Mixed Reality Toolkit 2.5.1 release notes
2
2
3
3
-[What's new](#whats-new)
4
4
-[Breaking changes](#breaking-changes)
@@ -7,250 +7,24 @@
7
7
8
8
## What's new
9
9
10
-
### Unity Package Manager (UPM) support
10
+
> [!NOTE]
11
+
> The Mixed Reality Toolkit 2.5.1 release is available exclusively via the [Unity Package Manager](usingupm.md).
11
12
12
-
The Mixed Reality Toolkit can now be managed using the Unity Package Manager.
13
+
### Package dependency errors fixed
13
14
14
-
15
+
This release fixes incorrect inter-package file dependencies (ex: files in Standard Assets no longer incorrectly reference files in Foundation). Version 2.5.1 also adds an explicit dependency on Text Mesh Pro.
15
16
16
-
> [!Note]
17
-
> There are some manual steps required to import the MRTK UPM packages. Please review [Mixed Reality Toolkit and Unity Package Manager](usingupm.md) for more information.
17
+
### Standard Assets package shaders copied to Assets/MRTK/Shaders
18
18
19
-
### Oculus Quest XRSDK support
19
+
When the Standard Assets package is installed via UPM, the shaders will be copied to the Assets/MRTK/Shaders folder so that they will no longer be immutable. This resolves the issue of shaders updated for the Universal Render Pipeline (URP) reverting the legacy behavior the next time the project is loaded.
20
20
21
-
MRTK now supports running Oculus Quest Headsets and Controllers using the native XR SDK pipeline. Hand tracking is also supported with the [Oculus Integration Unity package](https://assetstore.unity.com/packages/tools/integration/oculus-integration-82022) thanks to [Eric Provencher's](https://twitter.com/prvncher) work on MRTK-Quest!
21
+
### Fixed teleport cursor sticking to hands
22
22
23
-
For instructions on how to deploy your device on the Oculus Quest using the new pipeline, see the [Oculus Quest Setup Guide](CrossPlatform/OculusQuestMRTK.md)
23
+
This release fixes an [issue](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/8755) where the teleport destination cursor can stick to hand visuals.
24
24
25
-
### Scrolling Object Collection
26
-
27
-
The MRTK UX component has been upgraded from an experimental feature and offers more freedom for layouting 3D content of different sizes with added support for objects that have no colliders attached. A new option for disabling content masking was also added, making prototyping easier.
28
-
29
-
See [Scrolling Object Collection](README_ScrollingObjectCollection.md) for more information.
### Teleport pointer animation, handling, and sound improvements
34
-
35
-
The teleport pointer now has improved animations and audio feedback. We also improved the handling of the teleport pointer so it handles smoother when transitioning from pointing at nearby surfaces to farther away surfaces.
36
-
37
-
https://streamable.com/3f222q
38
-
39
-
### Input Simulation Cheat Sheet
40
-
The HandInteractionExamples scene now has a configurable shortcut to show a help page for input simulation
Users can now use the Mouse for simulating eye tracking. See the `Eye Simulation Mode` field in the input simulation profile and set it to Mouse. This replaces the previous `Simulate Eye Position` field
### Input Simulation Motion Controller in Editor Play Mode
50
-
51
-
Users can now simulate motion controller just like hands in editor play mode. The trigger, grab and menu buttons are currently supported.
52
-
53
-
### Conical Grab Pointer
54
-
55
-
Grab pointers can now be configured to query for nearby objects using a cone from the grab point rather than a sphere. This more closely resembles the behavior from the default Hololens 2
56
-
interface, which queries for nearby objects using a cone. The DefaultHoloLens2InputSystemProfile has also been adjusted to use the new `ConicalGrabPointer`.
For examples of existing tests that use this infrastructure, see MRTK's [PlayModeTests](https://github.com/microsoft/MixedRealityToolkit-Unity/tree/mrtk_development/Assets/MRTK/Tests/PlayModeTests)
82
-
83
-
84
-
### Support for the Leap Motion 4.5.1 Unity Modules
85
-
86
-
Support for the Leap Motion Unity Modules version 4.5.1 has been added and support for the 4.4.0 assets has been removed. The current supported versions of the Leap Motion Unity Modules are 4.5.0 and 4.5.1.
87
-
88
-
There is also an additional step for initial Leap Motion integration, see [How to Configure the Leap Motion Hand Tracking in MRTK](CrossPlatform/LeapMotionMRTK.md) for more information.
89
-
90
-
### Spatial Awareness Mesh Observer better handles customization of materials
91
-
92
-
With this release, the `Windows Mixed Reality Spatial Mesh Observer` and the `Generic XR SDK Spatial Mesh Observer` components have improved visual material handling. Materials are now preserved when a mesh has been updated by the observer where, previously, they were reset to the default VisibleMaterial as configured in the profile.
93
-
94
-
This enables developers to alter the mesh material and not have the changes overwritten unexpectedly.
95
-
96
-
### Link.xml created in the MixedRealityToolkit.Generated folder
97
-
98
-
With the introduction of Unity Package Manger MRTK, MRTK now writes a `link.xml` file to the `Assets/MixedRealityToolkit.Generated` folder, if none is present. It is recommended to add this file (and `link.xml.meta`) be added to source control. Link.xml is used to influence the [managed code stripping](https://docs.unity3d.com/Manual/ManagedCodeStripping.html#LinkXML) functionality of the Unity linker.
99
-
100
-
More information on the MRTK link.xml file can be found in the [MRTK and managed code stripping](MRTK_and_managed_code_stripping.md) article.
101
-
102
-
### Unity 2019.3+: MRTK configuration dialog no longer attempts to enable legacy XR support
103
-
104
-
To avoid potential conflicts when using Unity's XR Platform, the option to enable legacy XR support has been removed
105
-
from the MRTK configuration dialog. If desired, legacy XR support can be enabled, in Unity 2019, using **Edit** > **Project Settings** >
We've been doing work to reduce the amount of work that runs in InitializeOnLoad handlers, which should lead to
110
-
improvements in inner loop development speed. InitializeOnLoad handlers run every time a script is compiled, prior
111
-
to entering play mode, and also at editor launch. These handlers now run in far fewer cases, resulting in general
112
-
Unity responsiveness improvements.
113
-
114
-
In some cases there was a tradeoff that had to be made:
115
-
116
-
- See [Leap Motion Hand Tracking Configuration](CrossPlatform/LeapMotionMRTK.md) for the extra integration step.
117
-
- For those who are using ARFoundation, there's now an additional manual step in its getting started steps.
118
-
See [ARFoundation](CrossPlatform/UsingARFoundation.md#install-required-packages) for the new steps.
119
-
- For those who will be using [Holographic Remoting with legacy XR pipeline](Tools/HolographicRemoting.md#legacy-xr-setup-instructions) on HoloLens 2, there is now a [manual step](Tools/HolographicRemoting.md#dotnetwinrt_present-define-written-into-player-settings) to perform.
[Bounds control](README_BoundsControl.md) graduated out of experimental and comes with a bunch of new features and tons of bug fixes.
124
-
Here a list of the highlights of this update:
125
-
- properties are split into configurations which makes it easier to set up bounds control
126
-
- configurations can be shared through scriptable objects
127
-
- every property / scriptable property is runtime configurable
128
-
- bounds control rig isn't recreated on property changes anymore
129
-
- translation handles support
130
-
- full constraint support through constraint manager
131
-
- elastics system integration (experimental)
132
-
133
-
The old bounding box is now deprecated and existing game objects using bounding box can be [upgraded using the migration tool](Tools/MigrationWindow.md) or the [bounding box inspector](README_BoundingBox.md#migrating-to-bounds-control).
134
-
135
-
### Constraint manager component
136
-
Constraints can now be used by both, bounds control and object manipulator via the new [constraint manager component](README_ConstraintManager.md). Both components will create a constraint manager per default and process any attached constraints automatically.
137
-
138
-
Additionally to the automatic behavior constraint manager also comes with a manual mode that lets users decide which constraint should be processed.
139
-
For this reason the way we display constraints in the property inspector changed a bit.
The constraints that are applied to the component are now shown as a list in the constraint manager component whereas the component using the constraint manager (either [bounds control](README_BoundsControl.md#constraint-system) or [object manipulator](README_ObjectManipulator.md#constraint-manager)) will now show the selected constraint manager and mode (auto or manual).
144
-
For more information read the [constraint manager](README_ConstraintManager.md) section in our docs.
145
-
146
-
### HoloLens 2 Button material update
147
-
Updated HoloLens 2 Button's front cage material to remove black color in MRC.
148
-
149
-
150
-
151
-
### Description panel update, movable example scene
152
-
Updated description panel. (SceneDescriptionPanelRev.prefab) New design provides a grabbable top bar which allows the user to adjust/move the entire scene.
MRTK now comes with an [elastic simulation system](Elastics/ElasticSystem.md) that includes a wide variety of extensible and flexible subclasses, offering bindings for 4-dimensional quaternion springs, 3-dimensional volume springs and simple linear spring systems.
165
-
166
-
Currently the following MRTK components supporting the [elastics manager](xref:Microsoft.MixedReality.Toolkit.Experimental.Physics.ElasticsManager) can leverage elastics functionality:
Some asmdef files are changed and are now only supporting Unity 2018.4.13f1 or later. Compilation errors will show up when upating to MRTK 2.5 in earlier versions of Unity. This can be fixed by going to `Assets\MRTK\Providers\XRSDK\Microsoft.MixedReality.Toolkit.Providers.XRSDK.asmdef` in the project window and removing the missing reference in the inspector. Repeat those steps with `Assets\MRTK\Providers\Oculus\XRSDK\Microsoft.MixedReality.Toolkit.Providers.XRSDK.Oculus.asmdef` and `Assets\MRTK\Providers\WindowsMixedReality\XRSDK\Microsoft.MixedReality.Toolkit.Providers.XRSDK.WMR.asmdef`. Note you must revert the changes by replacing those three asmdef files with original (i.e. unmodified) ones when upgrading to Unity 2019.
191
-
192
-
### IMixedRealityPointerMediator
193
-
194
-
This interface has been updated to have a new function:
Thestoredinitialworldpose `worldPoseOnManipulationStart` datatypehasbeenchangedfromMixedRealityPosetoMixedRealityTransform, whichincludesthelocalscalevalueofthemanipulatedobject. Withthischangeit's not necessary to separately cache any initial scale values anymore.
230
-
231
-
### New Property in IMixedRealityDictationSystem
232
-
233
-
Anewproperty `AudioClip` hasbeenaddedtotheIMixedRealityDictationSystem interface. The `AudioClip` property enables access to the audio clip associated with the current dictation session. Users must implement the property in their scripts implementing the interface.
are being turned down in 2.5. This feature was originally added to make configuration
239
-
of the MRTK profiles easier (by creating fake in-scene GameObjects that represented each of MRTK's
240
-
services). In the long run, we want to avoid creating fake in-game objects and trying to keep them
241
-
in sync (as data sync and "source of truth" issues are notoriously difficult to scale and get right).
242
-
243
-
In 2.5, the service facade handlers are kept around to ensure that project upgrade goes smoothly -
244
-
any facades that exist in the project will be deleted by the service facade handler to ensure that
245
-
scenes opened up in 2.5 get automatically fixed.
246
-
247
-
The remaining code associated with the service facade feature will be removed in a future release.
248
-
249
-
### Addition of Motion Controller to Input Simulation Service
250
-
251
-
Motion Controller simulation is now offered in editor play mode along side the existing hand simulation. To enable this change, many current functions/fields/properties are now marked obsolete, with `InputSimulationService.cs` and `MixedRealityInputSimulationProfile.cs` getting the most significant changes. The logic and behavior of relevant code largely remain the same, and the majority of obsoleted functions etc. are related to replacing reference to "hand" to the more generic term "controller" (e.g. from `DefaultHandSimulationMode` to `DefaultControllerSimulationMode`). Besides getting new names, the return type of certain new functions are updated to match the name/behavior change (e.g. `GetControllerDevice` based on the original `GetHandDevice` now returns `BaseController` instead of `SimulatedHand`).
252
-
253
-
`IInputSimulationService` now has new properties `MotionControllerDataLeft` and `MotionControllerDataRight`. `MixedRealityInputSimulationProfile` now includes new fields for the keyboard mapping of certain motion controller buttons.
27
+
There are no breaking changes since version 2.5.0.
254
28
255
29
## Known issues
256
30
@@ -274,10 +48,8 @@ To resolve, please ensure that:
### NullReferenceException: Object reference not set to an instance of an object (SceneTransitionService.Initialize)
279
52
280
-
281
53
In some situations, opening `EyeTrackingDemo-00-RootScene` may cause a NullReferenceException in the Initialize method of the SceneTransitionService class.
282
54
This error is due to the Scene Transition Service's configuration profile being unset. To resolve, please use the following steps:
283
55
@@ -288,7 +60,6 @@ This error is due to the Scene Transition Service's configuration profile being
There is currently a known issue for using the [Oculus XR plugin with when targeting Standalone platforms](https://forum.unity.com/threads/unable-to-start-oculus-xr-plugin.913883/). Check the Oculus bug tracker/forums/release notes for updates.
0 commit comments