Skip to content

Commit 480ab57

Browse files
Pony duty check-in (WIP)
* updated configuration screen guide.
1 parent 2f4feca commit 480ab57

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

Documentation/MixedRealityConfigurationGuide.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,34 @@ The camera settings define how the camera will be setup for your Mixed Reality p
7272

7373
## Input System Settings
7474

75+
The Mixed Reality Project provides a robust and well trained input system for routing all the input events around the project which is selected by default.
76+
77+
> The MRTK also allows you to write your own Input System and you can use the selection below to switch the system used without rewriting the toolkit. For more information on writing your own systems, [please see this guide]() (Coming soon)
78+
7579
![](/External/HowTo/MixedRealityToolkitConfigurationProfileScreens/MRTK_InputSystemSelection.png)
7680

81+
Behind the Input System provided by the MRTK are several other systems, these help to drive and manage the complex inter-weaving's required to abstract out the complexities of a multi-platform / mixed reality framework.
7782

7883
![](/External/HowTo/MixedRealityToolkitConfigurationProfileScreens/MRTK_InputSystemProfile.png)
7984

85+
Each of the individual profiles are detailed below:
86+
87+
* [Input Actions Settings](#inputactions)
88+
* [Input Actions Rules](#inputactionrules)
89+
* [Pointer Configuration](#pointer)
90+
* [Gestures Configuration](#gestures)
91+
* [Speech Commands](#speech)
92+
* [Controller Mapping Configuration](#mapping)
93+
* [Controller Visualization Settings](#visualization)
94+
8095
> Clicking on the "Back to Configuration Profile" button will take you back to the main Mixed Reality Toolkit Configuration screen.
8196
---
8297
<a name="boundary"/>
8398

8499
## Boundary Visualization Settings
85100

101+
The boundary system translates the perceived boundary reported by the underlying platforms boundary / guardian system. The Boundary visualizer configuration gives you the ability to automatically show the recorded boundary within your scene relative to the users position. The boundary will also react / update based on where the user teleports within the scene.
102+
86103
![](/External/HowTo/MixedRealityToolkitConfigurationProfileScreens/MRTK_BoundaryVisualizationProfile.png)
87104

88105
> Clicking on the "Back to Configuration Profile" button will take you back to the main Mixed Reality Toolkit Configuration screen.
@@ -91,16 +108,33 @@ The camera settings define how the camera will be setup for your Mixed Reality p
91108

92109
## Teleportation System Selection
93110

111+
The Mixed Reality Project provides a full featured Teleportation system for managing teleportation events in the project which is selected by default.
112+
113+
> The MRTK also allows you to write your own Teleportation System and you can use the selection below to switch the system used without rewriting the toolkit. For more information on writing your own systems, [please see this guide]() (Coming soon)
114+
94115
![](/External/HowTo/MixedRealityToolkitConfigurationProfileScreens/MRTK_TeleportationSystemSelection.png)
95116

96117
---
97118
<a name="spatialawareness"/>
98119

99120
## Spatial Awareness Settings
100121

122+
The Mixed Reality Project provides a rebuilt Spatial Awareness system for working with spatial scanning systems in the project which is selected by default.
123+
You can view the architecture behind the [MRTK Spatial Awareness system here](/Documentation/Architecture/SpatialAwarenessSystemArchitecture.md).
124+
125+
> The MRTK also allows you to write your own Spatial Awareness System and you can use the selection below to switch the system used without rewriting the toolkit. For more information on writing your own systems, [please see this guide]() (Coming soon)
126+
101127
![](/External/HowTo/MixedRealityToolkitConfigurationProfileScreens/MRTK_SpatialAwarenessSystemSelection.png)
102128

103-
![](/External/HowTo/MixedRealityToolkitConfigurationProfileScreens/MRTK_SpatialAwarenessProfile.png.png)
129+
The Mixed Reality Toolkit Spatial Awareness configuration lets you tailor how the system starts, whether it is automatically when the application starts or later programmatically as well as setting the extents for the Field of View.
130+
131+
It also lets you configure the Mesh and surface settings, further customizing how your project understands the environment around you.
132+
133+
This is only applicable for devices that can provide a scanned environment, such as the HoloLens (and other devices in the future)
134+
135+
> Note, the Spatial Awareness system is still in active development, please report any issues or requests in the [MRTK Issues section on GitHub](https://github.com/Microsoft/MixedRealityToolkit-Unity/issues)
136+
137+
![](/External/HowTo/MixedRealityToolkitConfigurationProfileScreens/MRTK_SpatialAwarenessProfile.png)
104138

105139
> Clicking on the "Back to Configuration Profile" button will take you back to the main Mixed Reality Toolkit Configuration screen.
106140
---

0 commit comments

Comments
 (0)