IMixedRealitySpatialAwarenessSystem Interface

  • Reference

Definition

Namespace:
Microsoft.MixedReality.Toolkit.SpatialAwareness
Assembly:
Microsoft.MixedReality.Toolkit.dll
public interface class IMixedRealitySpatialAwarenessSystem : IDisposable, Microsoft::MixedReality::Toolkit::IMixedRealityEventSystem
public interface IMixedRealitySpatialAwarenessSystem : IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityEventSystem
type IMixedRealitySpatialAwarenessSystem = interface
    interface IMixedRealityEventSystem
    interface IMixedRealityService
    interface IDisposable
Public Interface IMixedRealitySpatialAwarenessSystem
Implements IDisposable, IMixedRealityEventSystem
Derived
Implements
IMixedRealityEventSystem IMixedRealityService IDisposable

Properties

ConfigurationProfile

The configuration profile for the service.

(Inherited from IMixedRealityService)
EventListeners

List of event listeners that are registered to this Event System.

(Inherited from IMixedRealityEventSystem)
Name

Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action.

(Inherited from IMixedRealityService)
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)
SpatialAwarenessObjectParent

Gets the parent object to which all spatial awareness GameObjects are to be parented.
SpatialAwarenessSystemProfile

Typed representation of the ConfigurationProfile property.

Methods

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.

(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)
GenerateNewSourceId()

Generates a new source identifier for an IMixedRealitySpatialAwarenessObserver implementation.
GetObserver(String)
Obsolete.

Get the IMixedRealitySpatialAwarenessObserver that is registered under the specified name.
GetObserver<T>(String)
Obsolete.

Get the observer that is registered under the specified name matching the specified type.
GetObservers()
Obsolete.

Gets the collection of registered IMixedRealitySpatialAwarenessObserver data providers.
GetObservers<T>()
Obsolete.

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 IMixedRealityEventSystem)
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)
Register(GameObject)
Obsolete.

Registers a GameObject to listen for events from this Event System.

(Inherited from IMixedRealityEventSystem)
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 IMixedRealityEventSystem)
Reset()

Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change.

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

Unregisters a GameObject from listening for events from this Event System.

(Inherited from IMixedRealityEventSystem)
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 IMixedRealityEventSystem)
Update()

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

(Inherited from IMixedRealityService)

Applies to