Class SceneUnderstandingObserverProfile

Configuration profile settings for spatial awareness mesh observers.

Inheritance
Object
SceneUnderstandingObserverProfile
Namespace: Microsoft.MixedReality.Toolkit.WindowsSceneUnderstanding.Experimental
Assembly: cs.temp.dll.dll
Syntax
[MixedRealityServiceProfile(typeof(IMixedRealitySceneUnderstandingObserver))]
public class SceneUnderstandingObserverProfile : BaseSpatialAwarenessObserverProfile

Properties

AutoUpdate

Whether the observer updates its observations automatically on interval.

Declaration
public bool AutoUpdate { get; }
Property Value
Type Description
Boolean
Remarks

When false, call UpdateOnDemand() to manually update an observer when needed.

CreateGameObjects

When updating planes, save data to file.

Declaration
public bool CreateGameObjects { get; }
Property Value
Type Description
Boolean

DefaultMaterial

The material to be used when displaying understood planes.

Declaration
public Material DefaultMaterial { get; }
Property Value
Type Description
Material

DefaultPhysicsLayer

Physics layer on which to set understood planes

Declaration
public int DefaultPhysicsLayer { get; }
Property Value
Type Description
Int32

DefaultWorldMeshMaterial

The material to be used when displaying the world mesh.

Declaration
public Material DefaultWorldMeshMaterial { get; }
Property Value
Type Description
Material

FirstAutoUpdateDelay

Delay in seconds before the observer starts to update automatically for the first time after initialization

Declaration
public float FirstAutoUpdateDelay { get; }
Property Value
Type Description
Single

InferRegions

When enabled, renders observed and inferred regions for scene objects. When disabled, renders only the observed regions for scene objects.

Declaration
public bool InferRegions { get; }
Property Value
Type Description
Boolean

InstantiationBatchRate

Number of planes to spawn per frame. Used to throttle object creation for performance.

Declaration
public int InstantiationBatchRate { get; }
Property Value
Type Description
Int32

OcclusionMaskResolution

Sets pixel resolution of occlusion mask

Declaration
public Vector2Int OcclusionMaskResolution { get; }
Property Value
Type Description
Vector2Int

OrientScene

When in editor, attempt to align scene to largest found floor's normal

Declaration
public bool OrientScene { get; }
Property Value
Type Description
Boolean

QueryRadius

Keep previously observed objects when updating the scene

Declaration
public float QueryRadius { get; }
Property Value
Type Description
Single

RequestMeshData

Generate mesh objects from surfaces.

Declaration
public bool RequestMeshData { get; }
Property Value
Type Description
Boolean

RequestOcclusionMask

When instantiating quads, show the occlusion mask texture

Declaration
public bool RequestOcclusionMask { get; }
Property Value
Type Description
Boolean

RequestPlaneData

Generate plane objects for surface types.

Declaration
public bool RequestPlaneData { get; }
Property Value
Type Description
Boolean

SerializedScene

The path to the saved scene understanding file.

Declaration
public TextAsset SerializedScene { get; }
Property Value
Type Description
TextAsset

ShouldLoadFromFile

Load saved scan data from a file instead of getting live date from device. Only works in Editor.

Declaration
public bool ShouldLoadFromFile { get; }
Property Value
Type Description
Boolean

SurfaceTypes

Which plane types the observer should generate.

Declaration
public SpatialAwarenessSurfaceTypes SurfaceTypes { get; }
Property Value
Type Description
SpatialAwarenessSurfaceTypes

UpdateOnceInitialized

Whether the observer updates once after initialization (regardless whether AutoUpdate is true).

Declaration
public bool UpdateOnceInitialized { get; }
Property Value
Type Description
Boolean

UsePersistentObjects

Keep previously observed objects when updating the scene

Declaration
public bool UsePersistentObjects { get; }
Property Value
Type Description
Boolean

WorldMeshLevelOfDetail

The amount of detail applied to the BoundlessSRMesh and/or GeneratePlanarMeshes.

Declaration
public SpatialAwarenessMeshLevelOfDetail WorldMeshLevelOfDetail { get; }
Property Value
Type Description
SpatialAwarenessMeshLevelOfDetail