LostTrackingService Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 ref class LostTrackingService : Microsoft::MixedReality::Toolkit::BaseExtensionService, IDisposable, Microsoft::MixedReality::Toolkit::Extensions::Tracking::ILostTrackingService
[Microsoft.MixedReality.Toolkit.MixedRealityExtensionService(Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Tracking Lost Service", "LostTrackingService/Profiles/DefaultLostTrackingServiceProfile.asset", "MixedRealityToolkit.Extensions", false)]
public class LostTrackingService : Microsoft.MixedReality.Toolkit.BaseExtensionService, IDisposable, Microsoft.MixedReality.Toolkit.Extensions.Tracking.ILostTrackingService
[<Microsoft.MixedReality.Toolkit.MixedRealityExtensionService(Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Tracking Lost Service", "LostTrackingService/Profiles/DefaultLostTrackingServiceProfile.asset", "MixedRealityToolkit.Extensions", false)>]
type LostTrackingService = class
inherit BaseExtensionService
interface ILostTrackingService
interface IMixedRealityExtensionService
interface IMixedRealityService
interface IDisposable
Public Class LostTrackingService
Inherits BaseExtensionService
Implements IDisposable, ILostTrackingService
- Inheritance
- Attributes
- Implements
Constructors
LostTrackingService(IMixedRealityServiceRegistrar, String, UInt32, BaseMixedRealityProfile) |
Obsolete.
Constructor. |
LostTrackingService(String, UInt32, BaseMixedRealityProfile) |
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) |
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) |
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 BaseService) |
Registrar |
Obsolete.
The service registrar instance that registered this service. (Inherited from BaseExtensionService) |
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 BaseService) |
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) |
EditorSetTrackingLost(Boolean) |
Editor-only method to test lost tracking visual. |
Enable() |
Optional Enable function to enable / re-enable the service. (Inherited from BaseService) |
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) |
Reset() |
Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change. (Inherited from BaseService) |
Update() |
Optional Update function to perform per-frame updates of the service. (Inherited from BaseService) |