Skip to content

Commit c29fcb1

Browse files
authored
Merge pull request #6913 from ms738/patch-21
Update Pointers.md
2 parents 5799028 + 9c013dd commit c29fcb1

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Documentation/Input/Pointers.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Pointer](../../Documentation/Images/Pointers/MRTK_Pointer_Main.png)
44

5-
This article discusses how to configure and respond to Pointer input in practice, compared to [Pointer Architecture](../Architecture/InputSystem/ControllersPointersAndFocus.md)
5+
This article explains how to configure and respond to Pointer input in practice, compared to [Pointer Architecture](../Architecture/InputSystem/ControllersPointersAndFocus.md)
66

77
Pointers are instanced automatically at runtime when a new controller is detected. More than one pointer can be attached to a controller. For example, with the default pointer profile, Windows Mixed Reality controllers get both a line and a parabolic pointer for normal selection and teleportation respectively.
88

@@ -12,7 +12,7 @@ Pointers are configured as part of the Input System in MRTK via a [`MixedReality
1212

1313
- *Pointing Extent* - Defines the max distance for which a Pointer can interact with a GameObject.
1414

15-
- *Pointing Raycast Layer Masks* - This is a prioritized array of LayerMasks to determine what possible GameObjects any given Pointer can interact and the order of interaction to attempt. This is may be useful to ensure Pointers interact with UI elements first before other scene objects.
15+
- *Pointing Raycast Layer Masks* - This is a prioritized array of LayerMasks to determine which possible GameObjects any given Pointer can interact with and the order of interaction to attempt. This may be useful to ensure Pointers interact with UI elements first before other scene objects.
1616
![Pointer Profile Example](../Images/Input/Pointers/PointerProfile.PNG)
1717

1818
### Pointer options configuration
@@ -41,7 +41,7 @@ the articulated hand controller is associated with the *PokePointer*, *GrabPoint
4141
4242
### Default pointer classes
4343

44-
The following classes are the out-of-box MRTK pointers available and defined in the default *MRTK Pointer Profile* outlined above. Each pointer prefab provided under *Assets/MixedRealityToolkit.SDK/Features/UX/Prefabs/Pointers* contains one of these pointer components attached.
44+
The following classes are the out-of-box MRTK pointers available and defined in the default *MRTK Pointer Profile* outlined above. Each pointer prefab provided under *Assets/MixedRealityToolkit.SDK/Features/UX/Prefabs/Pointers* contains one of the pointer components attached.
4545

4646
![MRTK Default Pointers](../Images/Input/Pointers/MRTK_Pointers.png)
4747

@@ -86,7 +86,7 @@ The *[PokePointer](xref:Microsoft.MixedReality.Toolkit.Input.PokePointer)* is us
8686

8787
Useful Poke Pointer properties:
8888

89-
- *TouchableDistance*: Maximum distance a which a touchable surface can be interacted with
89+
- *TouchableDistance*: Maximum distance in which a touchable surface can be interacted with
9090
- *Visuals*: Game object used to render finger tip visual (the ring on finger, by default).
9191
- *Line*: Optional line to draw from fingertip to the active input surface.
9292
- *Poke Layer Masks* - A prioritized array of LayerMasks to determine which possible GameObjects the pointer can interact with and the order of interaction to attempt. Note that a GameObject must also have a `NearInteractionTouchable` component in order to interact with a poke pointer.
@@ -95,7 +95,7 @@ Useful Poke Pointer properties:
9595

9696
##### [`SpherePointer`](xref:Microsoft.MixedReality.Toolkit.Input.SpherePointer)
9797

98-
The *[SpherePointer](xref:Microsoft.MixedReality.Toolkit.Input.SpherePointer)* uses [UnityEngine.Physics.OverlapSphere](https://docs.unity3d.com/ScriptReference/Physics.OverlapSphere.html) in order to identify the closest [`NearInteractionGrabbable`](xref:Microsoft.MixedReality.Toolkit.Input.NearInteractionGrabbable) object for interaction which is useful for "grabbable" input like the `ManipulationHandler`. Similar to the [`PokePointer`](xref:Microsoft.MixedReality.Toolkit.Input.PokePointer)/[`NearInteractionTouchable`](xref:Microsoft.MixedReality.Toolkit.Input.NearInteractionTouchable) functional pair, in order to be interactable with the Sphere Pointer, the game object must contain a component that is the [`NearInteractionGrabbable`](xref:Microsoft.MixedReality.Toolkit.Input.NearInteractionGrabbable) script.
98+
The *[SpherePointer](xref:Microsoft.MixedReality.Toolkit.Input.SpherePointer)* uses [UnityEngine.Physics.OverlapSphere](https://docs.unity3d.com/ScriptReference/Physics.OverlapSphere.html) in order to identify the closest [`NearInteractionGrabbable`](xref:Microsoft.MixedReality.Toolkit.Input.NearInteractionGrabbable) object for interaction, which is useful for "grabbable" input like the `ManipulationHandler`. Similar to the [`PokePointer`](xref:Microsoft.MixedReality.Toolkit.Input.PokePointer)/[`NearInteractionTouchable`](xref:Microsoft.MixedReality.Toolkit.Input.NearInteractionTouchable) functional pair, in order to be interactable with the Sphere Pointer, the game object must contain a component that is the [`NearInteractionGrabbable`](xref:Microsoft.MixedReality.Toolkit.Input.NearInteractionGrabbable) script.
9999

100100
Useful Sphere Pointer properties:
101101

@@ -145,7 +145,7 @@ Touch Started / Updated / Completed | Raised by touch-aware pointers like [`Poke
145145
146146
#### Pointer input events in action
147147

148-
Pointer input events are recognized and handled by the MRTK input system in a similar way as [regular input events](InputEvents.md#input-events-in-action). The difference being that pointer input events are handled only by the GameObject in focus by the pointer that fired the input event - as well as any global input handlers. Regular input events are handled by GameObjects in focus for all active pointers.
148+
Pointer input events are recognized and handled by the MRTK input system in a similar way as [regular input events](InputEvents.md#input-events-in-action). The difference being that pointer input events are handled only by the GameObject in focus by the pointer that fired the input event, as well as any global input handlers. Regular input events are handled by GameObjects in focus for all active pointers.
149149

150150
1. The MRTK input system recognizes an input event has occurred
151151
1. The MRTK input system fires the relevant interface function for the input event to all registered global input handlers
@@ -218,7 +218,7 @@ foreach (var inputSource in CoreServices.InputSystem.DetectedInputSources)
218218

219219
#### Primary pointer
220220

221-
Developers can subscribe to the FocusProviders PrimaryPointerChanged event to be notified when the primary pointer in focus has changed. This can be extremely useful to identify if the user is currently interacting with a scene via gaze or a hand ray or other input source.
221+
Developers can subscribe to the FocusProviders PrimaryPointerChanged event to be notified when the primary pointer in focus has changed. This can be extremely useful to identify if the user is currently interacting with a scene via gaze or a hand ray or another input source.
222222

223223
```c#
224224
private void OnEnable()
@@ -293,7 +293,7 @@ See [`PointerUtils`](xref:Microsoft.MixedReality.Toolkit.Input.PointerUtils) and
293293

294294
## Pointer interactions via editor
295295

296-
For pointer events handled by [`IMixedRealityPointerHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityPointerHandler), MRTK provides further convenience in the form of the [`PointerHandler`](xref:Microsoft.MixedReality.Toolkit.Input.PointerHandler) component which allows pointer events to be handled directly via Unity Events.
296+
For pointer events handled by [`IMixedRealityPointerHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityPointerHandler), MRTK provides further convenience in the form of the [`PointerHandler`](xref:Microsoft.MixedReality.Toolkit.Input.PointerHandler) component, which allows pointer events to be handled directly via Unity Events.
297297

298298
<img src="../../Documentation/Images/Pointers/PointerHandler.png" style="max-width:100%;">
299299

0 commit comments

Comments
 (0)