BaseSpatialObserver Class

Definition

Class providing a base implementation of the IMixedRealitySpatialAwarenessObserver interface.

public ref class BaseSpatialObserver abstract : Microsoft::MixedReality::Toolkit::BaseDataProvider<Microsoft::MixedReality::Toolkit::SpatialAwareness::IMixedRealitySpatialAwarenessSystem ^>, IDisposable, Microsoft::MixedReality::Toolkit::SpatialAwareness::IMixedRealitySpatialAwarenessObserver, System::Collections::IEqualityComparer
public abstract class BaseSpatialObserver : Microsoft.MixedReality.Toolkit.BaseDataProvider<Microsoft.MixedReality.Toolkit.SpatialAwareness.IMixedRealitySpatialAwarenessSystem>, IDisposable, Microsoft.MixedReality.Toolkit.SpatialAwareness.IMixedRealitySpatialAwarenessObserver, System.Collections.IEqualityComparer
type BaseSpatialObserver = class
    inherit BaseDataProvider<IMixedRealitySpatialAwarenessSystem>
    interface IMixedRealitySpatialAwarenessObserver
    interface IMixedRealityDataProvider
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityEventSource
    interface IEqualityComparer
Public MustInherit Class BaseSpatialObserver
Inherits BaseDataProvider(Of IMixedRealitySpatialAwarenessSystem)
Implements IDisposable, IEqualityComparer, IMixedRealitySpatialAwarenessObserver
Inheritance
Derived
Implements

Constructors

BaseSpatialObserver(IMixedRealityServiceRegistrar, IMixedRealitySpatialAwarenessSystem, String, UInt32, BaseMixedRealityProfile)
Obsolete.

Constructor.

BaseSpatialObserver(IMixedRealitySpatialAwarenessSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

Fields

DefaultPriority (Inherited from BaseService)
DefaultSpatialAwarenessLayer

Default dedicated layer for spatial awareness layer used by most components in MRTK

disposed

Value indicating if the object has completed disposal.

(Inherited from BaseService)

Properties

ConfigurationProfile

The configuration profile for the service.

(Inherited from BaseService)
DefaultPhysicsLayer

Get or sets the default Unity Physics Layer on which to set the spatial object.

IsEnabled

Indicates whether or not the service is currently enabled.

(Inherited from BaseService)
IsInitialized

Indicates whether or not the service has been initialized.

(Inherited from BaseService)
IsMarkedDestroyed

Indicates whether or not the Destroy method been called on this service.

(Inherited from BaseService)
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 BaseService)
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 BaseService)
Registrar
Obsolete.

The service registrar instance that registered this service.

(Inherited from BaseDataProvider<T>)
Service

The service instance to which this provider is providing data.

(Inherited from BaseDataProvider<T>)
SourceId

The unique source id of this event source.

SourceName

The name of this event source.

SpatialAwarenessSystem
Obsolete.

The spatial awareness system that is associated with this observer.

StartupBehavior

Indicates the developer's intended startup behavior.

UpdateInterval

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

Methods

CleanupObserver()

Ensures that the spatial observer has been stopped and destroyed.

ClearObservations()

Clears the observer's collection of observations.

CreateObserver()

Creates the spatial observer and handles the desired startup behavior.

Destroy()

Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed.

Disable()

Optional Disable function to pause the service.

Dispose()

Cleanup resources used by this object.

(Inherited from BaseService)
Dispose(Boolean)

Cleanup resources used by the object

Enable()

Optional Enable function to enable / re-enable the service.

Equals(Object)
GetHashCode()

Serves as the default hash function.

GetHashCode(Object)

Returns a hash code for the specified object.

Initialize()

Creates the observer.

LateUpdate()

Optional LateUpdate function to that is called after Update has been called on all services.

(Inherited from BaseService)
Reset()

Suspends the observer, clears observations, cleans up the observer, then re-initializes.

Resume()

Start | resume the observer.

Suspend()

Stop | pause the observer

Update()

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

(Inherited from BaseService)

Explicit Interface Implementations

IEqualityComparer.Equals(Object, Object)

Determines whether the specified objects are equal.

Applies to