Skip to content

Commit 99b9d02

Browse files
authored
Merge pull request #6873 from keveleigh/update-controller-doc
Update controller docs to more correctly represent the current state of features
2 parents 168e810 + 52332d3 commit 99b9d02

File tree

2 files changed

+19
-20
lines changed

2 files changed

+19
-20
lines changed

Assets/MixedRealityToolkit.SDK/Profiles/MixedRealityControllerConfigurationProfile.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -50,32 +50,32 @@ Your custom name for the controller, just for easy reference
5050
A drop down list of supported controllers by the Mixed Reality Toolkit, namely:
5151

5252
* Windows Mixed Reality
53-
* Motion Controllers
53+
* Motion Controllers
54+
* HoloLens 2 articulated hands
55+
* HoloLens 1 hands
56+
* HoloLens 1 clicker
5457
* OpenVR
55-
* Default (fallback) controllers
56-
* Oculus Touch
57-
* Vive Wand
58-
* Vive Knuckles (experimental as no one has any, using Unity spec)
59-
* OpenXR
60-
* To be supported when there is an OpenXR specification
61-
* Windows Gaming (these are coming soon*)
62-
* Arcade stick
63-
* Gamepad
64-
* Joystick
65-
* Racing Wheel
66-
* Simulator (coming soon)
58+
* Default (fallback) controllers
59+
* Oculus Touch
60+
* Vive Wand
61+
* Vive Knuckles (experimental)
62+
* Windows Gaming
63+
* Gamepad (like Xbox)
6764

6865
### Handedness
6966
Which hand is configured for this controller definition
7067
> Both does not configure all controllers at this time.
7168
7269
### Use Default model
73-
For this controller only, use the model for the controller direct from the SDK (where available), so that you don't have to configure a custom model.
74-
> This overrides the Global Model setting
70+
71+
For this controller only, use the model for the controller direct from the SDK (where available), so that you don't have to configure a custom model. This overrides the Global Model setting.
72+
73+
> [!NOTE]
74+
> This is currently supported on both Windows Mixed Reality and OpenVR, loading any controller models provided by the platform API.
7575
7676
### Override Model
77-
Like the Global Model options, allows you to provide a model to be drawn for this specific controller.
78-
> This overrides the Global Model setting
77+
78+
Like the Global Model options, allows you to provide a model to be drawn for this specific controller. This overrides the Global Model setting.
7979

8080
### Interaction Mappings
8181
The interaction mappings allow you to map logical input actions for use in your project to the various controller inputs available from the physical device.
@@ -136,4 +136,4 @@ Source -> Included as part of the Unity SteamVR SDK, or the Steam VR Client
136136

137137
If you use Steams Models, we recommend applying the following Prefab transform values to align the controller model when using to align with the users view:
138138
* Position - no change
139-
* Rotation - no change
139+
* Rotation - no change

Documentation/MixedRealityConfigurationGuide.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -297,8 +297,7 @@ In addition to the controller mapping, a separate configuration profile is provi
297297

298298
This can be configured at a "Global" (all instances of a controller for a specific hand) or specific to an individual controller type / hand.
299299

300-
> [!IMPORTANT]
301-
> The MRTK does not currently support native SDK's controller models as Unity does not yet provide the capability to load / render gLTF models, which is the default type of models provided by most SDKs. This will be enhanced when this is available.
300+
The MRTK also supports native SDK controller models for Windows Mixed Reality and OpenVR. These are loaded as GameObjects in your scene and positioned using the platform's controller tracking.
302301

303302
If your controller representation in the scene needs to be offset from the physical controller position, then simply set that offset against the controller model's prefab (e.g. setting the transform position of the controller prefab with an offset position).
304303

0 commit comments

Comments
 (0)