Class MixedRealitySpatialAwarenessSystem

Class providing the default implementation of the IMixedRealitySpatialAwarenessSystem interface.

Inheritance
Object
BaseService
BaseEventSystem
BaseCoreSystem
BaseDataProviderAccessCoreSystem
MixedRealitySpatialAwarenessSystem
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.SpatialAwareness
Assembly: cs.temp.dll.dll
Syntax
public class MixedRealitySpatialAwarenessSystem : BaseDataProviderAccessCoreSystem, IMixedRealityDataProviderAccess, IMixedRealitySpatialAwarenessSystem, IMixedRealityEventSystem, IMixedRealityService, IDisposable, IMixedRealityCapabilityCheck

Constructors

MixedRealitySpatialAwarenessSystem(IMixedRealityServiceRegistrar, MixedRealitySpatialAwarenessSystemProfile)

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.")]
public MixedRealitySpatialAwarenessSystem(IMixedRealityServiceRegistrar registrar, MixedRealitySpatialAwarenessSystemProfile profile)
Parameters
Type Name Description
IMixedRealityServiceRegistrar registrar

The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealitySpatialAwarenessSystemProfile profile

The configuration profile for the service.

MixedRealitySpatialAwarenessSystem(IMixedRealityServiceRegistrar, MixedRealitySpatialAwarenessSystemProfile)

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.")]
public MixedRealitySpatialAwarenessSystem(IMixedRealityServiceRegistrar registrar, MixedRealitySpatialAwarenessSystemProfile profile)
Parameters
Type Name Description
IMixedRealityServiceRegistrar registrar

The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealitySpatialAwarenessSystemProfile profile

The configuration profile for the service.

MixedRealitySpatialAwarenessSystem(MixedRealitySpatialAwarenessSystemProfile)

Constructor.

Declaration
public MixedRealitySpatialAwarenessSystem(MixedRealitySpatialAwarenessSystemProfile profile)
Parameters
Type Name Description
MixedRealitySpatialAwarenessSystemProfile profile

The configuration profile for the service.

MixedRealitySpatialAwarenessSystem(MixedRealitySpatialAwarenessSystemProfile)

Constructor.

Declaration
public MixedRealitySpatialAwarenessSystem(MixedRealitySpatialAwarenessSystemProfile profile)
Parameters
Type Name Description
MixedRealitySpatialAwarenessSystemProfile profile

The configuration profile for the service.

Properties

Name

Declaration
public override string Name { get; protected set; }
Property Value
Type Description
String
Overrides

Name

Declaration
public override string Name { get; protected set; }
Property Value
Type Description
String
Overrides

SpatialAwarenessObjectParent

Declaration
public GameObject SpatialAwarenessObjectParent { get; }
Property Value
Type Description
GameObject

SpatialAwarenessObjectParent

Declaration
public GameObject SpatialAwarenessObjectParent { get; }
Property Value
Type Description
GameObject

SpatialAwarenessSystemProfile

Declaration
public MixedRealitySpatialAwarenessSystemProfile SpatialAwarenessSystemProfile { get; }
Property Value
Type Description
MixedRealitySpatialAwarenessSystemProfile

SpatialAwarenessSystemProfile

Declaration
public MixedRealitySpatialAwarenessSystemProfile SpatialAwarenessSystemProfile { get; }
Property Value
Type Description
MixedRealitySpatialAwarenessSystemProfile

Methods

CheckCapability(MixedRealityCapability)

Declaration
public bool CheckCapability(MixedRealityCapability capability)
Parameters
Type Name Description
MixedRealityCapability capability
Returns
Type Description
Boolean

CheckCapability(MixedRealityCapability)

Declaration
public bool CheckCapability(MixedRealityCapability capability)
Parameters
Type Name Description
MixedRealityCapability capability
Returns
Type Description
Boolean

ClearObservations()

Declaration
public void ClearObservations()

ClearObservations()

Declaration
public void ClearObservations()

ClearObservations<T>(String)

Declaration
public void ClearObservations<T>(string name)

    where T : IMixedRealitySpatialAwarenessObserver
Parameters
Type Name Description
String name
Type Parameters
Name Description
T

ClearObservations<T>(String)

Declaration
public void ClearObservations<T>(string name)

    where T : IMixedRealitySpatialAwarenessObserver
Parameters
Type Name Description
String name
Type Parameters
Name Description
T

CreateSpatialAwarenessObservationParent(String)

Declaration
public GameObject CreateSpatialAwarenessObservationParent(string name)
Parameters
Type Name Description
String name
Returns
Type Description
GameObject

CreateSpatialAwarenessObservationParent(String)

Declaration
public GameObject CreateSpatialAwarenessObservationParent(string name)
Parameters
Type Name Description
String name
Returns
Type Description
GameObject

Destroy()

Declaration
public override void Destroy()
Overrides

Destroy()

Declaration
public override void Destroy()
Overrides

Disable()

Declaration
public override void Disable()
Overrides

Disable()

Declaration
public override void Disable()
Overrides

Enable()

Declaration
public override void Enable()
Overrides

Enable()

Declaration
public override void Enable()
Overrides

GenerateNewSourceId()

