Spatial Awareness - Usage Guide

This document contains some guides for common tasks that programmatically access the spatial awareness system.

Enumerating and accessing the meshes

Accessing the meshes that are currently known to the spatial awareness system involves first querying for the spatial awareness system, then getting a hold of the IMixedRealitySpatialAwarenessMeshObserver (note that the base spatial awareness observer has no notion of meshes), and then enumerating those meshes known to that observer.

Note that the sample below assumes that you have a single spatial mesh observer (which is the default) unless you have extended the spatial awareness system.

if (MixedRealityServiceRegistry.TryGetService<IMixedRealitySpatialAwarenessSystem>(out var service))
{
    IMixedRealityDataProviderAccess dataProviderAccess = service as IMixedRealityDataProviderAccess;

    IMixedRealitySpatialAwarenessMeshObserver observer =
        dataProviderAccess.GetDataProvider<IMixedRealitySpatialAwarenessMeshObserver>();

    foreach (SpatialAwarenessMeshObject meshObject in observer.Meshes.Values)
    {
        Mesh mesh = meshObject.Filter.mesh;
    }
}

Registering for mesh added and removed events

Please see the DemoSpatialMeshHandler for an example of how to listen to mesh events.

Starting and stopping mesh observation

It's possible to programmatically suspend and resume mesh observation. The sample code below shows how to access a particular observer (the mixed reality spatial mesh observer) to pause and then immediately resume observation.

if (MixedRealityServiceRegistry.TryGetService<IMixedRealitySpatialAwarenessSystem>(out var service))
{
    IMixedRealityDataProviderAccess dataProviderAccess = service as IMixedRealityDataProviderAccess;

    IMixedRealitySpatialAwarenessMeshObserver observer =
        dataProviderAccess.GetDataProvider<IMixedRealitySpatialAwarenessMeshObserver>();

    // Suspends observation.
    observer.Suspend();

    // Resumes observation.
    observer.Resume();
}

Hiding the spatial mesh

It's possible to programmatically hide meshes using the sample code below:

if (MixedRealityServiceRegistry.TryGetService<IMixedRealitySpatialAwarenessSystem>(out var service))
    {
        IMixedRealityDataProviderAccess dataProviderAccess = service as IMixedRealityDataProviderAccess;

        IMixedRealitySpatialAwarenessMeshObserver observer =
            dataProviderAccess.GetDataProvider<IMixedRealitySpatialAwarenessMeshObserver>();
        
        observer.DisplayOption = SpatialAwarenessMeshDisplayOptions.None;
    }
}