Class MixedRealityToolkit

This class is responsible for coordinating the operation of the Mixed Reality Toolkit. It is the only Singleton in the entire project. It provides a service registry for all active services that are used within a project as well as providing the active configuration profile for the project. The Profile can be swapped out at any time to meet the needs of your project.

Inheritance
Object
MixedRealityToolkit
Implements
MonoBehaviour
Namespace: Microsoft.MixedReality.Toolkit
Assembly: cs.temp.dll.dll
Syntax
public class MixedRealityToolkit : MonoBehaviour, IMixedRealityServiceRegistrar, MonoBehaviour

Properties

ActiveProfile

The public property of the Active Profile, ensuring events are raised on the change of the configuration

Declaration
public MixedRealityToolkitConfigurationProfile ActiveProfile { get; set; }
Property Value
Type Description
MixedRealityToolkitConfigurationProfile

ActiveProfile

The public property of the Active Profile, ensuring events are raised on the change of the configuration

Declaration
public MixedRealityToolkitConfigurationProfile ActiveProfile { get; set; }
Property Value
Type Description
MixedRealityToolkitConfigurationProfile

ActiveSystems

Current active systems registered with the MixedRealityToolkit.

Declaration
public IReadOnlyDictionary<Type, IMixedRealityService> ActiveSystems { get; }
Property Value
Type Description
IReadOnlyDictionary<Type, IMixedRealityService>
Remarks

Systems can only be registered once by Type

ActiveSystems

Current active systems registered with the MixedRealityToolkit.

Declaration
public IReadOnlyDictionary<Type, IMixedRealityService> ActiveSystems { get; }
Property Value
Type Description
IReadOnlyDictionary<Type, IMixedRealityService>
Remarks

Systems can only be registered once by Type

BoundarySystem

The current Boundary System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealityBoundarySystem BoundarySystem { get; }
Property Value
Type Description
IMixedRealityBoundarySystem

BoundarySystem

The current Boundary System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealityBoundarySystem BoundarySystem { get; }
Property Value
Type Description
IMixedRealityBoundarySystem

CameraSystem

The current Camera System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealityCameraSystem CameraSystem { get; }
Property Value
Type Description
IMixedRealityCameraSystem

CameraSystem

The current Camera System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealityCameraSystem CameraSystem { get; }
Property Value
Type Description
IMixedRealityCameraSystem

DiagnosticsSystem

The current Diagnostics System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealityDiagnosticsSystem DiagnosticsSystem { get; }
Property Value
Type Description
IMixedRealityDiagnosticsSystem

DiagnosticsSystem

The current Diagnostics System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealityDiagnosticsSystem DiagnosticsSystem { get; }
Property Value
Type Description
IMixedRealityDiagnosticsSystem

HasActiveProfile

Checks if there is a valid instance of the MixedRealityToolkit, then checks if there is there a valid Active Profile.

Declaration
public bool HasActiveProfile { get; }
Property Value
Type Description
Boolean

HasActiveProfile

Checks if there is a valid instance of the MixedRealityToolkit, then checks if there is there a valid Active Profile.

Declaration
public bool HasActiveProfile { get; }
Property Value
Type Description
Boolean

InputSystem

The current Input System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealityInputSystem InputSystem { get; }
Property Value
Type Description
IMixedRealityInputSystem

InputSystem

The current Input System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealityInputSystem InputSystem { get; }
Property Value
Type Description
IMixedRealityInputSystem

Instance

Returns the Singleton instance of the classes type.

Declaration
public static MixedRealityToolkit Instance { get; }
Property Value
Type Description
MixedRealityToolkit

Instance

Returns the Singleton instance of the classes type.

Declaration
public static MixedRealityToolkit Instance { get; }
Property Value
Type Description
MixedRealityToolkit

IsActiveInstance

Returns true if this is the active instance.

Declaration
public bool IsActiveInstance { get; }
Property Value
Type Description
Boolean

IsActiveInstance

Returns true if this is the active instance.

Declaration
public bool IsActiveInstance { get; }
Property Value
Type Description
Boolean

IsInitialized

Returns whether the instance has been initialized or not.

Declaration
public static bool IsInitialized { get; }
Property Value
Type Description
Boolean

IsInitialized

