Class FocusProvider

The focus provider handles the focused objects per input source.

Inheritance
Object
BaseService
BaseEventSystem
BaseCoreSystem
FocusProvider
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public class FocusProvider : BaseCoreSystem, IMixedRealityEventSystem, IMixedRealityFocusProvider, IMixedRealityService, IDisposable, IMixedRealitySourceStateHandler, IMixedRealitySpeechHandler, IMixedRealityBaseInputHandler, IEventSystemHandler, IPointerPreferences
Remarks

There are convenience properties for getting only Gaze Pointer if needed.

Constructors

FocusProvider(IMixedRealityServiceRegistrar, MixedRealityInputSystemProfile)

Constructor.

Declaration
public FocusProvider(IMixedRealityServiceRegistrar registrar, MixedRealityInputSystemProfile profile)
Parameters
Type Name Description
IMixedRealityServiceRegistrar registrar

The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealityInputSystemProfile profile

The configuration profile for the service.

FocusProvider(IMixedRealityServiceRegistrar, MixedRealityInputSystemProfile)

Constructor.

Declaration
public FocusProvider(IMixedRealityServiceRegistrar registrar, MixedRealityInputSystemProfile profile)
Parameters
Type Name Description
IMixedRealityServiceRegistrar registrar

The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealityInputSystemProfile profile

The configuration profile for the service.

FocusProvider(MixedRealityInputSystemProfile)

Constructor.

Declaration
public FocusProvider(MixedRealityInputSystemProfile profile)
Parameters
Type Name Description
MixedRealityInputSystemProfile profile

The configuration profile for the service.

FocusProvider(MixedRealityInputSystemProfile)

Constructor.

Declaration
public FocusProvider(MixedRealityInputSystemProfile profile)
Parameters
Type Name Description
MixedRealityInputSystemProfile profile

The configuration profile for the service.

Properties

FocusLayerMasks

Declaration
public LayerMask[] FocusLayerMasks { get; }
Property Value
Type Description
LayerMask[]

FocusLayerMasks

Declaration
public LayerMask[] FocusLayerMasks { get; }
Property Value
Type Description
LayerMask[]

GazePointerBehavior

Declaration
public PointerBehavior GazePointerBehavior { get; set; }
Property Value
Type Description
PointerBehavior

GazePointerBehavior

Declaration
public PointerBehavior GazePointerBehavior { get; set; }
Property Value
Type Description
PointerBehavior

Name

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

Name

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

NumFarPointersActive

The number of pointers that support far interaction (like motion controller rays, hand rays) that are active (IsInteractionEnabled == true), excluding the gaze cursor

Declaration
public int NumFarPointersActive { get; }
Property Value
Type Description
Int32

NumFarPointersActive

The number of pointers that support far interaction (like motion controller rays, hand rays) that are active (IsInteractionEnabled == true), excluding the gaze cursor

Declaration
public int NumFarPointersActive { get; }
Property Value
Type Description
Int32

NumNearPointersActive

Number of IMixedRealityNearPointers that are active (IsInteractionEnabled == true).

Declaration
public int NumNearPointersActive { get; }
Property Value
Type Description
Int32

NumNearPointersActive

Number of IMixedRealityNearPointers that are active (IsInteractionEnabled == true).

Declaration
public int NumNearPointersActive { get; }
Property Value
Type Description
Int32

PointerMediators

Declaration
public IReadOnlyDictionary<uint, IMixedRealityPointerMediator> PointerMediators { get; }
Property Value
Type Description
IReadOnlyDictionary<UInt32, IMixedRealityPointerMediator>

PointerMediators

Declaration
public IReadOnlyDictionary<uint, IMixedRealityPointerMediator> PointerMediators { get; }
Property Value
Type Description
IReadOnlyDictionary<UInt32, IMixedRealityPointerMediator>

PrimaryPointer

Declaration
public IMixedRealityPointer PrimaryPointer { get; }
Property Value
Type Description
IMixedRealityPointer

PrimaryPointer

Declaration
public IMixedRealityPointer PrimaryPointer { get; }
Property Value
Type Description
IMixedRealityPointer

Priority

Declaration
public override uint Priority { get; }
Property Value
Type Description
UInt32
Overrides

Priority

Declaration
public override uint Priority { get; }
Property Value
Type Description
UInt32
Overrides

UIRaycastCamera

Declaration
public Camera UIRaycastCamera { get; }
Property Value
Type Description
Camera

UIRaycastCamera

Declaration
public Camera UIRaycastCamera { get; }
Property Value
Type Description
Camera

Methods

Destroy()

Declaration
public override void Destroy()
Overrides

Destroy()

Declaration
public override void Destroy()
Overrides

GenerateNewPointerId()

