ILostTrackingService Interface

Definition

Namespace:

Microsoft.MixedReality.Toolkit.Extensions.Tracking

Assembly:

Microsoft.MixedReality.Toolkit.Extensions.Tracking.dll

A service that detects when tracking is lost on WSA devices. When tracking is lost, the service displays a visual indicator and sets the main camera's culling mask to hide all other objects. When tracking is restored, the camera mask is restored and the visual indicator is hidden.

public interface class ILostTrackingService : IDisposable, Microsoft::MixedReality::Toolkit::IMixedRealityExtensionService

public interface ILostTrackingService : IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityExtensionService

type ILostTrackingService = interface
    interface IMixedRealityExtensionService
    interface IMixedRealityService
    interface IDisposable

Public Interface ILostTrackingService
Implements IDisposable, IMixedRealityExtensionService

Derived

Microsoft.MixedReality.Toolkit.Extensions.Tracking.LostTrackingService

Implements

IMixedRealityExtensionService IMixedRealityService IDisposable

Properties

ConfigurationProfile	The configuration profile for the service. (Inherited from IMixedRealityService)
Name	Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action. (Inherited from IMixedRealityService)
OnTrackingLost	Called when tracking is lost. (When UnityEngine.VR.WSA.PositionalLocatorState is Inhibited.)
OnTrackingRestored	Called when tracking is stored (UnityEngine.VR.WSA.PositionalLocatorState is anything other than Inhibited.)
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)
TrackingLost	True if tracking is lost, false if tracking is present.

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)
EditorSetTrackingLost(Boolean)	Editor-only method to test lost tracking visual.
Enable()	Optional Enable function to enable / re-enable the service. (Inherited from IMixedRealityService)
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)
Reset()	Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change. (Inherited from IMixedRealityService)
Update()	Optional Update function to perform per-frame updates of the service. (Inherited from IMixedRealityService)