Controller Model

Introduction

The Wave Controller package provides a lot of features that are already in legacy plugin (e.g. render model, button effect and controller tips). The Wave Controller package is installed by default when the Wave XR Plugin - Essence package is imported.

How to Import

In Unity, go to Project Settings -> Wave XR -> Essence.

../_images/C1.png ../_images/Co1.png

The Controller package is located in Assets/Wave/Essence. There is a sample WaveControllerTest inside the Demo folder.

Settings

The Wave Controller has 3 functions: RenderModel, ButtonEffect and ShowIndicator.

../_images/R1.png
  • RenderModel

This function loads the controller model from runtime based on the actual device connected.

  • Which hand

Identifies which device to load.

  • Default model

Loads the specified model when the runtime can’t provide the controller model.

  • ButtonEffect

Wave Controller will show a different color when you press a button/key.

  • Which hand

Identifies which device to monitor.

  • Enable button effect

If selected, the button effect will show when a key is pressed. This is enabled by default.

  • ShowIndicator

When ShowIndicator is selected, the Wave Controller will show a button tip for every button.

How to Use

With Unity XR Plugin, you can use the controller through the Interaction toolkit or attach the Tracked Pose Driver component to the Wave Controller. Follow the steps below to attach the Tracked Pose Driver to the Wave Controller.

  1. Work with the Interaction toolkit
  1. Add XR Rig to the scene by clicking GameObject > XR > Room-Scale XR Rig.
../_images/XR1.png
  1. In XR Rig, choose the controller you want to apply with the Wave Controller.
  2. Plug the WaveController to the Model Prefab.
../_images/XR2.png
  1. Attach the Tracked Pose Driver component to the Wave Controller.
  1. Add the WaveController to the scene.
  2. Add the new Tracked Pose Driver component.
../_images/TP1.png
  1. Change Device to Generic XR Controller.
  2. Change Pose Source to Right Controller or Left Controller.

Note

As the WaveLeftController and WaveRightController Prefabs have Render Model components attached to them, they will be destroyed when the controllers are disconnected from the headset. Avoid putting child objects under the Prefabs in the scene as the attached components may not be managed properly and may cause problems such as memory leak.

Demo

There is a sample that shows you how to use the Wave Controller with XRController inside the Demo folder.