Samples

To install samples included with this package, follow the instructions for Installing samples using the Package Manager.

Sample	Description
Starter Assets	Assets to streamline setup of behaviors, including a default set of input actions, presets for use with XR Interaction Toolkit behaviors that use the Input System, and prefabs for getting started.
XR Device Simulator	Assets related to the simulation of XR HMD and controllers.
Tunneling Vignette	Assets to let users set up and configure tunneling vignette effects as a comfort mode option.

Starter Assets

This sample is installed into the default location for package samples, in the Assets\Samples\XR Interaction Toolkit\[version]\Starter Assets folder. You can move these Assets to a different location.

This sample contains an Input Action Asset that contains Actions with typical Input Bindings for use with behaviors in the XR Interaction Toolkit that read input. This sample also includes XR Origin, teleport, and interactable sample prefabs.

This sample also contains Presets for behaviors that use actions to streamline their configuration.

Asset	Description
XRI Default Continuous Move.preset	Preset for Continuous Move Provider.
XRI Default Continuous Turn.preset	Preset for Continuous Turn Provider.
XRI Default Input Actions.inputactions	Asset that contains actions with typical bindings and several Control Schemes for use in XR experiences.
XRI Default Left Controller.preset	Preset for left hand Controllers.
XRI Default Left Grab Move.preset	Preset for left hand Grab Move Provider.
XRI Default Right Controller.preset	Preset for right hand Controllers.
XRI Default Right Grab Move.preset	Preset for right hand Grab Move Provider.
XRI Default Snap Turn.preset	Preset for Snap Turn Provider.
XRI Default XR UI Input Module.preset	Preset for XR UI Input Module.

Input Actions Asset

The following image shows the Action editor of the Asset included in the sample, while editing one of the bindings of an action in one of the maps.

The Asset contains several Action Maps, separated based on the bound device. Having different sets of actions based on the controller handedness, rather than one set of actions with input bindings for multiple controllers, allows for easier fine-grained management of the allowed actions per-hand. For example, the XRI RightHand Locomotion/Turn action can be disabled while the right hand has picked something up, while turning is still allowed by having the XRI LeftHand Locomotion/Turn action enabled.

Action Map	Description
XRI Head	Actions with input bindings to a head-mounted display (that is, <XRHMD>).
XRI LeftHand	Actions with input bindings to a left hand controller (that is, <XRController>{LeftHand}) related to tracking and haptic feedback.
XRI LeftHand Interaction	Actions with input bindings to a left hand controller related to interaction state.
XRI LeftHand Locomotion	Actions with input bindings to a left hand controller related to locomotion and interaction state for a teleportation interactor.
XRI RightHand	Actions with input bindings to a right hand controller (that is, <XRController>{RightHand}) related to tracking and haptic feedback.
XRI RightHand Interaction	Actions with input bindings to a right hand controller related to interaction state.
XRI RightHand Locomotion	Actions with input bindings to a right hand controller related to locomotion and interaction state for a teleportation interactor.
XRI UI	Actions with input bindings to drive UI input and navigation used in the XR UI Input Module component.

There are also several Input Control Schemes to group different input controls. You can use these to selectively enable or disable some of the bindings based on the locomotion movement control scheme in use.

Control Scheme	Description
Generic XR Controller	Bindings that should remain enabled when applying any movement control scheme.
Continuous Move	Bindings that should remain enabled when applying the continuous movement control scheme.
Noncontinuous Move	Bindings that should remain enabled when applying the noncontinuous movement control scheme.

For a complete example of configuring input actions for each controller, and using control schemes, see the XR Interaction Toolkit Examples project.

Configuring Preset Manager defaults

After importing the sample into your Project, if you want to use the Assets, it is recommended to use the Preset Manager to change the default Presets to those included in this sample. This will allow the objects you create from the GameObject > XR menu to automatically populate the action properties of the behavior, as configured in each preset.

