Skip to content

Commit c557286

Browse files
committed
Adding Input documentation
1 parent 3b8c451 commit c557286

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

Assets/HoloToolkit/Input/README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,14 @@ In order to prevent the MainCamera position from being overwritten in the next u
8383
### [Scripts](Scripts)
8484
Scripts related to the input features.
8585

86+
##### ControllerVisualizer.cs
87+
Use this to visualize a 6DoF controller in your application. Add this script to a GameObject at the root of your scene and add a model prefab to be used to represent the controller.
88+
89+
- **controllerModel** A prefab to spawn to represent the controllers. This will automatically move and reorient when the controller is moved.
90+
91+
##### SetGlobalListener.cs
92+
Add this to a GameObject to register it as a global listener on the InputManager. This means it will receive events from the InputManager even while not focused.
93+
8694
#### Cursor
8795
##### AnimatedCursor.cs
8896
Animated cursor is a cursor driven using an animator to inject state information and animate accordingly.
@@ -290,18 +298,18 @@ or in your Visual Studio Package.appxmanifest capabilities.
290298
##### KeywordManager.cs
291299
Allows you to specify keywords and methods in the Unity Inspector, instead of registering them explicitly in code.
292300

293-
**_KeywordsAndResponses_** Set the size as the number of keywords you'd like to listen for, then specify the keywords and method responses to complete the array.
301+
- **_KeywordsAndResponses_** Set the size as the number of keywords you'd like to listen for, then specify the keywords and method responses to complete the array.
294302

295-
**RecognizerStart** Set this to determine whether the keyword recognizer will start immediately or if it should wait for your code to tell it to start.
303+
- **RecognizerStart** Set this to determine whether the keyword recognizer will start immediately or if it should wait for your code to tell it to start.
296304

297305
##### SpeechInputSource.cs
298306
Allows you to specify keywords and keyboard shortcuts in the Unity Inspector, instead of registering them explicitly in code. Keywords are handled by scripts that implement ISpeechHandler.cs.
299307

300308
Check out Assets/HoloToolkit/Input/Tests/Scripts/SphereKeywords.cs and Assets/HoloToolkit/Input/Tests/Scripts/SphereGlobalKeywords.cs for an example of implementing these features, which is used in the demo scene at Assets/HoloToolkit/Input/Tests/SpeechInputSource.unity.
301309

302-
**_KeywordsAndKeys_** Set the size as the number of keywords you'd like to listen for, then specify the keywords to complete the array.
310+
- **_KeywordsAndKeys_** Set the size as the number of keywords you'd like to listen for, then specify the keywords to complete the array.
303311

304-
**RecognizerStart** Set this to determine whether the keyword recognizer will start immediately or if it should wait for your code to tell it to start.
312+
- **RecognizerStart** Set this to determine whether the keyword recognizer will start immediately or if it should wait for your code to tell it to start.
305313

306314
##### ISpeechHandler.cs
307315
Interface that a game object can implement to react to speech keywords.

0 commit comments

Comments
 (0)