Microsoft.MixedReality.Toolkit Namespace

Classes

AnimationCurveExtensions

Extension methods for Unity's AnimationCurve class

ArrayExtensions

Array type method extensions.

AssemblyExtensions
BaseCoreSystem
BaseDataProvider
BaseDataProvider<T>

The base data provider implements IMixedRealityDataProvider and provides default properties for all data providers.

BaseDataProviderAccessCoreSystem

Abstract class for core MRTK system with functionality defined for managing and accessing IMixedRealityDataProviders

BaseEventSystem

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

BaseExtensionService

The base extension service implements IMixedRealityExtensionService and provides default properties for all extension services.

BaseMixedRealityProfile

Base abstract class for all Mixed Reality profile configurations. Extends ScriptableObject and used as a property container to initialize MRTK services.

BaseService

The base service implements IMixedRealityService and provides default properties for all services.

BeginReadOnlyGroupAttribute
BoundsExtensions

Extension methods for Unity's Bounds struct

CameraExtensions

Extension methods for the Unity's Camera class

CameraFOVChecker

Camera extension methods to test if colliders are within camera's FOV. Uses caching to improve performance and ensure values are only computed once per frame

CanvasExtensions

Extensions for the Canvas class.

CollectionsExtensions

Extension methods for .Net Collection objects, e.g. Lists, Dictionaries, Arrays

Color32Extensions

Extension methods for Unity's Color32 struct

ComparerExtensions

Extension methods for .Net Comparer's

ComponentExtensions

Extensions methods for the Unity Component class. This also includes some component-related extensions for the GameObject class.

CoreServices

Utility class to easily access references to core runtime Mixed Reality Toolkit Services If deallocating and re-allocating a new system at runtime, ResetCacheReferences() should be used to get a proper reference

DateTimeExtensions

DateTime Extensions.

DocLinkAttribute

Defines a documentation link for a service. Used primarily by service inspector facades.

DoubleExtensions

Extension methods for the .Net Double struct

EndReadOnlyGroupAttribute
EnumerableExtensions

Extension methods for the .Net IEnumerable class

EnumFlagsAttribute

An attribute that allows a particular field to be rendered as multi-selectable set of flags.

EventSystemExtensions

Extension methods for Unity's EventSystem

ExperimentalAttribute

A PropertyAttribute for showing a warning box that the tagged implementation is experimental.

ExtendsAttribute

Constraint that allows selection of classes that extend a specific class when selecting a SystemType with the Unity inspector.

FloatExtensions

Extension methods for the .Net Float struct

GameObjectExtensions

Extension methods for Unity's GameObject class

GenericBaseEventData

Generic Base Event Data for Sending Events through the Event System.

HandednessExtensions

Handedness type method extensions.

HelpAttribute

A PropertyAttribute for showing a collapsible Help section.

ImplementsAttribute

Constraint that allows selection of classes that implement a specific interface when selecting a SystemType with the Unity inspector.

LayerExtensions

Extension methods for Unity's LayerMask struct

MathExtensions

Extension methods and helper functions for various math data

MixedRealityCameraProfile

This Scriptable Object tells you if your head mounted display (HMD) is a transparent device or an occluded device. Based on those values, you can customize your camera and quality settings.

MixedRealityDataProviderAttribute

Attribute that defines the properties of a Mixed Reality Toolkit data provider.

MixedRealityExperienceSettingsProfile

Experience settings profile for the Mixed Reality Toolkit.

MixedRealityExtensionServiceAttribute

Attribute that defines the properties of a Mixed Reality Toolkit extension service.

MixedRealityPlayspace

A static class encapsulating the Mixed Reality playspace.

MixedRealityRegisteredServiceProvidersProfile
MixedRealitySceneContent

Use this script on GameObjects you wish to be aligned in certain ways depending on the application space type. For example, if you want to place an object at the height of the user's head in a room scale application, check alignWithHeadHeight. In a stationary scale application, this is equivalent to placing the object at a height of 0. You can also specify specific locations to place the object based on space type.

This script runs once, on GameObject creation.

MixedRealityServiceInspectorAttribute

Attach to a class implementing IMixedRealityServiceInspector to generate a facade inspector.

MixedRealityServiceProfileAttribute

Attribute that defines which service a profile is meant to be consumed by. Only applies to profiles that are consumed by types implementing IMixedRealityService. A service must implement all required types and no excluded types to be considered compatible with the profile.