Declaration
public uint GenerateNewPointerId()
Returns
Type Description
UInt32

GenerateNewPointerId()

Declaration
public uint GenerateNewPointerId()
Returns
Type Description
UInt32

GetFocusedObject(IMixedRealityPointer)

Declaration
public GameObject GetFocusedObject(IMixedRealityPointer pointingSource)
Parameters
Type Name Description
IMixedRealityPointer pointingSource
Returns
Type Description
GameObject

GetFocusedObject(IMixedRealityPointer)

Declaration
public GameObject GetFocusedObject(IMixedRealityPointer pointingSource)
Parameters
Type Name Description
IMixedRealityPointer pointingSource
Returns
Type Description
GameObject

GetPointerBehavior(IMixedRealityPointer)

Declaration
public PointerBehavior GetPointerBehavior(IMixedRealityPointer pointer)
Parameters
Type Name Description
IMixedRealityPointer pointer
Returns
Type Description
PointerBehavior

GetPointerBehavior(IMixedRealityPointer)

Declaration
public PointerBehavior GetPointerBehavior(IMixedRealityPointer pointer)
Parameters
Type Name Description
IMixedRealityPointer pointer
Returns
Type Description
PointerBehavior

GetPointerBehavior<T>(Handedness, InputSourceType)

Gets the behavior for the given pointer type.

Declaration
public PointerBehavior GetPointerBehavior<T>(Handedness handedness, InputSourceType sourceType)

    where T : class, IMixedRealityPointer
Parameters
Type Name Description
Handedness handedness

Handedness to query
InputSourceType sourceType
Returns
Type Description
PointerBehavior

PointerBehavior for the given pointer type and handedness. If right hand is enabled, left hand is not enabled, and Handedness.Any is passed, returns value for the right hand.
Type Parameters
Name Description
T

GetPointerBehavior<T>(Handedness, InputSourceType)

Gets the behavior for the given pointer type.

Declaration
public PointerBehavior GetPointerBehavior<T>(Handedness handedness, InputSourceType sourceType)

    where T : class, IMixedRealityPointer
Parameters
Type Name Description
Handedness handedness

Handedness to query
InputSourceType sourceType
Returns
Type Description
PointerBehavior

PointerBehavior for the given pointer type and handedness. If right hand is enabled, left hand is not enabled, and Handedness.Any is passed, returns value for the right hand.
Type Parameters
Name Description
T

GetPointers<T>()

Declaration
public IEnumerable<T> GetPointers<T>()

    where T : class, IMixedRealityPointer
Returns
Type Description
IEnumerable<T>
Type Parameters
Name Description
T

GetPointers<T>()

Declaration
public IEnumerable<T> GetPointers<T>()

    where T : class, IMixedRealityPointer
Returns
Type Description
IEnumerable<T>
Type Parameters
Name Description
T

Initialize()

Declaration
public override void Initialize()
Overrides

Initialize()

Declaration
public override void Initialize()
Overrides

IsPointerRegistered(IMixedRealityPointer)

Declaration
public bool IsPointerRegistered(IMixedRealityPointer pointer)
Parameters
Type Name Description
IMixedRealityPointer pointer
Returns
Type Description
Boolean

IsPointerRegistered(IMixedRealityPointer)

Declaration
public bool IsPointerRegistered(IMixedRealityPointer pointer)
Parameters
Type Name Description
IMixedRealityPointer pointer
Returns
Type Description
Boolean

OnSourceDetected(SourceStateEventData)

Declaration
public void OnSourceDetected(SourceStateEventData eventData)
Parameters
Type Name Description
SourceStateEventData eventData

OnSourceDetected(SourceStateEventData)

Declaration
public void OnSourceDetected(SourceStateEventData eventData)
Parameters
Type Name Description
SourceStateEventData eventData

OnSourceLost(SourceStateEventData)

Declaration
public void OnSourceLost(SourceStateEventData eventData)
Parameters
Type Name Description
SourceStateEventData eventData

OnSourceLost(SourceStateEventData)

Declaration
public void OnSourceLost(SourceStateEventData eventData)
Parameters
Type Name Description
SourceStateEventData eventData

OnSpeechKeywordRecognized(SpeechEventData)

Declaration
public void OnSpeechKeywordRecognized(SpeechEventData eventData)
Parameters
Type Name Description
SpeechEventData eventData

OnSpeechKeywordRecognized(SpeechEventData)

Declaration
public void OnSpeechKeywordRecognized(SpeechEventData eventData)
Parameters
Type Name Description
SpeechEventData eventData

RegisterPointer(IMixedRealityPointer)

Declaration
public bool RegisterPointer(IMixedRealityPointer pointer)
Parameters
Type Name Description
IMixedRealityPointer pointer
Returns
Type Description
Boolean

