IMixedRealitySceneUnderstandingObserver Interface

Definition

Namespace:

Microsoft.MixedReality.Toolkit.Experimental.SpatialAwareness

Assembly:

Microsoft.MixedReality.Toolkit.dll

The interface for defining a spatial awareness observer which provides scene data.

public interface class IMixedRealitySceneUnderstandingObserver : IDisposable, Microsoft::MixedReality::Toolkit::Experimental::SpatialAwareness::IMixedRealityOnDemandObserver, System::Collections::IEqualityComparer

public interface IMixedRealitySceneUnderstandingObserver : IDisposable, Microsoft.MixedReality.Toolkit.Experimental.SpatialAwareness.IMixedRealityOnDemandObserver, System.Collections.IEqualityComparer

type IMixedRealitySceneUnderstandingObserver = interface
    interface IMixedRealityOnDemandObserver
    interface IMixedRealitySpatialAwarenessObserver
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityEventSource
    interface IEqualityComparer

Public Interface IMixedRealitySceneUnderstandingObserver
Implements IDisposable, IEqualityComparer, IMixedRealityOnDemandObserver

Derived

Microsoft.MixedReality.Toolkit.WindowsSceneUnderstanding.Experimental.WindowsSceneUnderstandingObserver

Implements

IMixedRealityOnDemandObserver IMixedRealityDataProvider IMixedRealityEventSource IMixedRealityService IMixedRealitySpatialAwarenessObserver IEqualityComparer IDisposable

Properties

AutoUpdate	Whether the observer updates its observations automatically on interval. (Inherited from IMixedRealityOnDemandObserver)
ConfigurationProfile	The configuration profile for the service. (Inherited from IMixedRealityService)
DefaultPhysicsLayer	Get or sets the default Unity Physics Layer on which to set the spatial object. (Inherited from IMixedRealitySpatialAwarenessObserver)
FirstAutoUpdateDelay	Delay in seconds before the observer starts to update automatically for the first time after initialization (Inherited from IMixedRealityOnDemandObserver)
InferRegions	When enabled, generates data for observed and inferred regions in the scene. When disabled, generates data only for observed regions in the scene.
InstantiationBatchRate	Number of meshes to generate per frame. Throttled to keep framerate under control.
IsRunning	Is the observer running (actively accumulating spatial data)? (Inherited from IMixedRealitySpatialAwarenessObserver)
IsStationaryObserver	Should the observer remain stationary in the scene? (Inherited from IMixedRealitySpatialAwarenessObserver)
Name	Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action. (Inherited from IMixedRealityService)
ObservationExtents	Gets or sets the extents (1/2 size) of the volume, in meters per axis, from which individual observations will be made. (Inherited from IMixedRealitySpatialAwarenessObserver)
ObserverOrigin	Gets or sets the origin, in world space, of the observer. (Inherited from IMixedRealitySpatialAwarenessObserver)
ObserverRotation	Gets or sets the orientation of the volume in world space. (Inherited from IMixedRealitySpatialAwarenessObserver)
ObserverVolumeType	Gets or sets the type of volume the observer should operate in. (Inherited from IMixedRealitySpatialAwarenessObserver)
Priority	Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated. (Inherited from IMixedRealityService)
QueryRadius	The distance infer surface understanding
RequestMeshData	When enabled, the service will provide surface meshes.
RequestOcclusionMask	When enabled, the service will generate texture data for suitable for spatial queries
RequestPlaneData	When enabled, the service will provide surface planes, represented as a quad.
SceneObjects	The set of SpatialAwarenessSceneObjects being managed by the observer, keyed by a unique id.
SourceId	The unique source id of this event source. (Inherited from IMixedRealityEventSource)
SourceName	The name of this event source. (Inherited from IMixedRealityEventSource)
StartupBehavior	Indicates the developer's intended startup behavior. (Inherited from IMixedRealitySpatialAwarenessObserver)
SurfaceTypes	Surface types to be observed by the observer.
UpdateInterval	Gets or sets the frequency, in seconds, at which the spatial observer should update. (Inherited from IMixedRealitySpatialAwarenessObserver)
UpdateOnceInitialized	Whether the observer updates once after initialization (regardless whether AutoUpdate is true). (Inherited from IMixedRealityOnDemandObserver)
UsePersistentObjects	When enabled, the service will preserve previously observed surfaces when updating.
WorldMeshLevelOfDetail	Configures the density of the mesh retrieved from the service

Methods

ClearObservations()	Clears the observer's collection of observations. (Inherited from IMixedRealitySpatialAwarenessObserver)
Destroy()	Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed. (Inherited from IMixedRealityService)
Disable()	Optional Disable function to pause the service. (Inherited from IMixedRealityService)
Enable()	Optional Enable function to enable / re-enable the service. (Inherited from IMixedRealityService)
Initialize()	The initialize function is used to setup the service once created. This method is called once all services have been registered in the Mixed Reality Toolkit. (Inherited from IMixedRealityService)
LateUpdate()	Optional LateUpdate function to that is called after Update has been called on all services. (Inherited from IMixedRealityService)
Reset()	Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change. (Inherited from IMixedRealityService)
Resume()	Start | resume the observer. (Inherited from IMixedRealitySpatialAwarenessObserver)
SaveScene(String)	Save a scene file to the device
Suspend()	Stop | pause the observer (Inherited from IMixedRealitySpatialAwarenessObserver)
TryFindCentermostPlacement(Int32, Vector2, Vector3)	Finds best placement position in local space to the quad
Update()	Optional Update function to perform per-frame updates of the service. (Inherited from IMixedRealityService)
UpdateOnDemand()	Tells the observer to update the observations. (Inherited from IMixedRealityOnDemandObserver)