Edit

Share via


IMixedRealityOnDemandObserver Interface

Definition

The interface for defining an on-demand spatial observer which enables on demand updating

public interface class IMixedRealityOnDemandObserver : IDisposable, Microsoft::MixedReality::Toolkit::SpatialAwareness::IMixedRealitySpatialAwarenessObserver, System::Collections::IEqualityComparer
public interface IMixedRealityOnDemandObserver : IDisposable, Microsoft.MixedReality.Toolkit.SpatialAwareness.IMixedRealitySpatialAwarenessObserver, System.Collections.IEqualityComparer
type IMixedRealityOnDemandObserver = interface
    interface IMixedRealitySpatialAwarenessObserver
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityEventSource
    interface IEqualityComparer
Public Interface IMixedRealityOnDemandObserver
Implements IDisposable, IEqualityComparer, IMixedRealitySpatialAwarenessObserver
Derived
Implements

Properties

AutoUpdate

Whether the observer updates its observations automatically on interval.

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

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)
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)
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).

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)
Suspend()

Stop | pause the observer

(Inherited from IMixedRealitySpatialAwarenessObserver)
Update()

Optional Update function to perform per-frame updates of the service.

(Inherited from IMixedRealityService)
UpdateOnDemand()

Tells the observer to update the observations.

Applies to