Skip to content

Commit 7916658

Browse files
authored
Updated ReadMe with important notes/requirements
1 parent 7cf68e1 commit 7916658

File tree

1 file changed

+6
-2
lines changed
  • Assets/HoloToolkit-Preview/QRTracker

1 file changed

+6
-2
lines changed

Assets/HoloToolkit-Preview/QRTracker/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
QrTracking is implemented in the Windows mixed reality driver. The example scene shows how to use this preview feature. The feature expects that the windows Oct 2018 update, and latest mixed reality driver.
44

55
# How to Use?
6-
There is an example scene “QRCodesSample” this scene shows how to use the QRScanner prefab scripts to talk to the windows mixed reality driver. Whenever a QR code is detected it is uniquely identified and the events are fired which the application can listen to. Added, Updated, and Removed are the events which the apps can expect. The sample scene demonstrates how these events are used, the scene uses the information about the QR code found and displays it in the world. The Id of the QR code is used with the new platform API to get the spatial coordinate system as shown by SpatialGraphCoordinateSystem script.
7-
A second scene “AttachToQRCode” shows how the QR code can be used to attach holograms. As an example, whenever the application sees a QR code with text "pink chair" it places a hologram of the chair near it. The coordinates of the chair relative to the QR code should be adjusted accordingly.
6+
There is an example scene “QRCodesSample” this scene shows how to use the QRScanner prefab scripts to talk to the windows mixed reality driver. Whenever a QR code is detected it is uniquely identified and the events are fired which the application can listen to. Added, Updated, and Removed are the events which the apps can expect. The sample scene demonstrates how these events are used, the scene uses the information about the QR code found and displays it in the world. The Id of the QR code is used with the new platform API to get the spatial coordinate system as shown by SpatialGraphCoordinateSystem script.
7+
A second scene “AttachToQRCode” shows how the QR code can be used to attach holograms. As an example, whenever the application sees a QR code with text "pink chair" it places a hologram of the chair near it. The coordinates of the chair relative to the QR code should be adjusted accordingly.
88

99
# Enabling/Disabling the feature
1010
The feature can be turned on/off in the driver using a reg key.
@@ -13,3 +13,7 @@ reg add "HKLM\SOFTWARE\Microsoft\HoloLensSensors" /v EnableQRTrackerDefault /t R
1313
When not using this feature it should be turned off if performace is of concern
1414
reg add "HKLM\SOFTWARE\Microsoft\HoloLensSensors" /v EnableQRTrackerDefault /t REG_DWORD /d 0 /F
1515

16+
# Requirements and Notes
17+
Note: You are unable to test this feature in the Unity editor. You must built to a UWP application and test using a Windows Mixed Reality VR headset. It is not yet compatible with Microsoft HoloLens.
18+
19+
Note: You need to have Windows 10 SDK 17763 installed, otherwise your Unity project will throw build errors regarding windows spatial perception preview namespaces.

0 commit comments

Comments
 (0)