MixedRealitySpatialAwarenessSystem Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.SpatialAwareness

Assembly:: Microsoft.MixedReality.Toolkit.Services.SpatialAwarenessSystem.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Class providing the default implementation of the IMixedRealitySpatialAwarenessSystem interface.

public ref class MixedRealitySpatialAwarenessSystem : Microsoft::MixedReality::Toolkit::BaseDataProviderAccessCoreSystem, IDisposable, Microsoft::MixedReality::Toolkit::IMixedRealityCapabilityCheck, Microsoft::MixedReality::Toolkit::SpatialAwareness::IMixedRealitySpatialAwarenessSystem

[UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/spatial-awareness/spatial-awareness-getting-started")]
public class MixedRealitySpatialAwarenessSystem : Microsoft.MixedReality.Toolkit.BaseDataProviderAccessCoreSystem, IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityCapabilityCheck, Microsoft.MixedReality.Toolkit.SpatialAwareness.IMixedRealitySpatialAwarenessSystem

[<UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/spatial-awareness/spatial-awareness-getting-started")>]
type MixedRealitySpatialAwarenessSystem = class
    inherit BaseDataProviderAccessCoreSystem
    interface IMixedRealitySpatialAwarenessSystem
    interface IMixedRealityEventSystem
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityCapabilityCheck

Public Class MixedRealitySpatialAwarenessSystem
Inherits BaseDataProviderAccessCoreSystem
Implements IDisposable, IMixedRealityCapabilityCheck, IMixedRealitySpatialAwarenessSystem

Inheritance: Object

BaseService

BaseEventSystem

BaseCoreSystem

BaseDataProviderAccessCoreSystem
MixedRealitySpatialAwarenessSystem

Attributes: UnityEngine.HelpURLAttribute

Implements: IMixedRealityCapabilityCheck IMixedRealityEventSystem IMixedRealityService IMixedRealitySpatialAwarenessSystem IDisposable

Constructors

MixedRealitySpatialAwarenessSystem(IMixedRealityServiceRegistrar, MixedRealitySpatialAwarenessSystemProfile)	Obsolete. Constructor.
MixedRealitySpatialAwarenessSystem(MixedRealitySpatialAwarenessSystemProfile)	Constructor.

Fields

DefaultPriority	(Inherited from BaseService)
disposed	Value indicating if the object has completed disposal. (Inherited from BaseService)

Properties

ConfigurationProfile	The configuration profile for the service. (Inherited from BaseService)
EventHandlersByType	List of all event handlers grouped by type that are registered to this Event System. (Inherited from BaseEventSystem)
EventListeners	List of event listeners that are registered to this Event System. (Inherited from BaseEventSystem)
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)
Name	Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action.
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 BaseCoreSystem)
SpatialAwarenessObjectParent	Gets the parent object to which all spatial awareness GameObjects are to be parented.
SpatialAwarenessSystemProfile	Typed representation of the ConfigurationProfile property.

Methods

CheckCapability(MixedRealityCapability)	Checks to see if one or more registered data providers supports the requested capability on the current platform.
ClearObservations()	Clears all registered observers' observations.
ClearObservations<T>(String)	Clears the observations of the specified observer.
CreateSpatialAwarenessObservationParent(String)	Creates the a parent, that is a child of the Spatial Awareness System parent so that the scene hierarchy does not get overly cluttered.
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 (Inherited from BaseService)
Enable()	Optional Enable function to enable / re-enable the service.
GenerateNewSourceId()	Generates a new source identifier for an IMixedRealitySpatialAwarenessObserver implementation.
GetDataProvider(String)	Get the data provider that is registered under the specified name. (Inherited from BaseDataProviderAccessCoreSystem)
GetDataProvider<T>(String)	Get the data provider that is registered under the specified name (optional) and matching the specified type.
GetDataProviders()	Gets the collection of registered data providers. (Inherited from BaseDataProviderAccessCoreSystem)
GetDataProviders<T>()	Get the collection of registered observers of the specified type.
GetObserver(String)	Get the IMixedRealitySpatialAwarenessObserver that is registered under the specified name.
GetObserver<T>(String)	Get the observer that is registered under the specified name matching the specified type.
GetObservers()	Gets the collection of registered IMixedRealitySpatialAwarenessObserver data providers.
GetObservers<T>()	Get the collection of registered observers of the specified type.
HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)	The main function for handling and forwarding all events to their intended recipients. (Inherited from BaseEventSystem)
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.
LateUpdate()	(Inherited from BaseDataProviderAccessCoreSystem)
Register(GameObject)	Registers a GameObject to listen for events from this Event System. (Inherited from BaseEventSystem)
RegisterDataProvider<T>(T)	Registers a service of the specified type. (Inherited from BaseDataProviderAccessCoreSystem)
RegisterDataProvider<T>(Type, String, SupportedPlatforms, Object[])	Registers a data provider of the specified type. (Inherited from BaseDataProviderAccessCoreSystem)
RegisterDataProvider<T>(Type, SupportedPlatforms, Object[])	Obsolete. Registers a data provider of the specified type. (Inherited from BaseDataProviderAccessCoreSystem)
RegisterHandler<T>(IEventSystemHandler)	Registers the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler. (Inherited from BaseEventSystem)
Reset()	Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change.
ResumeObserver<T>(String)	Starts / restarts the spatial observer registered under the specified name matching the specified type.
ResumeObservers()	Starts / restarts all spatial observers of the specified type.
ResumeObservers<T>()	Starts / restarts all spatial observers of the specified type.
SuspendObserver<T>(String)	Stops / pauses the spatial observer registered under the specified name matching the specified type.
SuspendObservers()	Stops / pauses all spatial observers.
SuspendObservers<T>()	Stops / pauses all spatial observers of the specified type.
Unregister(GameObject)	Unregisters a GameObject from listening for events from this Event System. (Inherited from BaseEventSystem)
UnregisterDataProvider<T>(String)	Unregisters a data provider of the specified type. (Inherited from BaseDataProviderAccessCoreSystem)
UnregisterDataProvider<T>(T)	Unregisters a data provider. (Inherited from BaseDataProviderAccessCoreSystem)
UnregisterHandler<T>(IEventSystemHandler)	Unregisters the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler. (Inherited from BaseEventSystem)
Update()	(Inherited from BaseDataProviderAccessCoreSystem)

Applies to