To facilitate Unity Editor native support for tracked controllers supported by OpenVR, the Unity VR subsystem presents VR controller inputs as separate joysticks. You can access their axis and button values with the UnityEngine.Input class.
By using OpenVR’s controller abstraction, the Unity Editor presents axis and button states in a hardware-agnostic approach (that is, it doesn’t refer to any specific hardware, but uses generic terms). However, for the sake of clarity, the axis and button mappings given below are for the two supported controller types: the HTC Vive controllers, and the Oculus Touch Controllers.
When properly configured and connected, a pair of Oculus Touch Controllers or a pair of HTC Vive controllers appear in the list returned by UnityEngine.Input.GetJoystickNames() as OpenVR Controller - Left and OpenVR Controller - Right. When available, these controllers appear highlighted in green in the SteamVR status window.
Unity script code can test for the availability of these controllers by periodically checking for their presence in the list of joystick names. When the controllers are turned off or have their batteries removed, an empty string replaces their name in the list returned by UnityEngine.Input.GetJoystickNames(). When the controllers are turned on again, their name appears in the list of returned joysticks.
Vive Controller Hardware Feature | Touch Controller Hardware Feature | Interaction Type | Unity Button ID | Unity Axis ID | Unity Axis Value Range |
---|---|---|---|---|---|
Left Controller Menu Button (1) | Button.Three | Press | 2 | ||
Right Controller Menu Button (1) | Button.One | Press | 0 | ||
Left Controller Trackpad (2) | Button.PrimaryThumbstick | Press | 8 | ||
Right Controller Trackpad (2) | Button.SecondaryThumbstick | Press | 9 | ||
Left Controller Trackpad (2) | Button.PrimaryThumbstick | Touch | 16 | ||
Right Controller Trackpad (2) | Button.SecondaryThumbstick | Touch | 17 | ||
Left Controller Trackpad (2) | Axis2D.PrimaryThumbstick | Horizontal Movement | 1 | –1.0 to 1.0 | |
Left Controller Trackpad (2) | Axis2D.PrimaryThumbstick | Vertical Movement | 2 | –1.0 to 1.0 | |
Right Controller Trackpad (2) | Axis2D.SecondaryThumbstick | Horizontal Movement | 4 | –1.0 to 1.0 | |
Right Controller Trackpad (2) | Axis2D.SecondaryThumbstick | Vertical Movement | 5 | –1.0 to 1.0 | |
Left Controller Trigger (7) | Axis1D.PrimaryIndexTrigger | Touch | 14 | ||
Right Controller Trigger (7) | Axis1D.SecondaryIndexTrigger | Touch | 15 | ||
Left Controller Trigger (7) | Axis1D.PrimaryIndexTrigger | Squeeze | 9 | 0.0 to 1.0 | |
Right Controller Trigger (7) | Axis1D.SecondaryIndexTrigger | Squeeze | 10 | 0.0 to 1.0 | |
Left Controller Grip Button (8) | Axis1D.PrimaryHandTrigger | Squeeze | 11 | 0.0 to 1.0 | |
Right Controller Grip Button (8) | Axis1D.SecondaryHandTrigger | Squeeze | 12 | 0.0 to 1.0 |
Notes:
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.