BaseEventSystem Class

Definition

Namespace:

Microsoft.MixedReality.Toolkit

Assembly:

Microsoft.MixedReality.Toolkit.dll

Base Event System that can be inherited from to give other system features event capabilities.

public ref class BaseEventSystem abstract : Microsoft::MixedReality::Toolkit::BaseService, IDisposable, Microsoft::MixedReality::Toolkit::IMixedRealityEventSystem

public abstract class BaseEventSystem : Microsoft.MixedReality.Toolkit.BaseService, IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityEventSystem

type BaseEventSystem = class
    inherit BaseService
    interface IMixedRealityEventSystem
    interface IMixedRealityService
    interface IDisposable

Public MustInherit Class BaseEventSystem
Inherits BaseService
Implements IDisposable, IMixedRealityEventSystem

Inheritance

Object

BaseService

BaseEventSystem

Derived

Microsoft.MixedReality.Toolkit.BaseCoreSystem

Implements

IMixedRealityEventSystem IMixedRealityService IDisposable

Constructors

BaseEventSystem()

Fields

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

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.
EventListeners	List of event listeners that are registered to this Event System.
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. (Inherited from BaseService)
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)

Methods

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. (Inherited from BaseService)
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. (Inherited from BaseService)
HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)	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 BaseService)
LateUpdate()	Optional LateUpdate function to that is called after Update has been called on all services. (Inherited from BaseService)
Register(GameObject)	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 BaseService)
Unregister(GameObject)	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 BaseService)