Getting started documentation for spatial awareness#3774
Merged
keveleigh merged 9 commits intomicrosoft:mrtk_developmentfrom Apr 3, 2019
david-c-kline:docs_spatial
Merged
Getting started documentation for spatial awareness#3774keveleigh merged 9 commits intomicrosoft:mrtk_developmentfrom david-c-kline:docs_spatial
keveleigh merged 9 commits intomicrosoft:mrtk_developmentfrom
david-c-kline:docs_spatial
Conversation
added 7 commits
April 1, 2019 16:50
david-c-kline
requested review from
Yoyozilla,
keveleigh,
radicalad,
thalbern and
wiwei
wiwei
changed the title
wiwei
reviewed
Apr 2, 2019
Documentation/SpatialAwareness/SpatialAwarenessGettingStarted.md
Outdated
Show resolved
Hide resolved
wiwei
reviewed
Apr 2, 2019
wiwei
reviewed
Apr 2, 2019
wiwei
reviewed
Apr 2, 2019
wiwei
reviewed
Apr 2, 2019
Documentation/SpatialAwareness/SpatialAwarenessGettingStarted.md
Outdated
Show resolved
Hide resolved
wiwei
approved these changes
Apr 3, 2019
keveleigh
approved these changes
Apr 3, 2019
thalbern
requested changes
Apr 3, 2019
Contributor
thalbern
left a comment
thalbern
left a comment
There was a problem hiding this comment.
i noticed spatial awareness is sometimes written in uppercase and sometimes in lowercase. we might want to have something consistent there? I commented today in the docs channel that we should have and follow some style guide for documentation, but that's tbd :)
|
|
||
| #### Axis Aligned Cube | ||
|
|
||
| An axis aligned cube volume is a rectangular shape that stays aligned with the axes of the world coordinate system, as determened at application startup. |
Contributor
There was a problem hiding this comment.
Suggested change
| An axis aligned cube volume is a rectangular shape that stays aligned with the axes of the world coordinate system, as determened at application startup. | |
| An axis aligned cube volume is a rectangular shape that stays aligned with the axes of the world coordinate system, as determined at application startup. |
|
|
||
| ### Observation Extents | ||
|
|
||
| The observation extents define the distance from the observation point that meshes will be observed. When the [Observer Shape](#observer-shape) is set to Sphere, the X value of the extents will be used as the radius of the sphere. |
Contributor
There was a problem hiding this comment.
Suggested change
| The observation extents define the distance from the observation point that meshes will be observed. When the [Observer Shape](#observer-shape) is set to Sphere, the X value of the extents will be used as the radius of the sphere. | |
| The observation extents define the distance from the observation point that meshes will be observed. When the [Observer Shape](#observer-shape) is set to sphere, the X value of the extents will be used as the radius of the sphere. |
|
|
||
| Specifies the level of detail (LOD) of the spatial mesh data. Currently defined values are Coarse, Fine and Custom. | ||
|
|
||
| The Coarse LOD generally place a smaller impact on application performance and are an excellent choice for navigation and plane finding. |
Contributor
There was a problem hiding this comment.
Suggested change
| The Coarse LOD generally place a smaller impact on application performance and are an excellent choice for navigation and plane finding. | |
| The Coarse LOD generally places a smaller impact on application performance and are an excellent choice for navigation and plane finding. |
|
|
||
| The Coarse LOD generally place a smaller impact on application performance and are an excellent choice for navigation and plane finding. | ||
|
|
||
| The Fine LOD generally exact a higher performance impact on application performance and are a great option for occlusion meshes. |
Contributor
There was a problem hiding this comment.
Suggested change
| The Fine LOD generally exact a higher performance impact on application performance and are a great option for occlusion meshes. | |
| The Fine LOD generally exacts a higher performance impact on application performance and are a great option for occlusion meshes. |
|
|
||
| The Fine LOD generally exact a higher performance impact on application performance and are a great option for occlusion meshes. | ||
|
|
||
| The Custom LOD require the application to specify the [Triangles / Cubic Meter](#triangles-per-cubic-meter) value and allows applications to tune the accuracy vs. performance impact of the spatial mesh observer. |
Contributor
There was a problem hiding this comment.
Suggested change
| The Custom LOD require the application to specify the [Triangles / Cubic Meter](#triangles-per-cubic-meter) value and allows applications to tune the accuracy vs. performance impact of the spatial mesh observer. | |
| The Custom LOD requires the application to specify the [Triangles / Cubic Meter](#triangles-per-cubic-meter) value and allows applications to tune the accuracy vs. performance impact of the spatial mesh observer. |
|
|
||
| The Custom LOD require the application to specify the [Triangles / Cubic Meter](#triangles-per-cubic-meter) value and allows applications to tune the accuracy vs. performance impact of the spatial mesh observer. | ||
|
|
||
| > Note: It is not guaranteed that all Triangles/Cubic Meter values are honored by all platforms. Experimentation and profiling is highlu recommended when using a custom LOD. |
Contributor
There was a problem hiding this comment.
Suggested change
| > Note: It is not guaranteed that all Triangles/Cubic Meter values are honored by all platforms. Experimentation and profiling is highlu recommended when using a custom LOD. | |
| > Note: It is not guaranteed that all Triangles/Cubic Meter values are honored by all platforms. Experimentation and profiling is highly recommended when using a custom LOD. |
|
|
||
| ### Triangles per Cubic Meter | ||
|
|
||
| When using the Custom [Level of Detail](#level-of-detail), specifies the requested value for the triangle density for the spatial mesh. |
Contributor
There was a problem hiding this comment.
Suggested change
| When using the Custom [Level of Detail](#level-of-detail), specifies the requested value for the triangle density for the spatial mesh. | |
| When using the custom [Level of Detail](#level-of-detail), specifies the requested value for the triangle density for the spatial mesh. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
High level configuring spatial awareness with links to the API docs and (to be written) pages on using in an app and configuring the mesh observer