IMixedRealityFocusProvider Interface

Definition

Namespace:

Microsoft.MixedReality.Toolkit.Input

Assembly:

Microsoft.MixedReality.Toolkit.dll

Implements the Focus Provider for handling focus of pointers.

public interface class IMixedRealityFocusProvider : IDisposable, Microsoft::MixedReality::Toolkit::IMixedRealityService, Microsoft::MixedReality::Toolkit::Input::IMixedRealitySourceStateHandler, Microsoft::MixedReality::Toolkit::Input::IMixedRealitySpeechHandler, UnityEngine::EventSystems::IEventSystemHandler

public interface IMixedRealityFocusProvider : IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityService, Microsoft.MixedReality.Toolkit.Input.IMixedRealitySourceStateHandler, Microsoft.MixedReality.Toolkit.Input.IMixedRealitySpeechHandler, UnityEngine.EventSystems.IEventSystemHandler

type IMixedRealityFocusProvider = interface
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealitySourceStateHandler
    interface IEventSystemHandler
    interface IMixedRealitySpeechHandler
    interface IMixedRealityBaseInputHandler

Public Interface IMixedRealityFocusProvider
Implements IDisposable, IEventSystemHandler, IMixedRealityService, IMixedRealitySourceStateHandler, IMixedRealitySpeechHandler

Derived

Microsoft.MixedReality.Toolkit.Input.FocusProvider

Implements

IMixedRealityService IMixedRealityBaseInputHandler IMixedRealitySourceStateHandler IMixedRealitySpeechHandler IDisposable UnityEngine.EventSystems.IEventSystemHandler

Properties

ConfigurationProfile	The configuration profile for the service. (Inherited from IMixedRealityService)
FocusLayerMasks	The layer masks for the focus pointers to raycast against.
GlobalPointingExtent	Maximum distance at which all pointers can collide with a GameObject, unless it has an override extent.
Name	Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action. (Inherited from IMixedRealityService)
PrimaryPointer	Current primary pointer. Determined by the primary pointer selector in use (see MixedRealityPointerProfile.PrimaryPointerSelector).
Priority	Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated. (Inherited from IMixedRealityService)
UIRaycastCamera	The Camera the EventSystem uses to raycast against.

Methods

Destroy()	Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed. (Inherited from IMixedRealityService)
Disable()	Optional Disable function to pause the service. (Inherited from IMixedRealityService)
Enable()	Optional Enable function to enable / re-enable the service. (Inherited from IMixedRealityService)
GenerateNewPointerId()	Generate a new unique pointer id.
GetFocusedObject(IMixedRealityPointer)	Gets the currently focused object for the pointing source.
GetPointers<T>()	Provides access to all registered pointers of a specified type.
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. (Inherited from IMixedRealityService)
IsPointerRegistered(IMixedRealityPointer)	Checks if the pointer is registered with the Focus Manager.
LateUpdate()	Optional LateUpdate function to that is called after Update has been called on all services. (Inherited from IMixedRealityService)
OnSourceDetected(SourceStateEventData)	Raised when a source is detected. (Inherited from IMixedRealitySourceStateHandler)
OnSourceLost(SourceStateEventData)	Raised when a source is lost. (Inherited from IMixedRealitySourceStateHandler)
OnSpeechKeywordRecognized(SpeechEventData)	(Inherited from IMixedRealitySpeechHandler)
RegisterPointer(IMixedRealityPointer)	Registers the pointer with the Focus Manager.
Reset()	Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change. (Inherited from IMixedRealityService)
SubscribeToPrimaryPointerChanged(PrimaryPointerChangedHandler, Boolean)	Subscribes to primary pointer changes.
TryGetFocusDetails(IMixedRealityPointer, FocusDetails)	Gets the currently focused object for the pointing source.
TryOverrideFocusDetails(IMixedRealityPointer, FocusDetails)	Sets the FocusDetails of the specified pointer, overriding the focus point that was currently set. This can be used to change the FocusDetails of a specific pointer even if focus is locked.
UnregisterPointer(IMixedRealityPointer)	Unregisters the pointer with the Focus Manager.
UnsubscribeFromPrimaryPointerChanged(PrimaryPointerChangedHandler)	Unsubscribes from primary pointer changes.
Update()	Optional Update function to perform per-frame updates of the service. (Inherited from IMixedRealityService)