MixedRealityServiceRegistry

Static class that represents the Mixed Reality Toolkit service registry.

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.

MixedRealityToolkitConfigurationProfile

Configuration profile settings for the Mixed Reality Toolkit.

PhysicalPressEventRouter

This class exists to route PressableButton events through to Interactable. The result is being able to have physical touch call Interactable.OnPointerClicked.

PlacementEventData

Describes placement of objects events.

PrefabAttribute

Attribute used to ensure that a GameObject inspector slot only accepts prefabs.

ProcessExtensions

Process Extension class.

QuaternionExtensions

Extension methods for Unity's Quaternion struct.

RayExtensions

Extension methods for Unity's Ray struct

ReadOnlyAttribute
SceneAssetReferenceAttribute

Attribute for using a SceneAssetReference property drawer.

SceneAssetReferenceAttributeDrawer

Draws an object field as a scene asset reference. This enables fields to store references to scene assets (which is an editor-only object) as unity objects (which work in both editor and runtime)

ScenePickAttribute

Attribute to mark up an int field to be drawn using the ScenePickPropertyDrawer This allows the UI to display a dropdown instead of a numeric entry field.

SpeechKeywordAttribute

Attribute used to display a dropdown of registered keywords from the speech profile.

StringBuilderExtensions

StringBuilder Extensions.

StringExtensions

String Extensions.

SubmitEventRouter

This is a helper class to allow you to call OnSubmit() on a UnityEngine.UI.Button or other control derived from UnityEngine.EventSystems.ISubmitHandler on this gameObject. It exposes a public function that can be bound in the Editor to a Unity Event.

SystemNumericsExtensions
SystemTypeAttribute

Base class for class selection constraints that can be applied when selecting a SystemType with the Unity inspector.

TagPropertyAttribute

A PropertyAttribute for Unity tags (a string field).

Texture2DExtensions

A collection of helper functions for Texture2D

TransformExtensions

Extension methods for Unity's Transform class

TypeExtensions
UnityObjectExtensions

Extension methods for Unity's Object class

Vector3RangeAttribute

Attribute used to make a float or int variable in a script be restricted to a specific range.

VectorExtensions

Extension methods for Unity's Vector struct

Structs

BaseEventSystem.EventHandlerEntry
MixedRealityServiceConfiguration

Defines a system, feature, or manager to be registered with as a IMixedRealityExtensionService on startup.

Interfaces

IMixedRealityCapabilityCheck
IMixedRealityDataProvider

Required interface for all Mixed Reality data providers. Data providers are the components that supply services with required information (ex: input controller state).

IMixedRealityDataProviderAccess

Allows systems to provide access to their managed data providers.

IMixedRealityEventHandler

Interface to implement generic events.

IMixedRealityEventSource

Interface to implement an event source.

IMixedRealityEventSystem

Interface used to implement an Event System that is compatible with the Mixed Reality Toolkit.

IMixedRealityExtensionService

Generic interface for all optional Mixed Reality systems, components, or features that can be added to the MixedRealityServiceConfiguration

IMixedRealityService

Generic interface for all Mixed Reality Services

IMixedRealityServiceConfiguration

Defines configuration data for to be registered for a IMixedRealityService on startup. Generally, used for configuring the extended interface, IMixedRealityDataProvider

IMixedRealityServiceRegistrar

Interface for Mixed Reality Toolkit service registration.

IMixedRealityServiceState

Interface providing properties that components can call to determine the current state of a mixed reality service.

Enums

BoundsExtensions.Axis
DistortionMode

How to apply the distortion along the line.

InterpolationMode

Default options for how to distribute interpolated points in a line renderer

InterpolationType

Defines the type of interpolation to use when calculating a spline.

LinePointTransformMode

Defines how a base line data provider will transform its points

LineRotationMode

Defines how to calculate the line's rotation at any given point.

MixedRealityCapability

Mixed reality platform capabilities.

PhysicalPressEventRouter.PhysicalPressEventBehavior
PointDistributionMode

Defines how to get an interpolated point along a line

SDKType

The SDKType lists the XR SDKs that are supported by the Mixed Reality Toolkit. Initially, this lists proposed SDKs, not all may be implemented at this time (please see ReleaseNotes for more details)

StepMode

Defines how to generate points in a line renderer

TrackingState

The Tracking State defines how a device is currently being tracked. This enables developers to be able to handle non-tracked situations and react accordingly.