MixedRealityTeleportSystem Class

Definition

The Mixed Reality Toolkit's implementation of the IMixedRealityTeleportSystem.

public ref class MixedRealityTeleportSystem : Microsoft::MixedReality::Toolkit::BaseCoreSystem, IDisposable, Microsoft::MixedReality::Toolkit::Teleport::IMixedRealityTeleportSystem
public class MixedRealityTeleportSystem : Microsoft.MixedReality.Toolkit.BaseCoreSystem, IDisposable, Microsoft.MixedReality.Toolkit.Teleport.IMixedRealityTeleportSystem
type MixedRealityTeleportSystem = class
    inherit BaseCoreSystem
    interface IMixedRealityTeleportSystem
    interface IMixedRealityEventSystem
    interface IMixedRealityService
    interface IDisposable
Public Class MixedRealityTeleportSystem
Inherits BaseCoreSystem
Implements IDisposable, IMixedRealityTeleportSystem
Inheritance
MixedRealityTeleportSystem
Implements

Constructors

MixedRealityTeleportSystem()

Constructor.

MixedRealityTeleportSystem(IMixedRealityServiceRegistrar)
Obsolete.

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)
TeleportDuration

The duration of the teleport in seconds.

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)

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.

LateUpdate()

Optional LateUpdate function to that is called after Update has been called on all services.

(Inherited from BaseService)
RaiseTeleportCanceled(IMixedRealityPointer, IMixedRealityTeleportHotspot)

Raise a teleportation canceled event.

RaiseTeleportCanceled(IMixedRealityPointer, IMixedRealityTeleportHotSpot)

Raise a teleportation canceled event.

RaiseTeleportRequest(IMixedRealityPointer, IMixedRealityTeleportHotspot)

Raise a teleportation request event.

RaiseTeleportRequest(IMixedRealityPointer, IMixedRealityTeleportHotSpot)

Raise a teleportation request event.

RaiseTeleportStarted(IMixedRealityPointer, IMixedRealityTeleportHotspot)

Raise a teleportation started event.

RaiseTeleportStarted(IMixedRealityPointer, IMixedRealityTeleportHotSpot)

Raise a teleportation started event.

Register(GameObject)

Register a GameObject to listen to teleport events.

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.

(Inherited from BaseService)
Unregister(GameObject)

Unregister a GameObject from listening to teleport events.

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

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

(Inherited from BaseService)

Applies to