MRTKRayInteractor Class

Definition

Namespace:: MixedReality.Toolkit.Input

Assembly:: MixedReality.Toolkit.Input.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A wrapper for the XRRayInteractor which stores extra information for MRTK management/services

[UnityEngine.AddComponentMenu("MRTK/Input/MRTK Ray Interactor")]
[UnityEngine.DefaultExecutionOrder(-29989)]
public class MRTKRayInteractor : UnityEngine.XR.Interaction.Toolkit.XRRayInteractor, MixedReality.Toolkit.IHandedInteractor, MixedReality.Toolkit.IRayInteractor, MixedReality.Toolkit.IVariableSelectInteractor

[<UnityEngine.AddComponentMenu("MRTK/Input/MRTK Ray Interactor")>]
[<UnityEngine.DefaultExecutionOrder(-29989)>]
type MRTKRayInteractor = class
    inherit XRRayInteractor
    interface IRayInteractor
    interface IXRInteractor
    interface IHandedInteractor
    interface IVariableSelectInteractor
    interface IXRSelectInteractor
    interface IXRHoverInteractor

Public Class MRTKRayInteractor
Inherits XRRayInteractor
Implements IHandedInteractor, IRayInteractor, IVariableSelectInteractor

Inheritance: UnityEngine.XR.Interaction.Toolkit.XRRayInteractor
MRTKRayInteractor

Attributes: UnityEngine.AddComponentMenuAttribute UnityEngine.DefaultExecutionOrderAttribute

Implements: IHandedInteractor IRayInteractor IVariableSelectInteractor UnityEngine.XR.Interaction.Toolkit.IXRHoverInteractor UnityEngine.XR.Interaction.Toolkit.IXRInteractor UnityEngine.XR.Interaction.Toolkit.IXRSelectInteractor

Constructors

Name	Description
MRTKRayInteractor()

Fields

Name	Description
relaxationThreshold	How unselected the interactor must be to initiate a new hover or selection on a new target. Separate from the hand controller's threshold for pinching, so that we can tune overall pinching threshold separately from the roll-off prevention. Should be [0,1].

Properties

Name	Description
AimPoseSource	The pose source representing the ray this interactor uses for aiming and positioning.
DevicePoseSource	The pose source representing the device this interactor uses for rotation.
HandsAggregator	Obsolete. Cached reference to hands aggregator for efficient per-frame use.
HasUIHover	Is this ray currently hovering a UnityUI/Canvas element?
HasUISelection	Is this ray currently selecting a UnityUI/Canvas element?
isHoverActive	UnityEngine.XR.Interaction.Toolkit.IXRHoverInteractor.isHoverActive
SelectProgress	Returns a value [0,1] representing the variable amount of "selection" that this interactor is performing.

Methods

Name	Description
CanHover(IXRHoverInteractable)	UnityEngine.XR.Interaction.Toolkit.IXRHoverInteractor.CanHover(UnityEngine.XR.Interaction.Toolkit.IXRHoverInteractable)
CanSelect(IXRSelectInteractable)	UnityEngine.XR.Interaction.Toolkit.IXRSelectInteractor.CanSelect(UnityEngine.XR.Interaction.Toolkit.IXRSelectInteractable)
GetValidTargets(List<IXRInteractable>)	UnityEngine.XR.Interaction.Toolkit.IXRInteractor.GetValidTargets(System.Collections.Generic.List{UnityEngine.XR.Interaction.Toolkit.IXRInteractable})
OnSelectEntering(SelectEnterEventArgs)	UnityEngine.XR.Interaction.Toolkit.IXRSelectInteractor.OnSelectEntering(UnityEngine.XR.Interaction.Toolkit.SelectEnterEventArgs)
ProcessInteractor(XRInteractionUpdateOrder+UpdatePhase)	UnityEngine.XR.Interaction.Toolkit.IXRInteractor.ProcessInteractor(UnityEngine.XR.Interaction.Toolkit.XRInteractionUpdateOrder.UpdatePhase)

Explicit Interface Implementations

Name	Description
IHandedInteractor.Handedness

Applies to