public abstract class BaseSpatialObserver : BaseDataProvider<IMixedRealitySpatialAwarenessSystem>, IMixedRealitySpatialAwarenessObserver, IMixedRealityDataProvider, IMixedRealityService, IDisposable, IMixedRealityEventSource, IEqualityComparer

Constructors

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

Constructor.

Declaration

[Obsolete("This constructor is obsolete (registrar parameter is no longer required) and will be removed in a future version of the Microsoft Mixed Reality Toolkit.")]
protected BaseSpatialObserver(IMixedRealityServiceRegistrar registrar, IMixedRealitySpatialAwarenessSystem spatialAwarenessSystem, string name = null, uint priority = default(uint), BaseMixedRealityProfile profile = null)

Parameters

Type	Name	Description
IMixedRealityServiceRegistrar	registrar	The IMixedRealityServiceRegistrar instance that loaded the observer.
IMixedRealitySpatialAwarenessSystem	spatialAwarenessSystem	The IMixedRealitySpatialAwarenessSystem to which the observer is providing data.
String	name	The friendly name of the data provider.
UInt32	priority	The registration priority of the data provider.
BaseMixedRealityProfile	profile	The configuration profile for the data provider.

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

Constructor.

Declaration

[Obsolete("This constructor is obsolete (registrar parameter is no longer required) and will be removed in a future version of the Microsoft Mixed Reality Toolkit.")]
protected BaseSpatialObserver(IMixedRealityServiceRegistrar registrar, IMixedRealitySpatialAwarenessSystem spatialAwarenessSystem, string name = null, uint priority = default(uint), BaseMixedRealityProfile profile = null)

Parameters

Type	Name	Description
IMixedRealityServiceRegistrar	registrar	The IMixedRealityServiceRegistrar instance that loaded the observer.
IMixedRealitySpatialAwarenessSystem	spatialAwarenessSystem	The IMixedRealitySpatialAwarenessSystem to which the observer is providing data.
String	name	The friendly name of the data provider.
UInt32	priority	The registration priority of the data provider.
BaseMixedRealityProfile	profile	The configuration profile for the data provider.

