IMixedRealitySpatialAwarenessObserver Interface

Definition

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

Properties

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.

IsRunning

Is the observer running (actively accumulating spatial data)?

IsStationaryObserver

Should the observer remain stationary in the scene?

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.

ObserverOrigin

Gets or sets the origin, in world space, of the observer.

ObserverRotation

Gets or sets the orientation of the volume in world space.

ObserverVolumeType

Gets or sets the type of volume the observer should operate in.

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.

UpdateInterval

Gets or sets the frequency, in seconds, at which the spatial observer should update.

Methods

ClearObservations()

Clears the observer's collection of observations.

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.

Suspend()

Stop | pause the observer

Update()

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

(Inherited from IMixedRealityService)

Applies to