Declaration
public uint GenerateNewSourceId()
Returns
Type Description
UInt32

GenerateNewSourceId()

Declaration
public uint GenerateNewSourceId()
Returns
Type Description
UInt32

GetDataProvider<T>(String)

Declaration
public override T GetDataProvider<T>(string name = null)

    where T : IMixedRealityDataProvider
Parameters
Type Name Description
String name
Returns
Type Description
T
Type Parameters
Name Description
T
Overrides

GetDataProvider<T>(String)

Declaration
public override T GetDataProvider<T>(string name = null)

    where T : IMixedRealityDataProvider
Parameters
Type Name Description
String name
Returns
Type Description
T
Type Parameters
Name Description
T
Overrides

GetDataProviders<T>()

Declaration
public override IReadOnlyList<T> GetDataProviders<T>()

    where T : IMixedRealityDataProvider
Returns
Type Description
IReadOnlyList<T>
Type Parameters
Name Description
T
Overrides

GetDataProviders<T>()

Declaration
public override IReadOnlyList<T> GetDataProviders<T>()

    where T : IMixedRealityDataProvider
Returns
Type Description
IReadOnlyList<T>
Type Parameters
Name Description
T
Overrides

GetObserver(String)

Declaration
public IMixedRealitySpatialAwarenessObserver GetObserver(string name)
Parameters
Type Name Description
String name
Returns
Type Description
IMixedRealitySpatialAwarenessObserver

GetObserver(String)

Declaration
public IMixedRealitySpatialAwarenessObserver GetObserver(string name)
Parameters
Type Name Description
String name
Returns
Type Description
IMixedRealitySpatialAwarenessObserver

GetObserver<T>(String)

Declaration
public T GetObserver<T>(string name = null)

    where T : IMixedRealitySpatialAwarenessObserver
Parameters
Type Name Description
String name
Returns
Type Description
T
Type Parameters
Name Description
T

GetObserver<T>(String)

Declaration
public T GetObserver<T>(string name = null)

    where T : IMixedRealitySpatialAwarenessObserver
Parameters
Type Name Description
String name
Returns
Type Description
T
Type Parameters
Name Description
T

GetObservers()

Declaration
public IReadOnlyList<IMixedRealitySpatialAwarenessObserver> GetObservers()
Returns
Type Description
IReadOnlyList<IMixedRealitySpatialAwarenessObserver>

GetObservers()

Declaration
public IReadOnlyList<IMixedRealitySpatialAwarenessObserver> GetObservers()
Returns
Type Description
IReadOnlyList<IMixedRealitySpatialAwarenessObserver>

GetObservers<T>()

Declaration
public IReadOnlyList<T> GetObservers<T>()

    where T : IMixedRealitySpatialAwarenessObserver
Returns
Type Description
IReadOnlyList<T>
Type Parameters
Name Description
T

GetObservers<T>()

Declaration
public IReadOnlyList<T> GetObservers<T>()

    where T : IMixedRealitySpatialAwarenessObserver
Returns
Type Description
IReadOnlyList<T>
Type Parameters
Name Description
T

Initialize()

Declaration
public override void Initialize()
Overrides

Initialize()

Declaration
public override void Initialize()
Overrides

Reset()

Declaration
public override void Reset()
Overrides

Reset()

Declaration
public override void Reset()
Overrides

ResumeObserver<T>(String)

Declaration
public void ResumeObserver<T>(string name)

    where T : IMixedRealitySpatialAwarenessObserver
Parameters
Type Name Description
String name
Type Parameters
Name Description
T

ResumeObserver<T>(String)

Declaration
public void ResumeObserver<T>(string name)

    where T : IMixedRealitySpatialAwarenessObserver
Parameters
Type Name Description
String name
Type Parameters
Name Description
T

ResumeObservers()

Declaration
public void ResumeObservers()

ResumeObservers()

Declaration
public void ResumeObservers()

ResumeObservers<T>()

Declaration
public void ResumeObservers<T>()

    where T : IMixedRealitySpatialAwarenessObserver
Type Parameters
Name Description
T

ResumeObservers<T>()

Declaration
public void ResumeObservers<T>()

    where T : IMixedRealitySpatialAwarenessObserver
Type Parameters
Name Description
T

SuspendObserver<T>(String)

Declaration
public void SuspendObserver<T>(string name)

    where T : IMixedRealitySpatialAwarenessObserver
Parameters
Type Name Description
String name
Type Parameters
Name Description
T

SuspendObserver<T>(String)

Declaration
public void SuspendObserver<T>(string name)

    where T : IMixedRealitySpatialAwarenessObserver
Parameters
Type Name Description
String name
Type Parameters
Name Description
T

SuspendObservers()

Declaration
public void SuspendObservers()

SuspendObservers()

Declaration
public void SuspendObservers()

SuspendObservers<T>()

Declaration
public void SuspendObservers<T>()

    where T : IMixedRealitySpatialAwarenessObserver
Type Parameters
Name Description
T

SuspendObservers<T>()

Declaration
public void SuspendObservers<T>()

    where T : IMixedRealitySpatialAwarenessObserver
Type Parameters
Name Description
T

Implements

IDisposable