BaseSpatialObserver(IMixedRealitySpatialAwarenessSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration

protected BaseSpatialObserver(IMixedRealitySpatialAwarenessSystem spatialAwarenessSystem, string name = null, uint priority = default(uint), BaseMixedRealityProfile profile = null)

Parameters

Type	Name	Description
IMixedRealitySpatialAwarenessSystem	spatialAwarenessSystem	The IMixedRealitySpatialAwarenessSystem to which the observer is providing data.
String	name	The friendly name of the data provider.
UInt32	priority	The registration priority of the data provider.
BaseMixedRealityProfile	profile	The configuration profile for the data provider.

BaseSpatialObserver(IMixedRealitySpatialAwarenessSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration

protected BaseSpatialObserver(IMixedRealitySpatialAwarenessSystem spatialAwarenessSystem, string name = null, uint priority = default(uint), BaseMixedRealityProfile profile = null)

Parameters

Type	Name	Description
IMixedRealitySpatialAwarenessSystem	spatialAwarenessSystem	The IMixedRealitySpatialAwarenessSystem to which the observer is providing data.
String	name	The friendly name of the data provider.
UInt32	priority	The registration priority of the data provider.
BaseMixedRealityProfile	profile	The configuration profile for the data provider.

Fields

DefaultSpatialAwarenessLayer

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

Declaration

public const int DefaultSpatialAwarenessLayer = 31

Field Value

Type	Description
Int32

Properties

DefaultPhysicsLayer

Declaration

public int DefaultPhysicsLayer { get; }

Property Value

Type	Description
Int32

DefaultPhysicsLayer

Declaration

public int DefaultPhysicsLayer { get; }

Property Value

Type	Description
Int32

IsRunning

Declaration

public bool IsRunning { get; protected set; }

Property Value

Type	Description
Boolean

IsRunning

Declaration

public bool IsRunning { get; protected set; }

Property Value

Type	Description
Boolean

IsStationaryObserver

Declaration

public bool IsStationaryObserver { get; set; }

Property Value

Type	Description
Boolean

IsStationaryObserver

Declaration

public bool IsStationaryObserver { get; set; }

Property Value

Type	Description
Boolean

ObservationExtents

Declaration

public Vector3 ObservationExtents { get; set; }

Property Value

Type	Description
Vector3

ObservationExtents

Declaration

public Vector3 ObservationExtents { get; set; }

Property Value

Type	Description
Vector3

ObserverOrigin

Declaration

public Vector3 ObserverOrigin { get; set; }

Property Value

Type	Description
Vector3

ObserverOrigin

Declaration

public Vector3 ObserverOrigin { get; set; }

Property Value

Type	Description
Vector3

ObserverRotation

Declaration

public Quaternion ObserverRotation { get; set; }

Property Value

Type	Description
Quaternion

ObserverRotation

Declaration

public Quaternion ObserverRotation { get; set; }

Property Value

Type	Description
Quaternion

ObserverVolumeType

Declaration

public VolumeType ObserverVolumeType { get; set; }

Property Value

Type	Description
VolumeType

ObserverVolumeType

Declaration

public VolumeType ObserverVolumeType { get; set; }

Property Value

Type	Description
VolumeType

SourceId

Declaration

public uint SourceId { get; }

Property Value

Type	Description
UInt32

SourceId

Declaration

public uint SourceId { get; }

Property Value

Type	Description
UInt32

SourceName

Declaration

public string SourceName { get; }

Property Value

Type	Description
String

SourceName

Declaration

public string SourceName { get; }

Property Value

Type	Description
String

SpatialAwarenessSystem

The spatial awareness system that is associated with this observer.

Declaration

protected IMixedRealitySpatialAwarenessSystem SpatialAwarenessSystem { get; }

Property Value

Type	Description
IMixedRealitySpatialAwarenessSystem

SpatialAwarenessSystem

The spatial awareness system that is associated with this observer.

Declaration

protected IMixedRealitySpatialAwarenessSystem SpatialAwarenessSystem { get; }

Property Value

Type	Description
IMixedRealitySpatialAwarenessSystem

StartupBehavior

Declaration

public AutoStartBehavior StartupBehavior { get; set; }

Property Value

Type	Description
AutoStartBehavior

StartupBehavior

Declaration

public AutoStartBehavior StartupBehavior { get; set; }

Property Value

Type	Description
AutoStartBehavior

UpdateInterval

Declaration

public float UpdateInterval { get; set; }

Property Value

Type	Description
Single

UpdateInterval

Declaration

public float UpdateInterval { get; set; }

Property Value

Type	Description
Single

Methods

CleanupObserver()

Ensures that the spatial observer has been stopped and destroyed.

Declaration

protected virtual void CleanupObserver()

ClearObservations()

Declaration

public virtual void ClearObservations()

ClearObservations()

Declaration

public virtual void ClearObservations()

CreateObserver()

Creates the spatial observer and handles the desired startup behavior.

Declaration

protected virtual void CreateObserver()

Destroy()

Declaration

public override void Destroy()

Overrides

BaseService.Destroy()

Disable()

Declaration

public override void Disable()

Overrides

BaseService.Disable()

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
Boolean	disposing

Overrides

BaseService.Dispose(Boolean)

Enable()

Declaration

public override void Enable()

Overrides

BaseService.Enable()

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

Object.Equals(Object)

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

Object.Equals(Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

GetHashCode(Object)

Declaration

public int GetHashCode(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Int32

GetHashCode(Object)

Declaration

public int GetHashCode(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Int32

Initialize()

Creates the observer.

Declaration

public override void Initialize()

Overrides

BaseService.Initialize()

Reset()

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

Declaration

public override void Reset()

Overrides

BaseService.Reset()

Resume()

Declaration

public virtual void Resume()

Resume()

Declaration

public virtual void Resume()

Suspend()

Declaration

public virtual void Suspend()

Suspend()

Declaration

public virtual void Suspend()

Implements

IMixedRealitySpatialAwarenessObserver

IMixedRealityDataProvider

IMixedRealityService

IDisposable

IMixedRealityEventSource

IEqualityComparer