Skip to content

Commit 1d129bc

Browse files
authored
Merge pull request #111 from Unity-Technologies/Mirror-of-documentation-fixes-for-2.3.2
Bring over minor documentation updates for 2.3.2
2 parents c58a2c6 + f04864a commit 1d129bc

File tree

4 files changed

+8
-7
lines changed

4 files changed

+8
-7
lines changed

Documentation/ActivateInteractables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The interactables below have 3 states: default, grabbed and activated.
1010

1111
## Basic example
1212

13-
The basic example objects differ from the [Grab Interactables](GrabInteractables.md) station in that they respond to the controller trigger when they are held. This occurs through their **HoverStateVisual** configuration, which is a child Prefab of the interactable. These objects are set to pulse a color when the controller trigger is pressed.
13+
The basic example objects differ from the [Grab Interactables](GrabInteractables.md) station in that they respond to the controller trigger when they are held. This occurs through their XR Interactable Affordance State Provider configuration, which sends state changes to the Affordance Receiver components on child GameObjects of the interactables (typically named Audio Feedback and Visual Feedback). These objects are set to change color when hovered, selected (picked up), and activated (when the controller trigger is pressed).
1414

1515
## Advanced examples
1616

Documentation/GrabInteractables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Notice the difference in tracking latency. We recommend using instantaneous by d
1414

1515
Each interactable example contains the required components for grabbing; a **Rigidbody**, **XR Grab Interactable**, and **Collider**.
1616

17-
In addition, each example object contains a child Prefab named **HoverStateVisuals**. This is a helper we've included that will automatically highlight interactables when they are hovered along with providing haptic and audio feedback. Three variants are included, which have different levels of effects included when the activate button is pressed. These can be added to your own objects to automatically get hover-highlight support.
17+
In addition, each example object contains an example of how to use the Affordance System. Each Interactable contains a XR Interactable Affordance State Provider component, which sends state changes to the Affordance Receiver components on child GameObjects of the interactables (typically named Audio Feedback and Visual Feedback). There are receivers configured for both sound and color changes so that objects will automatically be highlighted when they are hovered along with providing haptic and audio feedback. Different variants are provided throughout the scene depending on the specific needs of the interaction.
1818

1919
The major difference between the example objects is the movement type selected.
2020
* **Instantaneous** movement is for objects that do not need to interact with other physics objects.

ProjectSettings/ProjectSettings.asset

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ PlayerSettings:
134134
16:10: 1
135135
16:9: 1
136136
Others: 1
137-
bundleVersion: 2.3.0
137+
bundleVersion: 2.3.2
138138
preloadedAssets:
139139
- {fileID: 0}
140140
- {fileID: 0}

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# XR Interaction Toolkit Examples - Version 2.3.0
1+
# XR Interaction Toolkit Examples - Version 2.3.2
22

33
## Introduction
44

@@ -41,9 +41,10 @@ The following stations are available in the XRI Examples:
4141
* [Station 2: Grab Interactables](Documentation/GrabInteractables.md) - Basic object manipulation.
4242
* [Station 3: Activate Interactables](Documentation/ActivateInteractables.md) - Manipulation of objects that can be triggered by the user.
4343
* [Station 4: Socket Interactors](Documentation/SocketInteractors.md) - Manipulation of objects that can snap to specific positions.
44-
* [Station 5: 2D UI](Documentation/UI-2D.md) - Creation and interaction with [world space](https://docs.unity3d.com/Packages/com.unity.ugui@1.0/manual/UICanvas.html#world-space) 2D UI.
45-
* [Station 6: 3D UI](Documentation/UI-3D.md) - Creation and interaction with 3D constrained controls.
46-
* [Station 7: Physics Interactables](Documentation/PhysicsInteractables.md) - Best practices for combining physics and XR input.
44+
* [Station 5: Gaze Interactions](Documentation/Gaze.md) - Leverage the eye-tracked or head-based gaze interactor to add assistive interaction to your projects.
45+
* [Station 6: 2D UI](Documentation/UI-2D.md) - Creation and interaction with [world space](https://docs.unity3d.com/Packages/com.unity.ugui@1.0/manual/UICanvas.html#world-space) 2D UI.
46+
* [Station 7: 3D UI](Documentation/UI-3D.md) - Creation and interaction with 3D constrained controls.
47+
* [Station 8: Physics Interactables](Documentation/PhysicsInteractables.md) - Best practices for combining physics and XR input.
4748

4849
For a list of new features and deprecations, see [XRI Examples Changelog](CHANGELOG.md).
4950

0 commit comments

Comments
 (0)