Returns whether the instance has been initialized or not.

Declaration
public static bool IsInitialized { get; }
Property Value
Type Description
Boolean

IsSceneSystemEnabled

Returns true if the MixedRealityToolkit exists and has an active profile that has Scene system enabled.

Declaration
public static bool IsSceneSystemEnabled { get; }
Property Value
Type Description
Boolean

IsSceneSystemEnabled

Returns true if the MixedRealityToolkit exists and has an active profile that has Scene system enabled.

Declaration
public static bool IsSceneSystemEnabled { get; }
Property Value
Type Description
Boolean

IsTeleportSystemEnabled

Returns true if the MixedRealityToolkit exists and has an active profile that has Teleport system enabled.

Declaration
public static bool IsTeleportSystemEnabled { get; }
Property Value
Type Description
Boolean

IsTeleportSystemEnabled

Returns true if the MixedRealityToolkit exists and has an active profile that has Teleport system enabled.

Declaration
public static bool IsTeleportSystemEnabled { get; }
Property Value
Type Description
Boolean

RegisteredMixedRealityServices

Local service registry for the Mixed Reality Toolkit, to allow runtime use of the IMixedRealityService.

Declaration
public IReadOnlyList<Tuple<Type, IMixedRealityService>> RegisteredMixedRealityServices { get; }
Property Value
Type Description
IReadOnlyList<Tuple<Type, IMixedRealityService>>

RegisteredMixedRealityServices

Local service registry for the Mixed Reality Toolkit, to allow runtime use of the IMixedRealityService.

Declaration
public IReadOnlyList<Tuple<Type, IMixedRealityService>> RegisteredMixedRealityServices { get; }
Property Value
Type Description
IReadOnlyList<Tuple<Type, IMixedRealityService>>

SceneSystem

The current Scene System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealitySceneSystem SceneSystem { get; }
Property Value
Type Description
IMixedRealitySceneSystem

SceneSystem

The current Scene System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealitySceneSystem SceneSystem { get; }
Property Value
Type Description
IMixedRealitySceneSystem

SpatialAwarenessSystem

The current Spatial Awareness System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealitySpatialAwarenessSystem SpatialAwarenessSystem { get; }
Property Value
Type Description
IMixedRealitySpatialAwarenessSystem

SpatialAwarenessSystem

The current Spatial Awareness System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealitySpatialAwarenessSystem SpatialAwarenessSystem { get; }
Property Value
Type Description
IMixedRealitySpatialAwarenessSystem

TeleportSystem

The current Teleport System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealityTeleportSystem TeleportSystem { get; }
Property Value
Type Description
IMixedRealityTeleportSystem

TeleportSystem

The current Teleport System registered with the Mixed Reality Toolkit.

Declaration
public static IMixedRealityTeleportSystem TeleportSystem { get; }
Property Value
Type Description
IMixedRealityTeleportSystem

Methods

AssertIsInitialized()

Expose an assertion whether the MixedRealityToolkit class is initialized.

Declaration
public static void AssertIsInitialized()

AssertIsInitialized()

Expose an assertion whether the MixedRealityToolkit class is initialized.

Declaration
public static void AssertIsInitialized()

ConfirmInitialized()

Static function to determine if the MixedRealityToolkit class has been initialized or not.

Declaration
public static bool ConfirmInitialized()
Returns
Type Description
Boolean

ConfirmInitialized()

Static function to determine if the MixedRealityToolkit class has been initialized or not.

Declaration
public static bool ConfirmInitialized()
Returns
Type Description
Boolean

DisableAllServicesByType(Type)

Disable all services in the Mixed Reality Toolkit active service registry for a given type

Declaration
public void DisableAllServicesByType(Type interfaceType)
Parameters
Type Name Description
Type interfaceType

The interface type for the system to be removed. E.G. InputSystem, BoundarySystem

DisableAllServicesByType(Type)

Disable all services in the Mixed Reality Toolkit active service registry for a given type

Declaration
public void DisableAllServicesByType(Type interfaceType)
Parameters
Type Name Description
Type interfaceType

The interface type for the system to be removed. E.G. InputSystem, BoundarySystem

DisableAllServicesByTypeAndName(Type, String)

Disable all services in the Mixed Reality Toolkit active service registry for a given type and name

