Define squeeze events #893

Manishearth · 2019-10-21T23:03:27Z

/fixes #876

This adds an optional "primary squeeze" mirroring the "primary action". Once this lands we can backreference it from the gamepads module.

This also cleans up the primary action spec text to make the primary action a requirement.

cc @thetuvix

toji · 2019-10-21T23:07:32Z

index.bs

  attribute EventHandler onselectstart;
  attribute EventHandler onselectend;
+  attribute EventHandler onsqueeze;
+  attribute EventHandler onsqueezestart;
+  attribute EventHandler onsqueezeend;


Not an actual issue, but reading onsqueezeend hurts my brain. It sounds like an imaginary verb conjugation my kids would make up. "I squeezend the balloon real hard, and it popped!" 😆

it will also be hard for non-native developers to write. Especially without the aid of camelcase or similar.

I agree they're hard to read. Unfortunately, IIRC, this casing convention isn't one our WG decided on; we're just following the general web platform guidance. Given that, I'm not sure what else can be done...

toji · 2019-10-21T23:08:15Z

index.bs

@@ -1505,6 +1515,8 @@ Note: {{XRInputSource}}s in an {{XRSession}}'s {{XRSession/inputSources}} array

 Each [=XR input source=] SHOULD define a <dfn>primary action</dfn>. The [=primary action=] is a platform-specific action that, when engaged, produces {{XRSession/selectstart}}, {{XRSession/selectend}}, and {{XRSession/select}} events. Examples of possible [=primary action=]s are pressing a trigger, touchpad, or button, speaking a command, or making a hand gesture. If the platform guidelines define a recommended primary input then it should be used as the [=primary action=], otherwise the user agent is free to select one.

+
+


Load bearing whitespace?

toji · 2019-10-21T23:16:30Z

index.bs

