Vive Input Utility Developer Guide

Size: px

Start display at page:

Download "Vive Input Utility Developer Guide"

Douglas Horn
5 years ago
Views:

Vive Input Utility Developer Guide vivesoftware@htc.com Abstract Vive Input Utility is a tool based on the SteamVR plugin that allows developers to access Vive device status in handy way.

1 Vive Input Utility Developer Guide Abstract Vive Input Utility is a tool based on the SteamVR plugin that allows developers to access Vive device status in handy way. We also introduce a mouse pointer solution that works in 3D space and is compatible with the Unity Event System. By importing this utility, developers can save lots of time in writing redundant code to manage Vive devices. Motivation The SteamVR plugin provides a C# interface to let Unity developers interact with Vive devices. But getting the controller input status or device pose causes lots of redundant code: You must continuously get the correct device index, which is determined by SteamVR_ControllerManager whenever a controller is connected. Locating SteamVR_ControllerManager also causes more effort. So our main goal is to provide handy interface and reduce the redundancy.

2 Main Features Using static function to retrieve device input: Button's event Tracking pose. Using ViveRaycaster component to achieve 3D-space-pointer that compatible with Unity Event System. Static Interface Get button's event Instead of finding device through SteamVR scripts... Static class ViveInput provides a simpler API to achieve that.

3 Listen to button's event ViveInput also provides callback style listener. Get tracking pose Static class VivePose provides an API to get a device pose.

4 Helper Components Vive Pose Tracker It works like SteamVR_TrackedObject, but targets device by using ViveRole.DeviceRole instead of device index. Pose Modifier It is a tracking effect script applied to a pose tracker. Implement abstract class PoseTracker.BasePoseModifier to write custom tracking effect. Without pose modifier With pose modifier

Vive Raycaster & Raycast Method Vive Raycaster is an event raycaster script that sends Vive button's event from

That means your controller can act like a 3D mouse by combining Vive Pose Tracker and Vive Raycaster.

Raycast Method Against Type Physics Raycast Method Collider Physics 2D Raycast Method Collider2D Graphic

5 Vive Raycaster & Raycast Method Vive Raycaster is an event raycaster script that sends Vive button's event from its transform. That means your controller can act like a 3D mouse by combining Vive Pose Tracker and Vive Raycaster. A Vive Raycaster must works with Raycast Method to raycast against different types of objects. Raycast Method Against Type Physics Raycast Method Collider Physics 2D Raycast Method Collider2D Graphic Raycast Method Graphic in target Canvas Canvas Raycast Method Graphic in all Canvas Raycast Target For example, you can arrange them like this to interact with UGUI menu: More examples:

6 Event System Handler You must implement an Event System Handler to catch an event sent by an event raycaster. Add a component that implements an event handler interface (derives from IEventSystemHandler) on an object. Add raycast-receiver (Collider/Collider2D/Graphic) to the object or child of the object.

7 API Reference uint ViveRole.GetDeviceIndex(.GetDeviceIndex(DeviceRole DeviceRole role) Returns device index assigned to the role. If target role is not assigned or disconnected, returns OpenVR.k_unTrackedDeviceIndexInvalid. bool VivePose.HasFocus() Returns true if input focus captured by current process. bool VivePose.IsConnected(.IsConnected(DeviceRole role) Returns true if device of role is connected. bool VivePose.HasTracking(.HasTracking(DeviceRole role) Returns true if device tracking data of role is valid. Pose VivePose.GetPose(.GetPose(DeviceRole role, Transform origin = null) Returns device tracking data of role relative to origin. void VivePose.SetPose(.SetPose(Transform target, DeviceRole role, Transform origin = null) Set device tracking data of role into target relative to origin. bool ViveInput.GetPress(.GetPress(HandRole Get button press state. bool ViveInput.GetPressDown(.GetPressDown(HandRole Get button press down state. bool ViveInput.GetPressUp(.GetPressUp(HandRole Get button press up state. float ViveInput.GetTriggerValue(.GetTriggerValue(HandRole role) Get trigger button pressed value. Vector2 ViveInput.GetPadAxis(.GetPadAxis(HandRole role) Get track pad touched axis.

8 int ViveInput.ClickCount(.ClickCount(HandRole Get button clicked count. Set ViveInput.clickInterval to configure click interval. float ViveInput.Last.LastPressDownTime( PressDownTime(HandRole Get button last press down frame time. void ViveInput.AddPress(.AddPress(HandRole Add press handler for button. Triggered every frame if button is pressed. void ViveInput.AddPressDown(.AddPressDown(HandRole Add press down handler for button. void ViveInput.AddPressUp(.AddPressUp(HandRole Add press up handler for button. void ViveInput.AddClick(.AddClick(HandRole Add click handler for button. Use ViveInput.ClickCount to get click count. void ViveInput.RemovePress(.RemovePress(HandRole Remove press handler for button. void ViveInput.RemovePressDown(.RemovePressDown(HandRole Remove press down handler for button. void ViveInput.RemovePressUp(.RemovePressUp(HandRole Remove press up handler for button. void ViveInput.RemoveClick(.RemoveClick(HandRole Remove click handler for button. void ViveInput.TriggerHapticPulse TriggerHapticPulse(HandRole HandRole role, ushort intensity = 500) Trigger controller vibration.

Vive Input Utility Developer Guide

Vive Input Utility Developer Guide using Valve.VR; public class GetPressDown_SteamVR : MonoBehaviour public SteamVR_ControllerManager manager; private void Update() // get trigger down SteamVR_TrackedObject trackedobj = manager.right.getcomponent();