Skip to content

Link to 'fire an input source' algorithm, explicitly construct frame #797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
toji merged 1 commit into from
Aug 15, 2019
Merged

Link to 'fire an input source' algorithm, explicitly construct frame #797

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 20 additions & 15 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1455,21 +1455,23 @@ When an [=XR input source=] for {{XRSession}} |session| begins its [=primary act

<div class="algorithm" data-algorithm="on-input-end">

When an [=XR input source=] for {{XRSession}} |session| ends its [=primary action=] the UA MUST run the following steps:
When an [=XR input source=] |source| for {{XRSession}} |session| ends its [=primary action=] the UA MUST run the following steps:

1. Let |frame| be a new {{XRFrame}} with {{XRFrame/session}} |session| for the time the event occurred.

@Manishearth Manishearth Aug 13, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit tedious to create the frame separately each time. I could also create the frame in the algorithm, however we may need to more strongly imply that the frame refers to poses from the time of the event, given that the algorithm is always called within a queued task (and thus the frame should not refer to poses from the time of the task)

@toji toji Aug 15, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I can see that this is a bit of a pain, but I think your logic here is sound and that this captures the intended timing well.

1. [=Queue a task=] to perform the following steps:
1. Fire an {{XRInputSourceEvent}} named {{select!!event}} on |session|.
1. Fire an {{XRInputSourceEvent}} named {{selectend!!event}} on |session|.
1. [=Fire an input source event=] with name {{select!!event}}, frame |frame|, and source |source|.
1. [=Fire an input source event=] with name {{selectend!!event}}, frame |frame|, and source |source|.

</div>

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.

<div class="algorithm" data-algorithm="on-input-cancelled">

When an [=XR input source=] for {{XRSession}} |session| has its [=primary action=] cancelled the UA MUST run the following steps:
When an [=XR input source=] |source| for {{XRSession}} |session| has its [=primary action=] cancelled the UA MUST run the following steps:

1. [=Queue a task=] to [=fire an event|fire=] an {{XRInputSourceEvent}} named {{selectend!!event}} on |session|.
1. Let |frame| be a new {{XRFrame}} with {{XRFrame/session}} |session| for the time the event occurred.
1. [=Queue a task=] to [=fire an input source event=] an {{XRInputSourceEvent}} with name {{selectend!!event}}, frame |frame|, and source |source|.

</div>

Expand All @@ -1482,34 +1484,37 @@ Some [=/XR Device=]s may support <dfn>transient input sources</dfn>, where the [

<div class="algorithm" data-algorithm="on-transient-input-start">

When a [=transient input source=] for {{XRSession}} |session| begins its [=primary action=] the UA MUST run the following steps:
When a [=transient input source=] |source| for {{XRSession}} |session| begins its [=primary action=] the UA MUST run the following steps:

1. Let |frame| be a new {{XRFrame}} with {{XRFrame/session}} |session| for the time the event occurred.
1. [=Queue a task=] to perform the following steps:
1. Fire any <code>"pointerdown"</code> events produced by the [=XR input source=]'s action, if necessary.
1. [=add input source|Add the XR input source=] to the [=list of active XR input sources=].
1. Fire an {{XRInputSourceEvent}} named {{selectstart!!event}} on |session|.
1. [=Fire an input source event=] with name {{selectstart!!event}}, frame |frame|, and source |source|.

</div>

<div class="algorithm" data-algorithm="on-transient-input-end">

When a [=transient input source=] for {{XRSession}} |session| ends its [=primary action=] the UA MUST run the following steps:
When a [=transient input source=] |source| for {{XRSession}} |session| ends its [=primary action=] the UA MUST run the following steps:

1. Let |frame| be a new {{XRFrame}} with {{XRFrame/session}} |session| for the time the event occurred.
1. [=Queue a task=] to perform the following steps:
1. Fires an {{XRInputSourceEvent}} named {{select!!event}} on |session|.
1. [=Fire an input source event=] with name {{select!!event}}, frame |frame|, and source |source|.
1. Fire any <code>"click"</code> events produced by the [=XR input source=]'s action, if necessary.
1. Fires an {{XRInputSourceEvent}} named {{selectend!!event}} on |session|.
1. [=Fire an input source event=] with name {{selectend!!event}}, frame |frame|, and source |source|.
1. [=remove input source|Remove the XR input source=] from the [=list of active XR input sources=].
1. Fire any <code>"pointerup"</code> events produced by the [=XR input source=]'s action, if necessary.

</div>

<div class="algorithm" data-algorithm="on-transient-input-cancelled">

When a [=transient input source=] for {{XRSession}} |session| has its [=primary action=] cancelled the UA MUST run the following steps:
When a [=transient input source=] |source| for {{XRSession}} |session| has its [=primary action=] cancelled the UA MUST run the following steps:

1. Let |frame| be a new {{XRFrame}} with {{XRFrame/session}} |session| for the time the event occurred.
1. [=Queue a task=] to perform the following steps:
1. Fire an {{XRInputSourceEvent}} named {{selectend!!event}} on |session|.
1. [=Fire an input source event=] with name {{selectend!!event}}, frame |frame|, and source |source|.
1. [=remove input source|Remove the XR input source=] from the [=list of active XR input sources=].
1. Fire any <code>"pointerup"</code> events produced by the [=XR input source=]'s action, if necessary.

Expand Down Expand Up @@ -1846,11 +1851,11 @@ The <dfn attribute for="XRInputSourceEvent">frame</dfn> attribute is an {{XRFram

<div class="algorithm" data-algorithm="fire-input-source-event">

When the user agent fires an {{XRInputSourceEvent}} |event| it MUST run the following steps:
When the user agent has to <dfn>fire an input source event</dfn> with name |name|, {{XRFrame}} |frame|, and {{XRInputSource}} |source| it MUST run the following steps:

1. Let |frame| be |event|'s {{XRInputSourceEvent/frame}}.
1. Create an {{XRInputSourceEvent}} |event| with {{Event/type}} |name|, {{XRInputSourceEvent/frame}} |frame|, and {{XRInputSourceEvent/inputSource}} |source|
1. Set |frame|'s [=active=] boolean to <code>true</code>.
1. [=Dispatch=] |event|.
1. [=Dispatch=] |event| on |frame|'s {{XRFrame/session}}
1. Set |frame|'s [=active=] boolean to <code>false</code>.

</div>
Expand Down