@@ -1526,6 +1538,29 @@ When an [=XR input source=] |source| for {{XRSession}} |session| ends its [=prim

 Sometimes platform-specific behavior can result in a [=primary action=] being interrupted or cancelled. For example, a [=/XR input source=] may be removed from the [=XRSession/XR device=] after the [=primary action=] is started but before it ends.

+Each [=XR input source=] MAY define a <dfn>primary squeeze</dfn>. The [=primary squeeze=] is a platform-specific action that, when engaged, produces {{XRSession/squeezestart}}, {{XRSession/squeezeend}}, and {{XRSession/squeeze}} events. The [=primary squeeze=] should be used for actions rougly mapping to squeezing or grabbing. Examples of possible [=primary squeeze=]s are pressing a grip trigger or making a grabbing hand gesture. If the platform guidelines define a recommended primary squeeze then it should be used as the [=primary squeeze=], otherwise the user agent is free to select one.


Again... this verbiage is making me laugh. I promise I'll get over it (or at least stop making dumb review comments about it) after this review is over.

"Main squeeze" ("most important person") is attested from 1896, the specific meaning "one's sweetheart, lover" is attested by 1980.

Wiktionary

s/Hammer/Controller

Real feedback: Maybe "primary squeeze action" or simply "squeeze action" would read better here. We may possibly also want to retcon "primary action" into "select action".

oh don't worry i have been finding the terminology "primary squeeze" hilarious as well, but i'm not too worried about it.

the retcon seems fine, though this may require further edits to the gamepad module as well as the input profiles repo for that. "primary squeeze action" seems okay though, i'll make that change

Manishearth · 2019-10-22T01:39:44Z

Addressed

toji

LGTM! ✊ (<-- Squeeze emoji)

NellWaliczek

Mostly LGTM. A few smallish comments and one notable question.

index.bs

NellWaliczek · 2019-10-22T18:38:16Z

index.bs

  attribute EventHandler onselectstart;
  attribute EventHandler onselectend;
+  attribute EventHandler onsqueeze;
+  attribute EventHandler onsqueezestart;
+  attribute EventHandler onsqueezeend;


I agree they're hard to read. Unfortunately, IIRC, this casing convention isn't one our WG decided on; we're just following the general web platform guidance. Given that, I'm not sure what else can be done...

NellWaliczek · 2019-10-22T18:39:43Z

index.bs

@@ -1526,6 +1536,29 @@ When an [=XR input source=] |source| for {{XRSession}} |session| ends its [=prim

 Sometimes platform-specific behavior can result in a [=primary action=] being interrupted or cancelled. For example, a [=/XR input source=] may be removed from the [=XRSession/XR device=] after the [=primary action=] is started but before it ends.

+Each [=XR input source=] MAY define a <dfn>primary squeeze action</dfn>. The [=primary squeeze action=] is a platform-specific action that, when engaged, produces {{XRSession/squeezestart}}, {{XRSession/squeezeend}}, and {{XRSession/squeeze}} events. The [=primary squeeze action=] should be used for actions rougly mapping to squeezing or grabbing. Examples of possible [=primary squeeze action=]s are pressing a grip trigger or making a grabbing hand gesture. If the platform guidelines define a recommended primary squeeze action then it should be used as the [=primary squeeze action=], otherwise the user agent is free to select one.


Each [=XR input source=] MAY define

Why is this event "MAY" and the other "SHOULD"?

We require a primary action, but I don't think we need to require a primary squeeze action.

Does that mean the trigger action should be MUST?

Hmm. Come to think of it, I thought it already was MUST somewhere in the spec. I don't mind changing it here, given that we're kinda requiring this in the gamepads spec.

NellWaliczek · 2019-10-22T18:40:43Z

index.bs

@@ -1526,6 +1536,29 @@ When an [=XR input source=] |source| for {{XRSession}} |session| ends its [=prim

 Sometimes platform-specific behavior can result in a [=primary action=] being interrupted or cancelled. For example, a [=/XR input source=] may be removed from the [=XRSession/XR device=] after the [=primary action=] is started but before it ends.

+Each [=XR input source=] MAY define a <dfn>primary squeeze action</dfn>. The [=primary squeeze action=] is a platform-specific action that, when engaged, produces {{XRSession/squeezestart}}, {{XRSession/squeezeend}}, and {{XRSession/squeeze}} events. The [=primary squeeze action=] should be used for actions rougly mapping to squeezing or grabbing. Examples of possible [=primary squeeze action=]s are pressing a grip trigger or making a grabbing hand gesture. If the platform guidelines define a recommended primary squeeze action then it should be used as the [=primary squeeze action=], otherwise the user agent is free to select one.


If the platform guidelines define a recommended primary squeeze action then it should be used as the [=primary squeeze action=], otherwise the user agent is free to select one.

Is this something that should be defined in the registry so there is consistent behavior for a given profile id?

Yes, the gamepads module already defines "primary squeeze", i'd like to edit it to point to this once this lands.

immersive-web/webxr-gamepads-module#24

Manishearth · 2019-10-23T21:19:46Z

r? @thetuvix

NellWaliczek

One last comment, otherwise LGTM!

NellWaliczek · 2019-10-23T22:10:09Z

index.bs

@@ -1526,6 +1536,29 @@ When an [=XR input source=] |source| for {{XRSession}} |session| ends its [=prim

 Sometimes platform-specific behavior can result in a [=primary action=] being interrupted or cancelled. For example, a [=/XR input source=] may be removed from the [=XRSession/XR device=] after the [=primary action=] is started but before it ends.

+Each [=XR input source=] MAY define a <dfn>primary squeeze action</dfn>. The [=primary squeeze action=] is a platform-specific action that, when engaged, produces {{XRSession/squeezestart}}, {{XRSession/squeezeend}}, and {{XRSession/squeeze}} events. The [=primary squeeze action=] should be used for actions rougly mapping to squeezing or grabbing. Examples of possible [=primary squeeze action=]s are pressing a grip trigger or making a grabbing hand gesture. If the platform guidelines define a recommended primary squeeze action then it should be used as the [=primary squeeze action=], otherwise the user agent is free to select one.


Does that mean the trigger action should be MUST?

index.bs

thetuvix · 2019-10-24T08:07:40Z

index.bs

@@ -1526,6 +1536,29 @@ When an [=XR input source=] |source| for {{XRSession}} |session| ends its [=prim

 Sometimes platform-specific behavior can result in a [=primary action=] being interrupted or cancelled. For example, a [=/XR input source=] may be removed from the [=XRSession/XR device=] after the [=primary action=] is started but before it ends.

+Each [=XR input source=] MAY define a <dfn>primary squeeze action</dfn>. The [=primary squeeze action=] is a platform-specific action that, when engaged, produces {{XRSession/squeezestart}}, {{XRSession/squeezeend}}, and {{XRSession/squeeze}} events. The [=primary squeeze action=] should be used for actions rougly mapping to squeezing or grabbing. Examples of possible [=primary squeeze action=]s are pressing a grip trigger or making a grabbing hand gesture. If the platform guidelines define a recommended primary squeeze action then it should be used as the [=primary squeeze action=], otherwise the user agent MAY select one.


In the gamepad spec, will we then specify that for "xr-standard", the squeeze action must map to button 1?

Yep! immersive-web/webxr-gamepads-module#24

Define squeeze events

46bf7b8

Manishearth requested a review from NellWaliczek October 21, 2019 23:04

Manishearth mentioned this pull request Oct 21, 2019

Expose events for a squeeze(grip) action #876

Closed

toji reviewed Oct 22, 2019

View reviewed changes

Manishearth added 2 commits October 21, 2019 18:39

primary squeeze -> primary squeeze action

1a0a1d1

rm whitespace

523a1f3

toji approved these changes Oct 22, 2019

View reviewed changes

NellWaliczek reviewed Oct 22, 2019

View reviewed changes

is free -> MAY

2ea19b8

Manishearth mentioned this pull request Oct 22, 2019

Link buttons[0] and buttons[1] to primary actions immersive-web/webxr-gamepads-module#24

Merged

immersive-web deleted a comment from Aadjou Oct 22, 2019

Manishearth added this to the October 2019 milestone Oct 23, 2019

NellWaliczek approved these changes Oct 23, 2019

View reviewed changes

Make primary action a MUST requirement

3f89665

thetuvix reviewed Oct 24, 2019

View reviewed changes

index.bs Outdated Show resolved Hide resolved

thetuvix reviewed Oct 24, 2019

View reviewed changes

fix typo

d8f83d0

Manishearth merged commit 5285b12 into immersive-web:master Oct 28, 2019

Manishearth deleted the squeeze branch October 28, 2019 21:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Define squeeze events #893

Define squeeze events #893

Manishearth commented Oct 21, 2019 •

edited

Loading

toji Oct 21, 2019

Aadjou Oct 22, 2019

NellWaliczek Oct 22, 2019

toji Oct 21, 2019

toji Oct 21, 2019

toji Oct 21, 2019

Manishearth Oct 22, 2019

Manishearth commented Oct 22, 2019

toji left a comment

NellWaliczek left a comment

NellWaliczek Oct 22, 2019

NellWaliczek Oct 22, 2019

Manishearth Oct 22, 2019

NellWaliczek Oct 23, 2019

Manishearth Oct 23, 2019

NellWaliczek Oct 22, 2019

Manishearth Oct 22, 2019

Manishearth Oct 22, 2019

Manishearth commented Oct 23, 2019

NellWaliczek left a comment

NellWaliczek Oct 23, 2019

thetuvix Oct 24, 2019

Manishearth Oct 24, 2019

		@@ -1505,6 +1515,8 @@ Note: {{XRInputSource}}s in an {{XRSession}}'s {{XRSession/inputSources}} array

		Each [=XR input source=] SHOULD define a <dfn>primary action</dfn>. The [=primary action=] is a platform-specific action that, when engaged, produces {{XRSession/selectstart}}, {{XRSession/selectend}}, and {{XRSession/select}} events. Examples of possible [=primary action=]s are pressing a trigger, touchpad, or button, speaking a command, or making a hand gesture. If the platform guidelines define a recommended primary input then it should be used as the [=primary action=], otherwise the user agent is free to select one.

		@@ -1526,6 +1538,29 @@ When an [=XR input source=] \|source\| for {{XRSession}} \|session\| ends its [=prim

		Sometimes platform-specific behavior can result in a [=primary action=] being interrupted or cancelled. For example, a [=/XR input source=] may be removed from the [=XRSession/XR device=] after the [=primary action=] is started but before it ends.

		Each [=XR input source=] MAY define a <dfn>primary squeeze</dfn>. The [=primary squeeze=] is a platform-specific action that, when engaged, produces {{XRSession/squeezestart}}, {{XRSession/squeezeend}}, and {{XRSession/squeeze}} events. The [=primary squeeze=] should be used for actions rougly mapping to squeezing or grabbing. Examples of possible [=primary squeeze=]s are pressing a grip trigger or making a grabbing hand gesture. If the platform guidelines define a recommended primary squeeze then it should be used as the [=primary squeeze=], otherwise the user agent is free to select one.

		@@ -1526,6 +1536,29 @@ When an [=XR input source=] \|source\| for {{XRSession}} \|session\| ends its [=prim

		Sometimes platform-specific behavior can result in a [=primary action=] being interrupted or cancelled. For example, a [=/XR input source=] may be removed from the [=XRSession/XR device=] after the [=primary action=] is started but before it ends.

		Each [=XR input source=] MAY define a <dfn>primary squeeze action</dfn>. The [=primary squeeze action=] is a platform-specific action that, when engaged, produces {{XRSession/squeezestart}}, {{XRSession/squeezeend}}, and {{XRSession/squeeze}} events. The [=primary squeeze action=] should be used for actions rougly mapping to squeezing or grabbing. Examples of possible [=primary squeeze action=]s are pressing a grip trigger or making a grabbing hand gesture. If the platform guidelines define a recommended primary squeeze action then it should be used as the [=primary squeeze action=], otherwise the user agent is free to select one.

Define squeeze events #893

Define squeeze events #893

Conversation

Manishearth commented Oct 21, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Manishearth commented Oct 22, 2019

toji left a comment

Choose a reason for hiding this comment

NellWaliczek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Manishearth commented Oct 23, 2019

NellWaliczek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Manishearth commented Oct 21, 2019 •

edited

Loading