Declaration
public void DisableAllServicesByTypeAndName(Type interfaceType, string serviceName)
Parameters
Type Name Description
Type interfaceType

The interface type for the system to be disabled. E.G. InputSystem, BoundarySystem
String serviceName

Name of the specific service

DisableAllServicesByTypeAndName(Type, String)

Disable all services in the Mixed Reality Toolkit active service registry for a given type and name

Declaration
public void DisableAllServicesByTypeAndName(Type interfaceType, string serviceName)
Parameters
Type Name Description
Type interfaceType

The interface type for the system to be disabled. E.G. InputSystem, BoundarySystem
String serviceName

Name of the specific service

EnableAllServicesByType(Type)

Enable all services in the Mixed Reality Toolkit active service registry for a given type

Declaration
public void EnableAllServicesByType(Type interfaceType)
Parameters
Type Name Description
Type interfaceType

The interface type for the system to be enabled. E.G. InputSystem, BoundarySystem

EnableAllServicesByType(Type)

Enable all services in the Mixed Reality Toolkit active service registry for a given type

Declaration
public void EnableAllServicesByType(Type interfaceType)
Parameters
Type Name Description
Type interfaceType

The interface type for the system to be enabled. E.G. InputSystem, BoundarySystem

EnableAllServicesByTypeAndName(Type, String)

Enable all services in the Mixed Reality Toolkit active service registry for a given type and name

Declaration
public void EnableAllServicesByTypeAndName(Type interfaceType, string serviceName)
Parameters
Type Name Description
Type interfaceType

The interface type for the system to be enabled. E.G. InputSystem, BoundarySystem
String serviceName

Name of the specific service

EnableAllServicesByTypeAndName(Type, String)

Enable all services in the Mixed Reality Toolkit active service registry for a given type and name

Declaration
public void EnableAllServicesByTypeAndName(Type interfaceType, string serviceName)
Parameters
Type Name Description
Type interfaceType

The interface type for the system to be enabled. E.G. InputSystem, BoundarySystem
String serviceName

Name of the specific service

GetService<T>(String, Boolean)

Declaration
public T GetService<T>(string name = null, bool showLogs = true)

    where T : IMixedRealityService
Parameters
Type Name Description
String name
Boolean showLogs
Returns
Type Description
T
Type Parameters
Name Description
T

GetService<T>(String, Boolean)

Declaration
public T GetService<T>(string name = null, bool showLogs = true)

    where T : IMixedRealityService
Parameters
Type Name Description
String name
Boolean showLogs
Returns
Type Description
T
Type Parameters
Name Description
T

GetServices<T>(String)

Declaration
public IReadOnlyList<T> GetServices<T>(string name = null)

    where T : IMixedRealityService
Parameters
Type Name Description
String name
Returns
Type Description
IReadOnlyList<T>
Type Parameters
Name Description
T

GetServices<T>(String)

Declaration
public IReadOnlyList<T> GetServices<T>(string name = null)

    where T : IMixedRealityService
Parameters
Type Name Description
String name
Returns
Type Description
IReadOnlyList<T>
Type Parameters
Name Description
T

IsServiceRegistered<T>(String)

Declaration
public bool IsServiceRegistered<T>(string name = null)

    where T : IMixedRealityService
Parameters
Type Name Description
String name
Returns
Type Description
Boolean
Type Parameters
Name Description
T

IsServiceRegistered<T>(String)

Declaration
public bool IsServiceRegistered<T>(string name = null)

    where T : IMixedRealityService
Parameters
Type Name Description
String name
Returns
Type Description
Boolean
Type Parameters
Name Description
T

IsSystemRegistered<T>()

Generic function used to interrogate the Mixed Reality Toolkit active system registry for the existence of a core system.

Declaration
public bool IsSystemRegistered<T>()

    where T : IMixedRealityService
Returns
Type Description
Boolean

True, there is a system registered with the selected interface, False, no system found for that interface
Type Parameters
Name Description
T

The interface type for the system to be retrieved. E.G. InputSystem, BoundarySystem.
Remarks

Note: type should be the Interface of the system to be retrieved and not the concrete class itself.

IsSystemRegistered<T>()

Generic function used to interrogate the Mixed Reality Toolkit active system registry for the existence of a core system.

