boundary getting started and visualization config docs

Author: David Kline (ANALOG)

Documentation/Boundary/BoundarySystemGettingStarted.md

@@ -0,0 +1,65 @@
+# Boundary System
+
+The Boundary system provides support for visualizing Virtual Reality boundary components in
+mixed reality applications. Boundaries define the area in which users can move around in 
+while wearing a VR headset.
+
+Boundaries are an important component of a mixed reality experince to help users avoid unseen 
+obstacles while wearing a VR headset.
+
+Many Virtual Reality platforms provide automatic display, for example a white outline 
+superimposed on the virtual world as the user or their controller nears the boundary. The
+Mixed Reality Toolkit's boundary system extends this feature to enable the diplay of an 
+outline of the tracked area, a floor plane and other features that can be used to provide
+additional information to users. 
+
+## Getting Started
+
+Adding support for boundaries requires two key components of the Mixed Reality Toolkit: the 
+boundary system and a Virtual Reality platform configured with a boundary.
+
+1. [Enable](#enable-boundary-system) the boundary system
+2. [Configure](#configure-boundary-visualization) the boundary visualization
+3. [Build and deploy](#build-and-deploy) to a VR platform with a configured boundary
+
+## Enable Boundary System
+
+The boundary system is managed by the MixedRealityToolkit object (or another 
+[service registrar](xref:Microsoft.MixedReality.Toolkit.IMixedRealityServiceRegistrar) component). 
+
+> The following steps presume use of the MixedRealityToolkit object. Steps required for other service registrars may be different.
+
+1. Select the MixedRealityToolkit object in the scene hierarchy.
+
+![MRTK Configured Scene Hierarchy](../../External/ReadMeImages/MRTK_ConfiguredHierarchy.png)
+
+2. Navigate the Inspector panel to the Boundary System section and check Enable
+
+![Enable the Boundary System](../../External/ReadMeImages/Boundary/MRTKConfig_Boundary.png)
+
+3. Select the Boundary System implementation
+
+![Select the Boundarys System Implementation](../../External/ReadMeImages/Boundary/BoundarySelectSystemType.png)
+
+> Users of the default profile (DefaultMixedRealityToolkitConfigurationProfile) will have the boundary system pre-configured to use the MixedRealityBoundarySystem from the Mixed Reality 
+Toolkit Boundary System Service package.
+
+## Configure Boundary Visualization
+
+The boundary system uses a configuration profile to specify which boundary components are to be displayed and to configure their appearance. Please see [Configuring the Boundary Visualization](ConfiguringBoundaryVisualization.md) for more information pertaining to the available visualization options.
+
+![Boundary Visualization Options](../../External/ReadMeImages/Boundary/BoundaryVisualizationProfile.png)
+
+> Users of the default profile (DefaultMixedRealitBoundarySystemProfile) will have the boundary system pre-configured to display a floor plane, the play area and the tracked area.
+
+## Build and Deploy
+
+Once the boundary system is configured with the desired visualization options, the project can be built deployed to the target platform.
+
+> Using Play Mode, in Unity, enables in editor visualization of the configured boundary. This feature enables rapid development and testing without requiring the build and deploy step. Be sure to do final acceptance testing using an built and deployed version of the application, running on the target hardware and platform.
+
+## See Also
+
+- [Boundary API documentation](xref:Microsoft.MixedReality.Toolkit.Boundary)
+- [Configuring the Boundary Visualization](ConfiguringBoundaryVisualization.md)
+- [Using Boundaries in an Application](../TODO.md)

Documentation/Boundary/ConfiguringBoundaryVisualization.md

@@ -0,0 +1,112 @@
+# Configuring the Boundary Visualization
+
+The Boundary Visualization Profile provides options for configuring:
+
+- [General Settings](#general-settings)
+- [Floor Settings](#floor-settngs)
+- [Play Area Settings](#play-area-settings)
+- [Tracked Area Settings](#tracked-area-settings)
+- [Boundary Wall Settings](#boundary-wall-settings)
+- [Boundary Ceiling Settings](#boundary-ceiling-settings)
+
+Boundary visualizations are attached to the Mixed Reality Playspace object in the scene and teleport with the user.
+
+## General Settings
+
+![Boundary Visualization General Settings](../../External/ReadMeImages/Boundary/BoundaryVisualizationGeneralSettings.png)
+### Boundary Height
+
+The boundary height indicates the distance above the floor plane at which the boundary ceiling should be rendered. The default value is 3 meters.
+
+## Floor Settings
+
+![Boundary Visualization Floor Settings](../../External/ReadMeImages/Boundary/BoundaryVisualizationFloorSettings.png)
+
+### Show
+
+Indicates whether or not a floor plane is to be created and added to the scene. The default value is true.
+
+### Material
+
+Indicates the material that should be used when creating the floor plane.
+
+### Scale
+
+Indicates the size, in meters, of the floor plane to be created. The default scale is a 3 meter x 3 meter square.
+
+### Physics Layer
+
+The layer on which the floor plane should be set. The default value is the Default layer.
+
+## Play Area Settings
+
+![Boundary Visualization Play Area Settings](../../External/ReadMeImages/Boundary/BoundaryVisualizationPlayAreaSettings.png)
+
+### Show
+
+Indicates whether or not a play area rectangle is be created and added to the scene. The default value is true.
+
+### Material
+
+Indicates the material that should be used when creating the play area object.
+
+### Physics Layer
+
+The layer on which the play area should be set. The default value is the Ignore Raycast layer.
+
+## Tracked Area Settings
+
+![Boundary Visualization Tracked Area Settings](../../External/ReadMeImages/Boundary/BoundaryVisualizationTrackedAreaSettings.png)
+
+### Show
+
+Indicates whether or not the outline of the tracked area is be created and added to the scene. The default value is true.
+
+### Material
+
+Indicates the material that should be used when creating the tracked area outline.
+
+### Physics Layer
+
+The layer on which the tracked area should be sets. The default value is the Ignore Raycast layer.
+
+## Boundary Wall Settings
+
+![Boundary Visualization Boundary Wall Settings](../../External/ReadMeImages/Boundary/BoundaryVisualizationWalllSettings.png)
+
+### Show
+
+Indicates whether or not boundary wall planes are to be created and added to the scene. The default value is false.
+
+### Material
+
+Indicates the material that should be used when creating the boundary wall planes.
+
+### Physics Layer
+
+The layer on which the boundary walls should be set. The default value is the Ignore Raycast layer.
+
+> Setting the boundary wall component to a physics layer other than Ignore Raycast may prevent users from interacting with objects within the scene.
+
+## Boundary Ceiling Settings
+
+![Boundary Visualization Boundary Ceiling Settings](../../External/ReadMeImages/Boundary/BoundaryVisualizationCeilingSettings.png)
+
+### Show
+
+Indicates whether or not a boundary ceiling plane is to be created and added to the scene. The default value is false.
+
+### Material
+
+Indicates the material that should be used when creating the boundary ceiling plane.
+
+### Physics Layer
+
+The layer on which the boundary walls should be set. The default value is the Ignore Raycast layer.
+
+> Setting the boundary ceiling component to a physics layer other than Ignore Raycast may prevent users from interacting with objects within the scene.
+
+## See Also
+
+- [Boundary System](BoundaryGettingStarted.md)
+- [Using Boundaries in an Application](../TODO.md)

Documentation/toc.yml

@@ -19,6 +19,11 @@
       href: TODO.md
     - name: Service Provider
       href: MixedRealityConfigurationGuide.md
+    - name: Boundary System
+      href: Boundary/BoundarySystemGettingStarted.md
+      items:
+      - name: Configuring the Boundary Visualization
+        href: Boundary/ConfiguringBoundaryVisualization.md
     - name: Input
       href: TODO.md
       items: