IMixedRealityEventSystem Interface

Definition

Interface used to implement an Event System that is compatible with the Mixed Reality Toolkit.

public interface class IMixedRealityEventSystem : IDisposable, Microsoft::MixedReality::Toolkit::IMixedRealityService
public interface IMixedRealityEventSystem : IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityService
type IMixedRealityEventSystem = interface
    interface IMixedRealityService
    interface IDisposable
Public Interface IMixedRealityEventSystem
Implements IDisposable, IMixedRealityService
Derived
Implements

Properties

ConfigurationProfile

The configuration profile for the service.

(Inherited from IMixedRealityService)
EventListeners

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

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)

Methods

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)
HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction)

The main function for handling and forwarding all events to their intended recipients.

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.

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.

Reset()

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

(Inherited from IMixedRealityService)
Unregister(GameObject)
Obsolete.

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

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.

Update()

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

(Inherited from IMixedRealityService)

Applies to