Spatial Awareness Mesh Observer Profile
Spatial Awareness Mesh Observer Profile
The Spatial Awareness Mesh Observer Profile provides options for configuring:
Mesh Observer General Settings
The startup behavior specifies the behavior of the observer when it is first instantiated. The options are Auto Start and Manual Start. When set to Manual Start, applications will need to call one of the following IMixedRealitySpatialAwarenessSystem methods:
- ResumeObserver(string name)
- ResumeObservers()
- ResumeObservers()
The default value is Auto Start.
The time, in seconds, between requests to the platform to update spatial mesh data. Typical values fall in the range of 0.1 and 5.0 seconds.
Indicates whether or not the observer is to remain stationary or to move and update with the user.
When stationary, if user moves further than the Observation Extents away from the origin. In this instance, there would be no mesh data around the user until they moved closer to the origin.
The observer shape defines the type of volume that the mesh observer will use when observing meshes. The supported options are:
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.
A user aligned cube volume is a rectangular shape that rotates to align with the users local coordinate system.
The observation extents define the distance from the observation point that meshes will be observed. When the Observer Shape is set to Sphere, the X value of the extents will be used as the radius of the sphere.
Mesh Observer Physics Settings
The physics layer specifies which layer on which the spatial mesh objects will be placed in order to interact with the Unity Physics and RayCast systems. The Mixed Reality Toolkit reserves layer 31 by default for use by Spatial Awareness observers.
Specifies whether or not the mesh observer will recalculate the normals of the mesh following observation. This setting is available to ensure applications receive meshes that contain valid normals data on platforms that do not return them with meshes.
Mesh Observer Level of Detail Settings
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.
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 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.
When using the Custom Level of Detail, specifies the requested value for the triangle density for the spatial mesh.
Mesh Observer Display Settings
Specifies how spatial meshes are to be displayed by the observer. Supported values are None, Visible and Occlusion. Setting Visible or Occlusion instructs the observer to select the appropriate material. Specifying None causes the observer to not render the mesh.
Note: Setting Display Option to None does not stop the observer from running. If you wish to stop the observer, applications will need to call one of the following IMixedRealitySpatialAwarenessSystem methods:
- SuspendObserver(string name)
- SuspendObservers()
- SuspendObservers()
Indicates the material to be used when visualizing the spatial mesh.
Indicates the material to be used to cause the spatial mesh to occlude holograms.