Skip to content

Rename reference space types #640

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

Merged
merged 4 commits into from
May 14, 2019
Merged

Rename reference space types #640

merged 4 commits into from
May 14, 2019

Conversation

toji
Copy link
Member

@toji toji commented May 14, 2019

Renames several reference space types for clarity, as recommended in
issue #633. Intent is to better communicate which reference spaces are
floor-aligned and avoid potential developer confusion that may arise
from use of the term "stationary".

Renamed reference spaces:

  • eye-level -> local
  • floor-level -> local-floor
  • bounded -> bounded-floor

Renames several reference space types for clarity, as recommended in
issue #633. Intent is to better communicate which reference spaces are
floor-aligned and avoid potential developer confusion that may arise
from use of the term "stationary".

Renamed reference spaces:
 - `eye-level` -> `local`
 - `floor-level` -> `local-floor`
 - `bounded` -> `bounded-floor`
@toji toji added this to the May 2019 milestone May 14, 2019
@toji toji added the potential breaking change Issues that may affect the core design structure. label May 14, 2019
Copy link
Contributor

@thetuvix thetuvix left a comment

Choose a reason for hiding this comment

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

Looks good! Just a few explainer-specific suggestions.

Copy link
Member

@NellWaliczek NellWaliczek left a comment

Choose a reason for hiding this comment

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

Let's do it.

@toji
Copy link
Member Author

toji commented May 14, 2019

Thanks for the feedback! Resolved it and pushed again.

Copy link
Member

@NellWaliczek NellWaliczek left a comment

Choose a reason for hiding this comment

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

It might be clearer to no longer have a separate "Local experiences" section and instead just have the two (formerly) subtypes have their own headings at the same level as bounded-floor, viewer, and unbounded. Not blocking the merge on that, though. :)

#### Local reference spaces

Sometimes referred to as "seated", this reference space's origin will be initialized at a position near the viewer's position at the time of creation. The exact `x`, `y`, `z`, and orientation values will be initialized based on the conventions of the underlying platform for `local` experiences. Some platforms may initialize these values to the viewer's exact position/orientation at the time of creation. Other platforms that allow users to reset a common local origin shared across multiple apps may use that origin instead.
A _local_ experience is one which does not require the user to move around in space. Sometimes referred to as "seated", this reference space's origin will be initialized at a position near the viewer's position at the time of creation. The exact `x`, `y`, `z`, and orientation values will be initialized based on the conventions of the underlying platform for `local` experiences. Some platforms may initialize these values to the viewer's exact position/orientation at the time of creation. Other platforms that allow users to reset a common local origin shared across multiple apps may use that origin instead.
Copy link
Member

Choose a reason for hiding this comment

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

Some platforms may initialize these values to the viewer's exact position/orientation at the time of creation. Other platforms that allow users to reset a common local origin shared across multiple apps may use that origin instead.

This is something we may choose to require standardization around for privacy/security reasons....

Copy link
Member Author

Choose a reason for hiding this comment

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

Agreed. But that's a matter for a separate issue.

Copy link
Contributor

@thetuvix thetuvix May 14, 2019

Choose a reason for hiding this comment

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

This seems similar in privacy/security impact to bounded experiences to me - the user's first head pose can be relative to a user-calibrated origin, either nearby for local/local-floor or by the room center for bounded.

Do you see specific privacy/security impact around local?

@@ -149,6 +144,8 @@ function onSessionStarted(session) {
}
```

It is important to note that `XRViewerPose` objects retrieved using `local` and `local-floor` reference spaces may include position information as well as rotation information. For example, hardware which does not support 6DOF tracking (ex: GearVR) may still use neck-modeling to improve user comfort. Similarly, a user may lean side-to-side on a device with 6DOF tracking (ex: HTC Vive). The result is that `local` and `local-floor` experiences must be resilient to position changes despite not being dependent on receiving them.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe this should go into the section above? I'm not sure how to make sure this info doesn't get lost in the sea of words ^_^;

Copy link
Member Author

Choose a reason for hiding this comment

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

Moved it up a section and partially repeated that paragraph again down here. It does feel less likely to get overlooked that way.

@toji toji merged commit 8812f40 into master May 14, 2019
@toji toji deleted the space-rename branch May 14, 2019 21:50
@AdaRoseCannon AdaRoseCannon added ed:explainer Include in newsletter, explainer change ed:spec Include in newsletter, spec change labels Jun 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ed:explainer Include in newsletter, explainer change ed:spec Include in newsletter, spec change potential breaking change Issues that may affect the core design structure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants