You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/README_Interactable.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ The *DefaultInteractableStates* asset contains four states and utilizes the [`In
32
32
33
33
***Press**: The object is being pointed at and a button or hand is pressing. The Press state out ranks Default and Focus. This state will also get set as a fallback to Physical Press.
34
34
35
-
***Disabled**: The button should not be interactive and visual feedback will let the user know for some reason this button is not usable at this time. In theory, the disabled state could contain all other states, but when Enabled is turned off, the Disabled state trumps all other states.
35
+
***Disabled**: The button should not be interactive and visual feedback will let the user know if for some reason this button is not usable at this time. In theory, the disabled state could contain all other states, but when Enabled is turned off, the Disabled state trumps all other states.
36
36
37
37
A bit value (#) is assigned to the state depending on the order in the list.
38
38
@@ -56,7 +56,7 @@ An *Interactable's* enabled property is different than the enabled property conf
56
56
57
57
**Input Actions**
58
58
59
-
Select the [input action](./Input/InputActions.md), from the input configuration or controller mapping profile, that the *Interactable* component should react to.
59
+
Select the [input action](./Input/InputActions.md) from the input configuration or controller mapping profile that the *Interactable* component should react to.
60
60
61
61
This property can be configured at runtime in code via [`Interactable.InputAction`](xref:Microsoft.MixedReality.Toolkit.UI.Interactable.InputAction).
62
62
@@ -145,7 +145,7 @@ Custom events can be created in two main ways:
145
145
146
146
#### Example of extending `ReceiverBase`
147
147
148
-
The [`CustomInteractablesReceiver`](xref:Microsoft.MixedReality.Toolkit.UI) class under `MixedRealityToolkit.Examples` displays status information about an *Interactable* and is an example how to create a custom Event Receiver.
148
+
The [`CustomInteractablesReceiver`](xref:Microsoft.MixedReality.Toolkit.UI) class under `MixedRealityToolkit.Examples` displays status information about an *Interactable* and is an example of how to create a custom Event Receiver.
@@ -185,7 +185,7 @@ public virtual void OnClick(InteractableStates state,
185
185
186
186
##### Displaying custom event receiver fields in the inspector
187
187
188
-
*ReceiverBase* scripts use [`InspectorField`](xref:Microsoft.MixedReality.Toolkit.Utilities.Editor.InspectorField) attributes to expose custom properties in the inspector. Here's an example of Vector3 a custom property with tooltip and label information. This property will show up as configurable in the inspector when an *Interactable* GameObject is selected and has the associated *Event Receiver* type added.
188
+
*ReceiverBase* scripts use [`InspectorField`](xref:Microsoft.MixedReality.Toolkit.Utilities.Editor.InspectorField) attributes to expose custom properties in the inspector. Here's an example of Vector3, a custom property with tooltip and label information. This property will show up as configurable in the inspector when an *Interactable* GameObject is selected and has the associated *Event Receiver* type added.
@@ -196,7 +196,7 @@ public Vector3 EffectOffset = Vector3.zero;
196
196
197
197
### Building a simple button
198
198
199
-
One can create a simple button by simply adding the *Interactable* component to a GameObject that is configured to receive input events. It can have has a collider on it or on a child to receive input. If using *Interactable* with a Unity UI based GameObjects it should be under the Canvas GameObject.
199
+
One can create a simple button by adding the *Interactable* component to a GameObject that is configured to receive input events. It can have a collider on it or on a child to receive input. If using *Interactable* with a Unity UI based GameObjects, it should be under the Canvas GameObject.
200
200
201
201
Take the button one step further, by creating a new profile, assigning the GameObject itself and creating a new theme. Furthermore, use the *OnClick* event to make something happen.
202
202
@@ -211,7 +211,7 @@ To make a button Toggle-able, change the the [`Selection Mode`](xref:Microsoft.M
211
211
212
212
While the [`SelectionMode`](xref:Microsoft.MixedReality.Toolkit.UI.SelectionModes) is set to Toggle, the *IsToggled* check box can be used to set the default value of the control at runtime initialization.
213
213
214
-
*CanSelect* means the the *Interactable* can go from *off* to *on* while the *CanDeselect* means the inverse.
214
+
*CanSelect* means the *Interactable* can go from *off* to *on* while the *CanDeselect* means the inverse.
@@ -249,7 +249,7 @@ Multi-Dimension selection mode is used to create sequential buttons, or a button
249
249
250
250
With dimensions being a numeric value, up to 9 themes can be added to control the text label or texture of the button for each speed setting, using a different theme for each of step.
251
251
252
-
Every click event will advance the `DimensionIndex` by 1 at runtime until the `Dimensions` value is reached then the cycle will reset to 0.
252
+
Every click event will advance the `DimensionIndex` by 1 at runtime until the `Dimensions` value is reached. Then the cycle will reset to 0.
@@ -329,7 +329,7 @@ public static void AddFocusEvents(Interactable interactable)
329
329
}
330
330
```
331
331
332
-
The example code below demonstrates how to add an [InteractableOnToggleReceiver](xref:Microsoft.MixedReality.Toolkit.UI.InteractableOnFocusReceiver), which listens for selected/deselected state transitions on toggle-able *Interactables*, and furthermore define action code to perform when the event instances fire.
332
+
The example code below demonstrates how to add an [InteractableOnToggleReceiver](xref:Microsoft.MixedReality.Toolkit.UI.InteractableOnFocusReceiver), which listens for selected/deselected state transitions on toggle-able *Interactables*, and furthermore defines action code to perform when the event instances fire.
0 commit comments