Skip to content
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.

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

Add WebXR Hit Test reference docs - pt 1 #8042

Merged
merged 3 commits into from
Aug 19, 2021
Merged

Conversation

Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Aug 18, 2021

This talks about Hit testing initialization and adds reference pages for XRSession.requestHitTestSource() and XRSession.requestHitTestSourceForTransientInput().

Spec: https://immersive-web.github.io/hit-test

@Elchi3 Elchi3 requested a review from a team as a code owner August 18, 2021 11:10
@Elchi3 Elchi3 requested review from jpmedley and removed request for a team August 18, 2021 11:10
@github-actions
Copy link
Contributor

github-actions bot commented Aug 18, 2021

Preview URLs

Flaws

Note! 1 document with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/XRSession
Title: XRSession
on GitHub
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/XRHitTestSource does not exist
    • /en-US/docs/Web/API/XRTransientInputHitTestSource does not exist

URL: /en-US/docs/Web/API/XRSession/requestHitTestSource
Title: XRSession.requestHitTestSource()
on GitHub
Flaw count: 5

  • macros:
    • /en-US/docs/Web/API/XRHitTestSource does not exist
    • /en-US/docs/Web/API/XRFrame/getHitTestResults does not exist
    • /en-US/docs/Web/API/XRRay does not exist
    • /en-US/docs/Web/API/XRHitTestSource does not exist
    • /en-US/docs/Web/API/XRFrame/getHitTestResults does not exist

URL: /en-US/docs/Web/API/XRSession/requestHitTestSourceForTransientInput
Title: XRSession.requestHitTestSourceForTransientInput()
on GitHub
Flaw count: 5

  • macros:
    • /en-US/docs/Web/API/XRTransientInputHitTestSource does not exist
    • /en-US/docs/Web/API/XRFrame/getHitTestResultsForTransientInput does not exist
    • /en-US/docs/Web/API/XRRay does not exist
    • /en-US/docs/Web/API/XRTransientInputHitTestSource does not exist
    • /en-US/docs/Web/API/XRFrame/getHitTestResultsForTransientInput does not exist

External URLs

URL: /en-US/docs/Web/API/XRSystem/requestSession
Title: XRSystem: requestSession()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/XRSession
Title: XRSession
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/XRSession/requestHitTestSource
Title: XRSession.requestHitTestSource()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/XRSession/requestHitTestSourceForTransientInput
Title: XRSession.requestHitTestSourceForTransientInput()
on GitHub

No new external URLs

(this comment was updated 2021-08-19 10:31:58.336392)

@jpmedley jpmedley self-assigned this Aug 18, 2021
Copy link
Collaborator

@jpmedley jpmedley left a comment

Choose a reason for hiding this comment

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

Nice work. This is clean of typos. I have a few suggestions for wording.

- : An object containing configuration options, specifically:
- `space`: The {{domxref("XRSpace")}} that will be tracked by the hit test source.
- `entityTypes`: {{optional_inline}} An {{jsxref("Array")}} specifying the types of entities that should be used for the purposes of hit test source creation. If no no entity type is specified, the array defaults to a single element with the `plane` type. Possible types:
- `point`: Compute hit test results based on characteristic points detected.
Copy link
Collaborator

Choose a reason for hiding this comment

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

What are characteristic points?

The subtext of this question is, if I were a developer who didin't know what this is, would this provide me with enough information find out.

Copy link
Member Author

Choose a reason for hiding this comment

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

hm, yeah, I think this is rather vague and "characteristic points" is what the spec says. Not sure what else to say, though. I believe plane detection and detection using meshes are known concepts to XR/3D developers. For points, this issue argues that point detection could be subsumed into mesh detection: immersive-web/hit-test#66
I'm not expert enough to clarify "points" further. Does it refer to some new detection technique? LIDAR points? Something else? I guess this could be very device-specific also, so maybe that's why the spec left it as such?

Also, the whole entityTypes thing is rather unstable still. See immersive-web/hit-test#67 where some people also recognized that this API is rather hard to grok.

Copy link
Member Author

Choose a reason for hiding this comment

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

At least I've removed entityTypes from the code example now (it is optional anyway).

Copy link
Collaborator

Choose a reason for hiding this comment

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

I've requested a definition. I'm fine with resolving this for now.

@Elchi3
Copy link
Member Author

Elchi3 commented Aug 18, 2021

Thanks for your detailed reviews! \o/

@jpmedley jpmedley merged commit b8962e5 into mdn:main Aug 19, 2021
@Elchi3 Elchi3 deleted the webxr-hit-test-pt1 branch August 19, 2021 18:53
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants