mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0releases/2.3.0releases/2.4.0releases/2.5.0releases/2.5.1releases/2.5.2releases/2.5.3
  • Features and Architecture
  • API Documentation

We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

  • API Documentation
Search Results for

    Show / Hide Table of Contents

    Class MixedRealitySpatialAwarenessSystem

    Class providing the default implementation of the IMixedRealitySpatialAwarenessSystem interface.

    Inheritance
    Object
    BaseService
    BaseEventSystem
    BaseCoreSystem
    BaseDataProviderAccessCoreSystem
    MixedRealitySpatialAwarenessSystem
    Implements
    IMixedRealityDataProviderAccess
    IMixedRealitySpatialAwarenessSystem
    IMixedRealityEventSystem
    IMixedRealityService
    IDisposable
    IMixedRealityCapabilityCheck
    Inherited Members
    BaseDataProviderAccessCoreSystem.Update()
    BaseDataProviderAccessCoreSystem.LateUpdate()
    BaseDataProviderAccessCoreSystem.GetDataProviders()
    BaseDataProviderAccessCoreSystem.GetDataProvider(String)
    BaseDataProviderAccessCoreSystem.RegisterDataProvider<T>(Type, String, SupportedPlatforms, Object[])
    BaseDataProviderAccessCoreSystem.RegisterDataProvider<T>(Type, SupportedPlatforms, Object[])
    BaseDataProviderAccessCoreSystem.RegisterDataProvider<T>(T)
    BaseDataProviderAccessCoreSystem.UnregisterDataProvider<T>(String)
    BaseDataProviderAccessCoreSystem.UnregisterDataProvider<T>(T)
    BaseCoreSystem.Registrar
    BaseEventSystem.enableDanglingHandlerDiagnostics
    BaseEventSystem.EventHandlersByType
    BaseEventSystem.EventListeners
    BaseEventSystem.HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)
    BaseEventSystem.RegisterHandler<T>(IEventSystemHandler)
    BaseEventSystem.UnregisterHandler<T>(IEventSystemHandler)
    BaseEventSystem.Register(GameObject)
    BaseEventSystem.Unregister(GameObject)
    BaseService.DefaultPriority
    BaseService.Priority
    BaseService.ConfigurationProfile
    BaseService.disposed
    BaseService.Dispose()
    BaseService.Dispose(Boolean)
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.SpatialAwareness
    Assembly: cs.temp.dll.dll
    Syntax
    public class MixedRealitySpatialAwarenessSystem : BaseDataProviderAccessCoreSystem, IMixedRealityDataProviderAccess, IMixedRealitySpatialAwarenessSystem, IMixedRealityEventSystem, IMixedRealityService, IDisposable, IMixedRealityCapabilityCheck

    Constructors

    MixedRealitySpatialAwarenessSystem(IMixedRealityServiceRegistrar, MixedRealitySpatialAwarenessSystemProfile)

    Constructor.

    Declaration
    [Obsolete("This constructor is obsolete (registrar parameter is no longer required) and will be removed in a future version of the Microsoft Mixed Reality Toolkit.")]
    public MixedRealitySpatialAwarenessSystem(IMixedRealityServiceRegistrar registrar, MixedRealitySpatialAwarenessSystemProfile profile)
    Parameters
    Type Name Description
    IMixedRealityServiceRegistrar registrar

    The IMixedRealityServiceRegistrar instance that loaded the service.

    MixedRealitySpatialAwarenessSystemProfile profile

    The configuration profile for the service.

    MixedRealitySpatialAwarenessSystem(MixedRealitySpatialAwarenessSystemProfile)

    Constructor.

    Declaration
    public MixedRealitySpatialAwarenessSystem(MixedRealitySpatialAwarenessSystemProfile profile)
    Parameters
    Type Name Description
    MixedRealitySpatialAwarenessSystemProfile profile

    The configuration profile for the service.

    Properties

    Name

    Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action.

    Declaration
    public override string Name { get; protected set; }
    Property Value
    Type Description
    String
    Overrides
    BaseService.Name

    SpatialAwarenessObjectParent

    Gets the parent object to which all spatial awareness GameObjects are to be parented.

    Declaration
    public GameObject SpatialAwarenessObjectParent { get; }
    Property Value
    Type Description
    GameObject

    SpatialAwarenessSystemProfile

    Typed representation of the ConfigurationProfile property.

    Declaration
    public MixedRealitySpatialAwarenessSystemProfile SpatialAwarenessSystemProfile { get; }
    Property Value
    Type Description
    MixedRealitySpatialAwarenessSystemProfile

    Methods

    CheckCapability(MixedRealityCapability)

    Checks to see if one or more registered data providers supports the requested capability on the current platform.

    Declaration
    public bool CheckCapability(MixedRealityCapability capability)
    Parameters
    Type Name Description
    MixedRealityCapability capability

    The capability to check.

    Returns
    Type Description
    Boolean

    True if the capability is supported, false otherwise.

    ClearObservations()

    Clears all registered observers' observations.

    Declaration
    public void ClearObservations()

    ClearObservations<T>(String)

    Clears the observations of the specified observer.

    Declaration
    public void ClearObservations<T>(string name)
        where T : IMixedRealitySpatialAwarenessObserver
    Parameters
    Type Name Description
    String name

    The name of the observer.

    Type Parameters
    Name Description
    T

    The observer type.

    CreateSpatialAwarenessObservationParent(String)

    Creates the a parent, that is a child of the Spatial Awareness System parent so that the scene hierarchy does not get overly cluttered.

    Declaration
    public GameObject CreateSpatialAwarenessObservationParent(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    GameObject

    The GameObject to which spatial awareness objects will be parented.

    Remarks

    This method is to be called by implementations of the IMixedRealitySpatialAwarenessObserver interface, not by application code. It is used to enable observations to be grouped by observer.

    Destroy()

    Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed.

    Declaration
    public override void Destroy()
    Overrides
    BaseEventSystem.Destroy()

    Disable()

    Optional Disable function to pause the service.

    Declaration
    public override void Disable()
    Overrides
    BaseService.Disable()

    Enable()

    Optional Enable function to enable / re-enable the service.

    Declaration
    public override void Enable()
    Overrides
    BaseDataProviderAccessCoreSystem.Enable()

    GenerateNewSourceId()

    Generates a new source identifier for an IMixedRealitySpatialAwarenessObserver implementation.

    Declaration
    public uint GenerateNewSourceId()
    Returns
    Type Description
    UInt32

    The source identifier to be used by the IMixedRealitySpatialAwarenessObserver implementation.

    Remarks

    This method is to be called by implementations of the IMixedRealitySpatialAwarenessObserver interface, not by application code.

    GetDataProvider<T>(String)

    Get the data provider that is registered under the specified name (optional) and matching the specified type.

    Declaration
    public override T GetDataProvider<T>(string name = null)
        where T : IMixedRealityDataProvider
    Parameters
    Type Name Description
    String name

    The friendly name of the data provider.

    Returns
    Type Description
    T

    The requested data provider, or null if one cannot be found.

    Type Parameters
    Name Description
    T

    The desired data provider type.

    Overrides
    BaseDataProviderAccessCoreSystem.GetDataProvider<T>(String)
    Remarks

    If more than one data provider is registered under the specified name, the first will be returned.

    GetDataProviders<T>()

    Get the collection of registered observers of the specified type.

    Declaration
    public override IReadOnlyList<T> GetDataProviders<T>()
        where T : IMixedRealityDataProvider
    Returns
    Type Description
    IReadOnlyList<T>

    Read-only copy of the list of registered data providers that implement the specified type.

    Type Parameters
    Name Description
    T

    The desired data provider type

    Overrides
    BaseDataProviderAccessCoreSystem.GetDataProviders<T>()

    GetObserver(String)

    Get the IMixedRealitySpatialAwarenessObserver that is registered under the specified name.

    Declaration
    public IMixedRealitySpatialAwarenessObserver GetObserver(string name)
    Parameters
    Type Name Description
    String name

    The friendly name of the observer.

    Returns
    Type Description
    IMixedRealitySpatialAwarenessObserver

    The requested observer, or null if one cannot be found.

    Remarks

    If more than one observer is registered under the specified name, the first will be returned.

    GetObserver<T>(String)

    Get the observer that is registered under the specified name matching the specified type.

    Declaration
    public T GetObserver<T>(string name = null)
        where T : IMixedRealitySpatialAwarenessObserver
    Parameters
    Type Name Description
    String name

    The friendly name of the observer.

    Returns
    Type Description
    T

    The requested observer, or null if one cannot be found.

    Type Parameters
    Name Description
    T

    The desired spatial awareness observer type (ex: IMixedRealitySpatialAwarenessMeshObserver)

    Remarks

    If more than one observer is registered under the specified name, the first will be returned.

    GetObservers()

    Gets the collection of registered IMixedRealitySpatialAwarenessObserver data providers.

    Declaration
    public IReadOnlyList<IMixedRealitySpatialAwarenessObserver> GetObservers()
    Returns
    Type Description
    IReadOnlyList<IMixedRealitySpatialAwarenessObserver>

    Read only copy of the list of registered observers.

    GetObservers<T>()

    Get the collection of registered observers of the specified type.

    Declaration
    public IReadOnlyList<T> GetObservers<T>()
        where T : IMixedRealitySpatialAwarenessObserver
    Returns
    Type Description
    IReadOnlyList<T>

    Readonly copy of the list of registered observers that implement the specified type.

    Type Parameters
    Name Description
    T

    The desired spatial awareness observer type (ex: IMixedRealitySpatialAwarenessMeshObserver)

    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.

    Declaration
    public override void Initialize()
    Overrides
    BaseService.Initialize()

    Reset()

    Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change.

    Declaration
    public override void Reset()
    Overrides
    BaseDataProviderAccessCoreSystem.Reset()

    ResumeObserver<T>(String)

    Starts / restarts the spatial observer registered under the specified name matching the specified type.

    Declaration
    public void ResumeObserver<T>(string name)
        where T : IMixedRealitySpatialAwarenessObserver
    Parameters
    Type Name Description
    String name

    The friendly name of the observer.

    Type Parameters
    Name Description
    T

    The desired spatial awareness observer type (ex: IMixedRealitySpatialAwarenessMeshObserver)

    ResumeObservers()

    Starts / restarts all spatial observers of the specified type.

    Declaration
    public void ResumeObservers()

    ResumeObservers<T>()

    Starts / restarts all spatial observers of the specified type.

    Declaration
    public void ResumeObservers<T>()
        where T : IMixedRealitySpatialAwarenessObserver
    Type Parameters
    Name Description
    T

    The desired spatial awareness observer type (ex: IMixedRealitySpatialAwarenessMeshObserver)

    SuspendObserver<T>(String)

    Stops / pauses the spatial observer registered under the specified name matching the specified type.

    Declaration
    public void SuspendObserver<T>(string name)
        where T : IMixedRealitySpatialAwarenessObserver
    Parameters
    Type Name Description
    String name

    The friendly name of the observer.

    Type Parameters
    Name Description
    T

    The desired spatial awareness observer type (ex: IMixedRealitySpatialAwarenessMeshObserver)

    SuspendObservers()

    Stops / pauses all spatial observers.

    Declaration
    public void SuspendObservers()

    SuspendObservers<T>()

    Stops / pauses all spatial observers of the specified type.

    Declaration
    public void SuspendObservers<T>()
        where T : IMixedRealitySpatialAwarenessObserver
    Type Parameters
    Name Description
    T

    Implements

    IMixedRealityDataProviderAccess
    IMixedRealitySpatialAwarenessSystem
    IMixedRealityEventSystem
    IMixedRealityService
    System.IDisposable
    IMixedRealityCapabilityCheck
    In This Article
    • Constructors
      • MixedRealitySpatialAwarenessSystem(IMixedRealityServiceRegistrar, MixedRealitySpatialAwarenessSystemProfile)
      • MixedRealitySpatialAwarenessSystem(MixedRealitySpatialAwarenessSystemProfile)
    • Properties
      • Name
      • SpatialAwarenessObjectParent
      • SpatialAwarenessSystemProfile
    • Methods
      • CheckCapability(MixedRealityCapability)
      • ClearObservations()
      • ClearObservations<T>(String)
      • CreateSpatialAwarenessObservationParent(String)
      • Destroy()
      • Disable()
      • Enable()
      • GenerateNewSourceId()
      • GetDataProvider<T>(String)
      • GetDataProviders<T>()
      • GetObserver(String)
      • GetObserver<T>(String)
      • GetObservers()
      • GetObservers<T>()
      • Initialize()
      • Reset()
      • ResumeObserver<T>(String)
      • ResumeObservers()
      • ResumeObservers<T>()
      • SuspendObserver<T>(String)
      • SuspendObservers()
      • SuspendObservers<T>()
    • Implements
    Back to top Generated by DocFX