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.

    Show / Hide Table of Contents

    Class TouchPointer

    Touch Pointer Implementation.

    Inheritance
    Object
    InputSystemGlobalHandlerListener
    ControllerPoseSynchronizer
    BaseControllerPointer
    TouchPointer
    Implements
    IMixedRealityControllerPoseSynchronizer
    IMixedRealitySourcePoseHandler
    IMixedRealitySourceStateHandler
    IMixedRealityInputHandler
    IMixedRealityBaseInputHandler
    IMixedRealityInputHandler<Single>
    IMixedRealityInputHandler<Vector2>
    IMixedRealityInputHandler<Vector3>
    IMixedRealityInputHandler<Quaternion>
    IMixedRealityInputHandler<MixedRealityPose>
    IEventSystemHandler
    IMixedRealityTouchPointer
    IMixedRealityPointer
    IEqualityComparer
    Inherited Members
    BaseControllerPointer.DisableCursorOnStart
    BaseControllerPointer.raycastOrigin
    BaseControllerPointer.pointerAction
    BaseControllerPointer.IsSelectPressed
    BaseControllerPointer.HasSelectPressedOnce
    BaseControllerPointer.IsHoldPressed
    BaseControllerPointer.SetCursor(GameObject)
    BaseControllerPointer.OnEnable()
    BaseControllerPointer.Start()
    BaseControllerPointer.OnDisable()
    BaseControllerPointer.Controller
    BaseControllerPointer.PointerId
    BaseControllerPointer.PointerName
    BaseControllerPointer.InputSourceParent
    BaseControllerPointer.BaseCursor
    BaseControllerPointer.CursorModifier
    BaseControllerPointer.IsActive
    BaseControllerPointer.IsFocusLocked
    BaseControllerPointer.IsTargetPositionLockedOnFocusLock
    BaseControllerPointer.PointerExtent
    BaseControllerPointer.DefaultPointerExtent
    BaseControllerPointer.Rays
    BaseControllerPointer.PrioritizedLayerMasksOverride
    BaseControllerPointer.FocusTarget
    BaseControllerPointer.Result
    BaseControllerPointer.RayStabilizer
    BaseControllerPointer.SceneQueryType
    BaseControllerPointer.SphereCastRadius
    BaseControllerPointer.OnPostSceneQuery()
    BaseControllerPointer.OnPreCurrentPointerTargetChange()
    BaseControllerPointer.Reset()
    BaseControllerPointer.Equals(Object)
    BaseControllerPointer.GetHashCode()
    BaseControllerPointer.OnInputUp(InputEventData)
    BaseControllerPointer.OnInputDown(InputEventData)
    ControllerPoseSynchronizer.Handedness
    ControllerPoseSynchronizer.DestroyOnSourceLost
    ControllerPoseSynchronizer.IsTracked
    ControllerPoseSynchronizer.TrackingState
    ControllerPoseSynchronizer.UseSourcePoseData
    ControllerPoseSynchronizer.PoseAction
    ControllerPoseSynchronizer.RegisterHandlers()
    ControllerPoseSynchronizer.UnregisterHandlers()
    ControllerPoseSynchronizer.OnSourcePoseChanged(SourcePoseEventData<TrackingState>)
    ControllerPoseSynchronizer.OnSourcePoseChanged(SourcePoseEventData<Vector2>)
    ControllerPoseSynchronizer.OnSourcePoseChanged(SourcePoseEventData<Vector3>)
    ControllerPoseSynchronizer.OnSourcePoseChanged(SourcePoseEventData<Quaternion>)
    ControllerPoseSynchronizer.OnSourcePoseChanged(SourcePoseEventData<MixedRealityPose>)
    ControllerPoseSynchronizer.OnInputChanged(InputEventData<Single>)
    ControllerPoseSynchronizer.OnInputChanged(InputEventData<Vector2>)
    ControllerPoseSynchronizer.OnInputChanged(InputEventData<Vector3>)
    ControllerPoseSynchronizer.OnInputChanged(InputEventData<Quaternion>)
    ControllerPoseSynchronizer.OnInputChanged(InputEventData<MixedRealityPose>)
    InputSystemGlobalHandlerListener.EnsureInputSystemValid()
    Namespace: Microsoft.MixedReality.Toolkit.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public class TouchPointer : BaseControllerPointer, IMixedRealityControllerPoseSynchronizer, IMixedRealitySourcePoseHandler, IMixedRealitySourceStateHandler, IMixedRealityInputHandler, IMixedRealityBaseInputHandler, IMixedRealityInputHandler<float>, IMixedRealityInputHandler<Vector2>, IMixedRealityInputHandler<Vector3>, IMixedRealityInputHandler<Quaternion>, IMixedRealityInputHandler<MixedRealityPose>, IEventSystemHandler, IMixedRealityTouchPointer, IMixedRealityPointer, IEqualityComparer

    Properties

    FingerId

    Current finger id of the touch.

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

    IsInteractionEnabled

    Is the pointer active and have the conditions for the interaction been satisfied to enable the interaction?

    Declaration
    public override bool IsInteractionEnabled { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    BaseControllerPointer.IsInteractionEnabled

    Position

    Pointer position.

    Declaration
    public override Vector3 Position { get; }
    Property Value
    Type Description
    Vector3
    Overrides
    BaseControllerPointer.Position

    Rotation

    Pointer rotation.

    Declaration
    public override Quaternion Rotation { get; }
    Property Value
    Type Description
    Quaternion
    Overrides
    BaseControllerPointer.Rotation

    TouchRay

    Current touch ray.

    Declaration
    public Ray TouchRay { get; set; }
    Property Value
    Type Description
    Ray

    Methods

    OnPreSceneQuery()

    Called before performing the scene query.

    Declaration
    public override void OnPreSceneQuery()
    Overrides
    BaseControllerPointer.OnPreSceneQuery()

    OnSourceDetected(SourceStateEventData)

    Raised when a source is detected.

    Declaration
    public override void OnSourceDetected(SourceStateEventData eventData)
    Parameters
    Type Name Description
    SourceStateEventData eventData
    Overrides
    ControllerPoseSynchronizer.OnSourceDetected(SourceStateEventData)

    OnSourceLost(SourceStateEventData)

    Raised when a source is lost.

    Declaration
    public override void OnSourceLost(SourceStateEventData eventData)
    Parameters
    Type Name Description
    SourceStateEventData eventData
    Overrides
    BaseControllerPointer.OnSourceLost(SourceStateEventData)

    Implements

    IMixedRealityControllerPoseSynchronizer
    IMixedRealitySourcePoseHandler
    IMixedRealitySourceStateHandler
    IMixedRealityInputHandler
    IMixedRealityBaseInputHandler
    IMixedRealityInputHandler<T>
    IMixedRealityInputHandler<T>
    IMixedRealityInputHandler<T>
    IMixedRealityInputHandler<T>
    IMixedRealityInputHandler<T>
    IEventSystemHandler
    IMixedRealityTouchPointer
    IMixedRealityPointer
    IEqualityComparer
    Back to top Generated by DocFX