Declaration
public bool IsSystemRegistered<T>()

    where T : IMixedRealityService
Returns
Type Description
Boolean

True, there is a system registered with the selected interface, False, no system found for that interface
Type Parameters
Name Description
T

The interface type for the system to be retrieved. E.G. InputSystem, BoundarySystem.
Remarks

Note: type should be the Interface of the system to be retrieved and not the concrete class itself.

RegisterService<T>(T)

Declaration
public bool RegisterService<T>(T serviceInstance)

    where T : IMixedRealityService
Parameters
Type Name Description
T serviceInstance
Returns
Type Description
Boolean
Type Parameters
Name Description
T

RegisterService<T>(T)

Declaration
public bool RegisterService<T>(T serviceInstance)

    where T : IMixedRealityService
Parameters
Type Name Description
T serviceInstance
Returns
Type Description
Boolean
Type Parameters
Name Description
T

RegisterService<T>(Type, SupportedPlatforms, Object[])

Declaration
public bool RegisterService<T>(Type concreteType, SupportedPlatforms supportedPlatforms = null, params object[] args)

    where T : IMixedRealityService
Parameters
Type Name Description
Type concreteType
SupportedPlatforms supportedPlatforms
Object[] args
Returns
Type Description
Boolean
Type Parameters
Name Description
T

RegisterService<T>(Type, SupportedPlatforms, Object[])

Declaration
public bool RegisterService<T>(Type concreteType, SupportedPlatforms supportedPlatforms = null, params object[] args)

    where T : IMixedRealityService
Parameters
Type Name Description
Type concreteType
SupportedPlatforms supportedPlatforms
Object[] args
Returns
Type Description
Boolean
Type Parameters
Name Description
T

ResetConfiguration(MixedRealityToolkitConfigurationProfile)

When a configuration Profile is replaced with a new configuration, force all services to reset and read the new values

Declaration
public void ResetConfiguration(MixedRealityToolkitConfigurationProfile profile)
Parameters
Type Name Description
MixedRealityToolkitConfigurationProfile profile

ResetConfiguration(MixedRealityToolkitConfigurationProfile)

When a configuration Profile is replaced with a new configuration, force all services to reset and read the new values

Declaration
public void ResetConfiguration(MixedRealityToolkitConfigurationProfile profile)
Parameters
Type Name Description
MixedRealityToolkitConfigurationProfile profile

SetActiveInstance(MixedRealityToolkit)

Declaration
public static void SetActiveInstance(MixedRealityToolkit toolkitInstance)
Parameters
Type Name Description
MixedRealityToolkit toolkitInstance

SetActiveInstance(MixedRealityToolkit)

Declaration
public static void SetActiveInstance(MixedRealityToolkit toolkitInstance)
Parameters
Type Name Description
MixedRealityToolkit toolkitInstance

SetInstanceInactive(MixedRealityToolkit)

Declaration
public static void SetInstanceInactive(MixedRealityToolkit toolkitInstance)
Parameters
Type Name Description
MixedRealityToolkit toolkitInstance

SetInstanceInactive(MixedRealityToolkit)

Declaration
public static void SetInstanceInactive(MixedRealityToolkit toolkitInstance)
Parameters
Type Name Description
MixedRealityToolkit toolkitInstance

UnregisterService<T>(T)

Declaration
public bool UnregisterService<T>(T serviceInstance)

    where T : IMixedRealityService
Parameters
Type Name Description
T serviceInstance
Returns
Type Description
Boolean
Type Parameters
Name Description
T

UnregisterService<T>(T)

Declaration
public bool UnregisterService<T>(T serviceInstance)

    where T : IMixedRealityService
Parameters
Type Name Description
T serviceInstance
Returns
Type Description
Boolean
Type Parameters
Name Description
T

UnregisterService<T>(String)

Declaration
public bool UnregisterService<T>(string name = null)

    where T : IMixedRealityService
Parameters
Type Name Description
String name
Returns
Type Description
Boolean
Type Parameters
Name Description
T

UnregisterService<T>(String)

Declaration
public bool UnregisterService<T>(string name = null)

    where T : IMixedRealityService
Parameters
Type Name Description
String name
Returns
Type Description
Boolean
Type Parameters
Name Description
T

Implements

MonoBehaviour