Show / Hide Table of Contents

    Class SpatialLocalizer<TSpatialLocalizationSettings>

    Helper class to enable spatial localization between two entities on SpectatorView.

    Inheritance
    Object
    SpatialLocalizer<TSpatialLocalizationSettings>
    MarkerDetectorSpatialLocalizer
    MarkerVisualDetectorSpatialLocalizer
    MarkerVisualSpatialLocalizer
    SpatialAnchorsLocalizer
    WorldAnchorSpatialLocalizer
    Implements
    ISpatialLocalizer
    Namespace: Microsoft.MixedReality.SpectatorView
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class SpatialLocalizer<TSpatialLocalizationSettings> : MonoBehaviour, ISpatialLocalizer where TSpatialLocalizationSettings : ISpatialLocalizationSettings, new()
    Type Parameters
    Name Description
    TSpatialLocalizationSettings
    Remarks

    In the future this would move to SpatialLocalization in a better form, abstraction-wise.

    Fields

    debugLogging

    Declaration
    protected bool debugLogging
    Field Value
    Type Description
    Boolean

    lockObject

    Declaration
    protected readonly object lockObject
    Field Value
    Type Description
    Object

    Properties

    DisplayName

    Declaration
    public abstract string DisplayName { get; }
    Property Value
    Type Description
    String

    IsSupported

    Declaration
    protected abstract bool IsSupported { get; }
    Property Value
    Type Description
    Boolean

    SpatialLocalizerId

    Declaration
    public abstract Guid SpatialLocalizerId { get; }
    Property Value
    Type Description
    Guid

    Methods

    CreateDefaultSettings()

    Declaration
    public virtual ISpatialLocalizationSettings CreateDefaultSettings()
    Returns
    Type Description
    ISpatialLocalizationSettings

    DebugLog(String)

    Helper method for logging troubleshooting information.

    Declaration
    protected void DebugLog(string message)
    Parameters
    Type Name Description
    String message

    Message to log.

    OnDestroy()

    Declaration
    protected virtual void OnDestroy()

    Start()

    Declaration
    protected virtual void Start()

    TryCreateLocalizationSession(IPeerConnection, TSpatialLocalizationSettings, out ISpatialLocalizationSession)

    Declaration
    public abstract bool TryCreateLocalizationSession(IPeerConnection peerConnection, TSpatialLocalizationSettings settings, out ISpatialLocalizationSession session)
    Parameters
    Type Name Description
    IPeerConnection peerConnection
    TSpatialLocalizationSettings settings
    ISpatialLocalizationSession session
    Returns
    Type Description
    Boolean

    TryDeserializeSettings(BinaryReader, out TSpatialLocalizationSettings)

    Declaration
    public abstract bool TryDeserializeSettings(BinaryReader reader, out TSpatialLocalizationSettings settings)
    Parameters
    Type Name Description
    BinaryReader reader
    TSpatialLocalizationSettings settings
    Returns
    Type Description
    Boolean

    Explicit Interface Implementations

    ISpatialLocalizer.TryCreateLocalizationSession(IPeerConnection, ISpatialLocalizationSettings, out ISpatialLocalizationSession)

    Declaration
    bool ISpatialLocalizer.TryCreateLocalizationSession(IPeerConnection peerConnection, ISpatialLocalizationSettings settings, out ISpatialLocalizationSession session)
    Parameters
    Type Name Description
    IPeerConnection peerConnection
    ISpatialLocalizationSettings settings
    ISpatialLocalizationSession session
    Returns
    Type Description
    Boolean

    ISpatialLocalizer.TryDeserializeSettings(BinaryReader, out ISpatialLocalizationSettings)

    Declaration
    bool ISpatialLocalizer.TryDeserializeSettings(BinaryReader reader, out ISpatialLocalizationSettings settings)
    Parameters
    Type Name Description
    BinaryReader reader
    ISpatialLocalizationSettings settings
    Returns
    Type Description
    Boolean

    Implements

    ISpatialLocalizer
    In This Article
    • Fields
      • debugLogging
      • lockObject
    • Properties
      • DisplayName
      • IsSupported
      • SpatialLocalizerId
    • Methods
      • CreateDefaultSettings()
      • DebugLog(String)
      • OnDestroy()
      • Start()
      • TryCreateLocalizationSession(IPeerConnection, TSpatialLocalizationSettings, out ISpatialLocalizationSession)
      • TryDeserializeSettings(BinaryReader, out TSpatialLocalizationSettings)
    • Explicit Interface Implementations
      • ISpatialLocalizer.TryCreateLocalizationSession(IPeerConnection, ISpatialLocalizationSettings, out ISpatialLocalizationSession)
      • ISpatialLocalizer.TryDeserializeSettings(BinaryReader, out ISpatialLocalizationSettings)
    • Implements
    Back to top Generated by DocFX