VG_EC_UnityXRInteraction controller | VirtualGrasp Documentation

Description

This class represents a child class of VG_ExternalController.

If you haven’t yet, have a short look at VG_ControllerProfiles on the purpose of a VG_ExternalController.

Setup

The following requirements have to be met to be able to use this controller:

You have the Unity XR Management package installed into your Unity project.

This is an external controller class that supports the action-based Unity XR Interaction toolkit controller as an external controller.

Important: After assuring that the following conditions are met, you have to add the scripting define symbol VG_USE_UNITYXRINTERACTION_HAND to your Unity player settings (Project Settings → Player → Script Compilation).

The following requirements have to be met to be able to use the controller:

You have the “XR Plugin Management” package installed into your Unity project.
You have the “XR Interaction Toolkit” package installed into your Unity project.
You have selected “OpenXR” as the Plugin-Provider in Project Settings -> XR Plugin Management
if you use Oculus, you use it through “OpenXR” (Oculus -> Tools -> OVR Utilitites Plugin -> Set OVR to OpenXR)

Controller Profile

If these requirements are met, you will be able to use the VG_CP_Unity.XRInteraction controller profile to setup your MyVirtualGrasp configuration (otherwise an error will appear on the console).

VG Controller profile in Unity.

Functionality

Hand Poses

Only the wrists are mapped.

Will be controlled through UnityXR controller system, such as InputDevice.TryGetFeatureValue(CommonUsages.devicePosition).

Grab Signals

will be controlled through UnityXR controller system, such as InputDevice.TryGetFeatureValue(CommonUsages.trigger).

Haptic Signals

will be controlled through UnityXR controller system, such as InputDevice.SendHapticImpulse().