RegisterPointer(IMixedRealityPointer)

Declaration
public bool RegisterPointer(IMixedRealityPointer pointer)
Parameters
Type Name Description
IMixedRealityPointer pointer
Returns
Type Description
Boolean

SetPointerBehavior<T>(Handedness, InputSourceType, PointerBehavior)

Declaration
public void SetPointerBehavior<T>(Handedness handedness, InputSourceType inputType, PointerBehavior pointerBehavior)

    where T : class, IMixedRealityPointer
Parameters
Type Name Description
Handedness handedness
InputSourceType inputType
PointerBehavior pointerBehavior
Type Parameters
Name Description
T

SetPointerBehavior<T>(Handedness, InputSourceType, PointerBehavior)

Declaration
public void SetPointerBehavior<T>(Handedness handedness, InputSourceType inputType, PointerBehavior pointerBehavior)

    where T : class, IMixedRealityPointer
Parameters
Type Name Description
Handedness handedness
InputSourceType inputType
PointerBehavior pointerBehavior
Type Parameters
Name Description
T

SubscribeToPrimaryPointerChanged(PrimaryPointerChangedHandler, Boolean)

Declaration
public void SubscribeToPrimaryPointerChanged(PrimaryPointerChangedHandler handler, bool invokeHandlerWithCurrentPointer)
Parameters
Type Name Description
PrimaryPointerChangedHandler handler
Boolean invokeHandlerWithCurrentPointer

SubscribeToPrimaryPointerChanged(PrimaryPointerChangedHandler, Boolean)

Declaration
public void SubscribeToPrimaryPointerChanged(PrimaryPointerChangedHandler handler, bool invokeHandlerWithCurrentPointer)
Parameters
Type Name Description
PrimaryPointerChangedHandler handler
Boolean invokeHandlerWithCurrentPointer

TryGetFocusDetails(IMixedRealityPointer, out FocusDetails)

Declaration
public bool TryGetFocusDetails(IMixedRealityPointer pointer, out FocusDetails focusDetails)
Parameters
Type Name Description
IMixedRealityPointer pointer
FocusDetails focusDetails
Returns
Type Description
Boolean

TryGetFocusDetails(IMixedRealityPointer, out FocusDetails)

Declaration
public bool TryGetFocusDetails(IMixedRealityPointer pointer, out FocusDetails focusDetails)
Parameters
Type Name Description
IMixedRealityPointer pointer
FocusDetails focusDetails
Returns
Type Description
Boolean

TryOverrideFocusDetails(IMixedRealityPointer, FocusDetails)

Declaration
public bool TryOverrideFocusDetails(IMixedRealityPointer pointer, FocusDetails focusDetails)
Parameters
Type Name Description
IMixedRealityPointer pointer
FocusDetails focusDetails
Returns
Type Description
Boolean

TryOverrideFocusDetails(IMixedRealityPointer, FocusDetails)

Declaration
public bool TryOverrideFocusDetails(IMixedRealityPointer pointer, FocusDetails focusDetails)
Parameters
Type Name Description
IMixedRealityPointer pointer
FocusDetails focusDetails
Returns
Type Description
Boolean

UnregisterPointer(IMixedRealityPointer)

Declaration
public bool UnregisterPointer(IMixedRealityPointer pointer)
Parameters
Type Name Description
IMixedRealityPointer pointer
Returns
Type Description
Boolean

UnregisterPointer(IMixedRealityPointer)

Declaration
public bool UnregisterPointer(IMixedRealityPointer pointer)
Parameters
Type Name Description
IMixedRealityPointer pointer
Returns
Type Description
Boolean

UnsubscribeFromPrimaryPointerChanged(PrimaryPointerChangedHandler)

Declaration
public void UnsubscribeFromPrimaryPointerChanged(PrimaryPointerChangedHandler handler)
Parameters
Type Name Description
PrimaryPointerChangedHandler handler

UnsubscribeFromPrimaryPointerChanged(PrimaryPointerChangedHandler)

Declaration
public void UnsubscribeFromPrimaryPointerChanged(PrimaryPointerChangedHandler handler)
Parameters
Type Name Description
PrimaryPointerChangedHandler handler

Update()

Declaration
public override void Update()
Overrides

Update()

Declaration
public override void Update()
Overrides

Explicit Interface Implementations

IMixedRealityFocusProvider.GlobalPointingExtent

Declaration
float IMixedRealityFocusProvider.GlobalPointingExtent { get; }
Returns
Type Description
Single

IMixedRealityFocusProvider.GlobalPointingExtent

Declaration
float IMixedRealityFocusProvider.GlobalPointingExtent { get; }
Returns
Type Description
Single

Implements

IDisposable
IEventSystemHandler