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.

Search Results for

    Show / Hide Table of Contents

    Class DefaultPointerMediator

    The default implementation for pointer mediation in MRTK which is responsible for determining which pointers are active based on the state of all pointers. For example, one of the key things this class does is disable far pointers when a near pointer is close to an object.

    Inheritance
    Object
    DefaultPointerMediator
    Implements
    IMixedRealityPointerMediator
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public class DefaultPointerMediator : IMixedRealityPointerMediator

    Constructors

    DefaultPointerMediator()

    Declaration
    public DefaultPointerMediator()

    DefaultPointerMediator(IPointerPreferences)

    Declaration
    [Obsolete("Use DefaultPointerMediator() instead, followed by a call to SetPointerPreferences()")]
    public DefaultPointerMediator(IPointerPreferences pointerPrefs)
    Parameters
    Type Name Description
    IPointerPreferences pointerPrefs

    Fields

    allPointers

    Declaration
    protected readonly HashSet<IMixedRealityPointer> allPointers
    Field Value
    Type Description
    HashSet<IMixedRealityPointer>

    farInteractPointers

    Declaration
    protected readonly HashSet<IMixedRealityPointer> farInteractPointers
    Field Value
    Type Description
    HashSet<IMixedRealityPointer>

    nearInteractPointers

    Declaration
    protected readonly HashSet<IMixedRealityNearPointer> nearInteractPointers
    Field Value
    Type Description
    HashSet<IMixedRealityNearPointer>

    pointerByInputSourceParent

    Declaration
    protected readonly Dictionary<IMixedRealityInputSource, HashSet<IMixedRealityPointer>> pointerByInputSourceParent
    Field Value
    Type Description
    Dictionary<IMixedRealityInputSource, HashSet<IMixedRealityPointer>>

    pointerPreferences

    Declaration
    protected IPointerPreferences pointerPreferences
    Field Value
    Type Description
    IPointerPreferences

    teleportPointers

    Declaration
    protected readonly HashSet<IMixedRealityTeleportPointer> teleportPointers
    Field Value
    Type Description
    HashSet<IMixedRealityTeleportPointer>

    unassignedPointers

    Declaration
    protected readonly HashSet<IMixedRealityPointer> unassignedPointers
    Field Value
    Type Description
    HashSet<IMixedRealityPointer>

    Methods

    RegisterPointers(IMixedRealityPointer[])

    Declaration
    public virtual void RegisterPointers(IMixedRealityPointer[] pointers)
    Parameters
    Type Name Description
    IMixedRealityPointer[] pointers

    SetPointerPreferences(IPointerPreferences)

    Called to set the pointer preferences of the current input and focus configuration.

    Declaration
    public void SetPointerPreferences(IPointerPreferences pointerPreferences)
    Parameters
    Type Name Description
    IPointerPreferences pointerPreferences
    Remarks

    These preferences can be used by the pointer mediator to determine runtime preferences set by the caller (for example, the caller could request to turn off all hand rays). It's possible that some of these preferences may not be honored (for example, current input system is set up to not have hand rays at all, and a request comes in to turn on/off hand rays).

    UnregisterPointers(IMixedRealityPointer[])

    Declaration
    public virtual void UnregisterPointers(IMixedRealityPointer[] pointers)
    Parameters
    Type Name Description
    IMixedRealityPointer[] pointers

    UpdatePointers()

    Declaration
    public virtual void UpdatePointers()

    Implements

    IMixedRealityPointerMediator
    In This Article
    Back to top Generated by DocFX