Skip to content

Commit 41868a3

Browse files
committed
Add xref links
1 parent 15ebb3c commit 41868a3

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

Documentation/HTKToMRTKPortingGuide.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,27 @@ Some events no longer have unique events and now contain a MixedRealityInputActi
2828

2929
| HTK 2017 | MRTK v2 | Action Mapping |
3030
|----------|-----------|----------------|
31-
| IControllerInputHandler | IMixedRealityInputHandler<Vector2> | Mapped to the touchpad or thumbstick |
32-
| IControllerTouchpadHandler | IMixedRealityInputHandler | Mapped to the touchpad |
33-
| IFocusable | IMixedRealityFocusHandler | |
34-
| IGamePadHandler | IMixedRealitySourceStateHandler | |
35-
| IHoldHandler | IMixedRealityGestureHandler | Mapped to hold in the Gestures Profile |
36-
| IHoldHandler | IMixedRealityGestureHandler | |
37-
| IInputClickHandler | IMixedRealityPointerHandler has a click |
38-
| IInputHandler | IMixedRealityInputHandler | Mapped to the controller’s buttons or hand tap |
39-
| IManipulationHandler | IMixedRealityGestureHandler<Vector3> | Mapped to manipulation in the Gestures Profile |
40-
| INavigationHandler | IMixedRealityGestureHandler<Vector3> | Mapped to navigation in the Gestures Profile |
41-
| IPointerSpecificFocusable | IMixedRealityFocusChangedHandler | |
42-
| ISelectHandler | IMixedRealityInputHandler<float> | Mapped to trigger position |
43-
| ISourcePositionHandler | IMixedRealityInputHandler<Vector3> or IMixedRealityInputHandler<MixedRealityPose> | Mapped to pointer position or grip position |
44-
| ISourceRotationHandler | IMixedRealityInputHandler<Quaternion> or IMixedRealityInputHandler<MixedRealityPose> | Mapped to pointer position or grip position |
45-
| ISourceStateHandler | IMixedRealitySourceStateHandler | |
46-
| IXboxControllerHandler | IMixedRealityInputHandler and IMixedRealityInputHandler<Vector2> | Mapped to the various controller buttons and thumbsticks |
31+
| `IControllerInputHandler` | [`IMixedRealityInputHandler<Vector2>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputHandler`1) | Mapped to the touchpad or thumbstick |
32+
| `IControllerTouchpadHandler` | [`IMixedRealityInputHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputHandler) | Mapped to the touchpad |
33+
| `IFocusable` | [`IMixedRealityFocusHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityFocusHandler) | |
34+
| `IGamePadHandler` | [`IMixedRealitySourceStateHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealitySourceStateHandler) | |
35+
| `IHoldHandler` | [`IMixedRealityGestureHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityGestureHandler) | Mapped to hold in the Gestures Profile |
36+
| `IInputClickHandler` | [`IMixedRealityPointerHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityPointerHandler) |
37+
| `IInputHandler` | [`IMixedRealityInputHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputHandler) | Mapped to the controller’s buttons or hand tap |
38+
| `IManipulationHandler` | [`IMixedRealityGestureHandler<Vector3>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityGestureHandler`1) | Mapped to manipulation in the Gestures Profile |
39+
| `INavigationHandler` | [`IMixedRealityGestureHandler<Vector3>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityGestureHandler`1) | Mapped to navigation in the Gestures Profile |
40+
| `IPointerSpecificFocusable` | [`IMixedRealityFocusChangedHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityFocusChangedHandler) | |
41+
| `ISelectHandler` | [`IMixedRealityInputHandler<float>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputHandler`1) | Mapped to trigger position |
42+
| `ISourcePositionHandler` | [`IMixedRealityInputHandler<Vector3>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputHandler`1) or [`IMixedRealityInputHandler<MixedRealityPose>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputHandler`1) | Mapped to pointer position or grip position |
43+
| `ISourceRotationHandler` | [`IMixedRealityInputHandler<Quaternion>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputHandler`1) or [`IMixedRealityInputHandler<MixedRealityPose>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputHandler`1) | Mapped to pointer position or grip position |
44+
| `ISourceStateHandler` | [`IMixedRealitySourceStateHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealitySourceStateHandler) | |
45+
| `IXboxControllerHandler` | [`IMixedRealityInputHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputHandler) and [`IMixedRealityInputHandler<Vector2>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputHandler`1) | Mapped to the various controller buttons and thumbsticks |
4746

4847
## Camera
4948

5049
| | HTK 2017 | MRTK v2 |
5150
|---------------------------|----------|-----------|
52-
| Setup | Delete MainCamera, add MixedRealityCameraParent / MixedRealityCamera / HoloLensCamera prefab to scene **or** use Mixed Reality Toolkit > Configure > Apply Mixed Reality Scene Settings menu item. | MainCamera parented under MixedRealityPlayspace via Mixed Reality Toolkit > Configure. |
51+
| Setup | Delete MainCamera, add MixedRealityCameraParent / MixedRealityCamera / HoloLensCamera prefab to scene **or** use Mixed Reality Toolkit > Configure > Apply Mixed Reality Scene Settings menu item. | MainCamera parented under MixedRealityPlayspace via Mixed Reality Toolkit > Add to Scene and Configure... |
5352
| Configuration | Camera settings configuration performed on prefab instance. | Camera settings configured in Mixed Reality Camera Profile. |
5453

5554
## Speech
@@ -60,14 +59,14 @@ Some events no longer have unique events and now contain a MixedRealityInputActi
6059
|---------------------------|----------|-----------|
6160
| Setup | Add a SpeechInputSource to your scene. | Keyword service (e.g., Windows Speech Input Manager) must be added to the Mixed Reality Registered Services Profile. |
6261
| Configuration | Recognized keywords are configured in the SpeechInputSource’s inspector. | Keywords are configured in the Mixed Reality Speech Commands Profile. |
63-
| Event handlers | ISpeechHandler | IMixedRealitySpeechHandler |
62+
| Event handlers | `ISpeechHandler` | `IMixedRealitySpeechHandler` |
6463

6564
### Dictation
6665

6766
| | HTK 2017 | MRTK v2 |
6867
|---------------------------|----------|-----------|
6968
| Setup | Add a DictationInputManager to your scene. | Dictation support requires service (e.g., Windows Dictation Input Manager) to be added to the Mixed Reality Registered Services Profile. |
70-
| Event handlers | IDictationHandler | IMixedRealityDictationHandler |
69+
| Event handlers | `IDictationHandler` | `IMixedRealityDictationHandler` |
7170

7271
## Spatial Awareness / Mapping
7372

@@ -82,7 +81,7 @@ Some events no longer have unique events and now contain a MixedRealityInputActi
8281

8382
| | HTK 2017 | MRTK v2 |
8483
|---------------------------|----------|-----------|
85-
| Setup | Use the SurfaceMeshesToPlanes script. | Not yet implemented. |
84+
| Setup | Use the `SurfaceMeshesToPlanes` script. | Not yet implemented. |
8685

8786
### Spatial Understanding
8887

@@ -95,7 +94,7 @@ Some events no longer have unique events and now contain a MixedRealityInputActi
9594

9695
| | HTK 2017 | MRTK v2 |
9796
|---------------------------|----------|-----------|
98-
| Setup | Add the BoundaryManager script to the scene. | Enable the Boundary System in the Configuration Profile. |
97+
| Setup | Add the `BoundaryManager` script to the scene. | Enable the Boundary System in the Configuration Profile. |
9998
| Configuration | Configure the scene instance in the inspector. | Configure the settings in the Boundary Visualization profile. |
10099

101100
## Sharing

0 commit comments

Comments
 (0)