The WebXR event squeezeend
is sent to an XRSession
when one of its input sources ends its primary action or when an input source that's in the process of handling an ongoing primary action is disconnected without successfully completing the action.
Primary squeeze actions include things like users pressing triggers or buttons, tapping a touchpad, speaking a command, or performing a recognizable gesture when using a video tracking system or handheld controller with an accelerometer.
Use the event name in methods like addEventListener()
, or set an event handler property.
addEventListener('squeezeend', event => { })
onsqueezeend = event => { }
In addition to the properties listed below, properties from the parent interface, Event
, are available.
-
frame
Read only
-
An XRFrame
object providing the needed information about the event frame during which the event occurred. This frame may have been rendered in the past rather than being a current frame. Because this is an event frame, not an animation frame, you cannot call XRFrame.getViewerPose()
on it; instead, use getPose()
.
-
inputSource
Read only
-
An XRInputSource
object indicating which input source generated the input event.
Triggered when users stop squeezing the controller, making a hand gesture that mimes grabbing something, or using (squeezing) a trigger.
The squeezestart
event is sent indicating that the user has begun a squeeze action.
If the primary squeeze action ends successfully, the session is sent a squeeze
event.
A squeezeend
event is sent to indicate that the squeeze action is no longer underway. This is sent whether the squeeze action succeeded or not.
See the squeezestart
event for example code.