To easily set a preset as the default for its associated behavior, select the Asset in the Project window, then click the Add to [behavior] default button in the Inspector.

Access the Preset Manager from Unity's main menu (go to Edit > Project Settings, then select Preset Manager).

The following image shows the Preset Manager with the included presets set as default for their associated behavior. For the presets which depend on the hand of the controller, a Filter value of Left and Right is set for XRI Default Left Controller and XRI Default Right Controller to allow the appropriate preset to be chosen based on the name of the GameObject.

Prefabs

Prefab	Description
Complete Teleport Area Set Up	Teleportation prefab which includes the Teleportation Area and Teleportation Anchor prefabs. Configured to the Teleport Interactor in the Complete XR Origin Setup prefab included in these starter assets.
Complete XR Origin Set Up	XR Origin prefab configured for smooth locomotion, grab locomotion, teleportation locomotion, as well as smooth and snap turn. Each hand also contains a Direct Interactor and a Ray Interactor.
Interactables Sample	Prefab containing preconfigured XR Grab Interactables.
UI Sample	Prefab containing interactable UI elements.

Scripts

The following scripts are included to support the prefabs.

Script	Description
ActionBasedControllerManager	Script used to mediate the controllers and their associated interactors and input actions under different interaction states.
DynamicMoveProvider	A version of action-based continuous movement that automatically controls the frame of reference that determines the forward direction of movement based on user preference for each hand.

XR Device Simulator

This sample is installed into the default location for package samples, in the Assets\Samples\XR Interaction Toolkit\[version]\XR Device Simulator folder. You can move these Assets to a different location.

The XR Interaction Toolkit package provides an example implementation of an XR Device Simulator to allow for manipulating an HMD and a pair of controllers using mouse and keyboard input. This sample contains example bindings for use with that simulator, and a Prefab which you can add to your scene to quickly start using the simulator.

Asset	Description
XR Device Simulator Controls.inputactions	Asset that contains actions with default bindings for use with the XR Device Simulator.
XR Device Simulator.prefab	Prefab with the XR Device Simulator component with references to actions configured, and an Input Action Manager component to enable the actions.

Input Actions Asset

The following image shows the Action editor of the Asset included in the sample, while editing one of the bindings of an action in one of the maps.

Tunneling Vignette

This sample is installed into the default location for package samples, in the Assets\Samples\XR Interaction Toolkit\[version]\Tunneling Vignette folder. You can move these Assets to a different location.

Asset	Description
TunnelingVignette.mat	Material used to display the tunnelling vignette with configurable properties, including aperture size, feathering effect, and vignette color.
TunnelingVignette.prefab	Prefab that contains a complete setup with necessary components for configuring and controlling the tunneling vignette. This Prefab is intended to be a child GameObject of the Main Camera.
TunnelingVignette.shader	Default shader used by the material and Prefab to compute the vignette effect. Works with the built-in rendering pipeline and Scriptable Render Pipeline (SRP).
TunnelingVignetteHemisphere.fbx	Hemisphere model with the mesh for showing the tunneling vignette on its inner surface.
TunnelingVignetteSG.shadergraph	Shader Graph asset primarily used as reference material to demonstrate the computation of the default shader. Notes in the asset explain the math involved and the steps needed to generate a SRP shader that achieves the same function as the default shader. This is not used by the material or Prefab, however this can be used as an alternative starting point to create a modified shader.

Document revision history

Date	Reason
April 29, 2022	Added documentation for the Tunneling Vignette sample. Updated Starter Assets with XRI UI action map. Updated preset images with new XR UI Input Module preset to match 2.1.0.
March 4, 2022	Updated Starter Assets for reorganized actions into new action maps. Matches package version 2.0.1.
February 15, 2022	Renamed the Default Input Actions sample to Starter Assets. Matches package version 2.0.0.
October 20, 2020	Document created. Matches package version 0.10.0.