Select your preferred scripting language. All code snippets will be displayed in this language.
struct in UnityEngine.XR.WSA.Input
/
Implemented in:UnityEngine.VRModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseRepresents a snapshot of the state of a spatial interaction source (hand, voice or controller) at a given time.
anyPressed | True if the source is in the pressed state. |
grasped | Whether the controller is grasped. |
headPose | Head pose of the user at the time of the interaction. |
menuPressed | Whether or not the menu button is pressed. |
properties | Additional properties to explore the state of the interaction source. |
selectPressed | Depending on the InteractionSourceType of the interaction source, this returning true could represent a number of equivalent things: main button on a clicker, air-tap on a hand, and the trigger on a motion controller. For hands, a select-press represents the user's index finger in the down position. For motion controllers, a select-press represents the controller's index-finger trigger (or primary face button, if no trigger) being fully pressed. Note that a voice command of "Select" causes an instant press and release, so you cannot poll for a voice press using this property - instead, you must use GestureRecognizer and subscribe to the Tapped event, or subscribe to the InteractionSourcePressed event from InteractionManager. |
selectPressedAmount | Normalized amount ([0, 1]) representing how much select is pressed. |
source | The interaction source that this state describes. |
sourcePose | Pose data of the interaction source at the time of the interaction. |
thumbstickPosition | Normalized coordinates for the position of a thumbstick. |
thumbstickPressed | Whether or not the thumbstick is pressed. |
touchpadPosition | Normalized coordinates for the position of a touchpad interaction. |
touchpadPressed | Whether or not the touchpad is pressed, as if a button. |
touchpadTouched | Whether or not the touchpad is touched. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!