Skip to content

Bring over minor documentation updates for 2.3.2 #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Documentation/ActivateInteractables.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The interactables below have 3 states: default, grabbed and activated.

## Basic example

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.
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).

## Advanced examples

Expand Down
2 changes: 1 addition & 1 deletion Documentation/GrabInteractables.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Notice the difference in tracking latency. We recommend using instantaneous by d

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

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.
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.

The major difference between the example objects is the movement type selected.
* **Instantaneous** movement is for objects that do not need to interact with other physics objects.
Expand Down
2 changes: 1 addition & 1 deletion ProjectSettings/ProjectSettings.asset
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ PlayerSettings:
16:10: 1
16:9: 1
Others: 1
bundleVersion: 2.3.0
bundleVersion: 2.3.2
preloadedAssets:
- {fileID: 0}
- {fileID: 0}
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# XR Interaction Toolkit Examples - Version 2.3.0
# XR Interaction Toolkit Examples - Version 2.3.2

## Introduction

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

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

Expand Down