SceneUnderstandingObserverProfile Class

Definition

Namespace:

Microsoft.MixedReality.Toolkit.WindowsSceneUnderstanding.Experimental

Assembly:

Microsoft.MixedReality.Toolkit.Providers.WindowsSceneUnderstanding.dll

Configuration profile settings for spatial awareness mesh observers.

public ref class SceneUnderstandingObserverProfile : Microsoft::MixedReality::Toolkit::SpatialAwareness::BaseSpatialAwarenessObserverProfile

[Microsoft.MixedReality.Toolkit.MixedRealityServiceProfile(typeof(Microsoft.MixedReality.Toolkit.Experimental.SpatialAwareness.IMixedRealitySceneUnderstandingObserver), null)]
[UnityEngine.CreateAssetMenu(fileName="SceneUnderstandingObserverProfile", menuName="Mixed Reality Toolkit/Profiles/Scene Understanding Observer Profile", order=21)]
public class SceneUnderstandingObserverProfile : Microsoft.MixedReality.Toolkit.SpatialAwareness.BaseSpatialAwarenessObserverProfile

[<Microsoft.MixedReality.Toolkit.MixedRealityServiceProfile(typeof(Microsoft.MixedReality.Toolkit.Experimental.SpatialAwareness.IMixedRealitySceneUnderstandingObserver), null)>]
[<UnityEngine.CreateAssetMenu(fileName="SceneUnderstandingObserverProfile", menuName="Mixed Reality Toolkit/Profiles/Scene Understanding Observer Profile", order=21)>]
type SceneUnderstandingObserverProfile = class
    inherit BaseSpatialAwarenessObserverProfile

Public Class SceneUnderstandingObserverProfile
Inherits BaseSpatialAwarenessObserverProfile

Inheritance

UnityEngine.ScriptableObject

BaseMixedRealityProfile

BaseSpatialAwarenessObserverProfile

SceneUnderstandingObserverProfile

Attributes

MixedRealityServiceProfileAttribute UnityEngine.CreateAssetMenuAttribute

Constructors

SceneUnderstandingObserverProfile()

Properties

AutoUpdate	Whether the observer updates its observations automatically on interval.
CreateGameObjects	When updating planes, save data to file.
DefaultMaterial	The material to be used when displaying understood planes.
DefaultPhysicsLayer	Physics layer on which to set understood planes
DefaultWorldMeshMaterial	The material to be used when displaying the world mesh.
FirstAutoUpdateDelay	Delay in seconds before the observer starts to update automatically for the first time after initialization
InferRegions	When enabled, renders observed and inferred regions for scene objects. When disabled, renders only the observed regions for scene objects.
InstantiationBatchRate	Number of planes to spawn per frame. Used to throttle object creation for performance.
IsStationaryObserver	Indicates whether or not the spatial observer is to remain in a fixed location. (Inherited from BaseSpatialAwarenessObserverProfile)
ObservationExtents	The size of the volume, in meters per axis, from which individual observations will be made. (Inherited from BaseSpatialAwarenessObserverProfile)
ObserverVolumeType	The shape (ex: axis aligned cube) of the observation volume. (Inherited from BaseSpatialAwarenessObserverProfile)
OcclusionMaskResolution	Sets pixel resolution of occlusion mask
OrientScene	When in editor, attempt to align scene to largest found floor's normal
QueryRadius	Keep previously observed objects when updating the scene
RequestMeshData	Generate mesh objects from surfaces.
RequestOcclusionMask	When instantiating quads, show the occlusion mask texture
RequestPlaneData	Generate plane objects for surface types.
SerializedScene	The path to the saved scene understanding file.
ShouldLoadFromFile	Load saved scan data from a file instead of getting live date from device. Only works in Editor.
StartupBehavior	Indicates if the observer is to start immediately or wait for manual startup. (Inherited from BaseSpatialAwarenessObserverProfile)
SurfaceTypes	Which plane types the observer should generate.
UpdateInterval	The frequency, in seconds, at which the spatial observer updates. (Inherited from BaseSpatialAwarenessObserverProfile)
UpdateOnceInitialized	Whether the observer updates once after initialization (regardless whether AutoUpdate is true).
UsePersistentObjects	Keep previously observed objects when updating the scene
WorldMeshLevelOfDetail	The amount of detail applied to the BoundlessSRMesh and/or GeneratePlanarMeshes.