mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class BaseMousePointer

    Base Mouse Pointer Implementation.

    Inheritance
    Object
    InputSystemGlobalHandlerListener
    ControllerPoseSynchronizer
    BaseControllerPointer
    BaseMousePointer
    MousePointer
    ScreenSpaceMousePointer
    Implements
    MonoBehaviour
    IMixedRealityControllerPoseSynchronizer
    IMixedRealitySourcePoseHandler
    IMixedRealitySourceStateHandler
    IMixedRealityInputHandler
    IMixedRealityBaseInputHandler
    IMixedRealityInputHandler<Single>
    IMixedRealityInputHandler<Vector2>
    IMixedRealityInputHandler<Vector3>
    IMixedRealityInputHandler<Quaternion>
    IMixedRealityInputHandler<MixedRealityPose>
    IEventSystemHandler
    IMixedRealityMousePointer
    IMixedRealityPointer
    IEqualityComparer
    Inherited Members
    BaseControllerPointer.DisableCursorOnStart
    BaseControllerPointer.raycastOrigin
    BaseControllerPointer.pointerAction
    BaseControllerPointer.IsSelectPressed
    BaseControllerPointer.HasSelectPressedOnce
    BaseControllerPointer.IsHoldPressed
    BaseControllerPointer.SetCursor(GameObject)
    BaseControllerPointer.OnEnable()
    BaseControllerPointer.OnDisable()
    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.Rotation
    BaseControllerPointer.OnPreSceneQuery()
    BaseControllerPointer.OnPostSceneQuery()
    BaseControllerPointer.OnPreCurrentPointerTargetChange()
    BaseControllerPointer.Equals(Object)
    BaseControllerPointer.GetHashCode()
    BaseControllerPointer.Reset()
    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 abstract class BaseMousePointer : BaseControllerPointer, MonoBehaviour, IMixedRealityControllerPoseSynchronizer, IMixedRealitySourcePoseHandler, IMixedRealitySourceStateHandler, IMixedRealityInputHandler, IMixedRealityBaseInputHandler, IMixedRealityInputHandler<float>, IMixedRealityInputHandler<Vector2>, IMixedRealityInputHandler<Vector3>, IMixedRealityInputHandler<Quaternion>, IMixedRealityInputHandler<MixedRealityPose>, IEventSystemHandler, IMixedRealityMousePointer, IMixedRealityPointer, IEqualityComparer

    Fields

    isDisabled

    Declaration
    protected bool isDisabled
    Field Value
    Type Description
    Boolean

    isDisabled

    Declaration
    protected bool isDisabled
    Field Value
    Type Description
    Boolean

    timeoutTimer

    Declaration
    protected float timeoutTimer
    Field Value
    Type Description
    Single

    timeoutTimer

    Declaration
    protected float timeoutTimer
    Field Value
    Type Description
    Single

    Properties

    Controller

    Declaration
    public override IMixedRealityController Controller { get; set; }
    Property Value
    Type Description
    IMixedRealityController
    Overrides
    BaseControllerPointer.Controller

    Controller

    Declaration
    public override IMixedRealityController Controller { get; set; }
    Property Value
    Type Description
    IMixedRealityController
    Overrides
    BaseControllerPointer.Controller

    ControllerName

    Declaration
    protected abstract string ControllerName { get; }
    Property Value
    Type Description
    String

    ControllerName

    Declaration
    protected abstract string ControllerName { get; }
    Property Value
    Type Description
    String

    HideCursorWhenInactive

    If true, the cursor will hide on movement timeout

    Declaration
    public bool HideCursorWhenInactive { get; }
    Property Value
    Type Description
    Boolean

    HideCursorWhenInactive

    If true, the cursor will hide on movement timeout

    Declaration
    public bool HideCursorWhenInactive { get; }
    Property Value
    Type Description
    Boolean

    HideTimeout

    Time the mouse cursor must stay immobile to be hidden

    Declaration
    public float HideTimeout { get; }
    Property Value
    Type Description
    Single

    HideTimeout

    Time the mouse cursor must stay immobile to be hidden

    Declaration
    public float HideTimeout { get; }
    Property Value
    Type Description
    Single

    IsInteractionEnabled

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

    IsInteractionEnabled

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

    MovementThresholdToUnHide

    Movement threshold to reach before un-hiding the mouse cursor

    Declaration
    public float MovementThresholdToUnHide { get; }
    Property Value
    Type Description
    Single

    MovementThresholdToUnHide

    Movement threshold to reach before un-hiding the mouse cursor

    Declaration
    public float MovementThresholdToUnHide { get; }
    Property Value
    Type Description
    Single

    Position

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

    Position

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

    Methods

    OnInputDown(InputEventData)

    Declaration
    public override void OnInputDown(InputEventData eventData)
    Parameters
    Type Name Description
    InputEventData eventData
    Overrides
    BaseControllerPointer.OnInputDown(InputEventData)

    OnInputDown(InputEventData)

    Declaration
    public override void OnInputDown(InputEventData eventData)
    Parameters
    Type Name Description
    InputEventData eventData
    Overrides
    BaseControllerPointer.OnInputDown(InputEventData)

    OnInputUp(InputEventData)

    Declaration
    public override void OnInputUp(InputEventData eventData)
    Parameters
    Type Name Description
    InputEventData eventData
    Overrides
    BaseControllerPointer.OnInputUp(InputEventData)

    OnInputUp(InputEventData)

    Declaration
    public override void OnInputUp(InputEventData eventData)
    Parameters
    Type Name Description
    InputEventData eventData
    Overrides
    BaseControllerPointer.OnInputUp(InputEventData)

    OnSourceDetected(SourceStateEventData)

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

    OnSourceDetected(SourceStateEventData)

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

    OnSourceLost(SourceStateEventData)

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

    OnSourceLost(SourceStateEventData)

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

    SetVisibility(Boolean)

    Declaration
    protected virtual void SetVisibility(bool visible)
    Parameters
    Type Name Description
    Boolean visible

    SetVisibility(Boolean)

    Declaration
    protected virtual void SetVisibility(bool visible)
    Parameters
    Type Name Description
    Boolean visible

    Start()

    Declaration
    protected override void Start()
    Overrides
    BaseControllerPointer.Start()

    Start()

    Declaration
    protected override void Start()
    Overrides
    BaseControllerPointer.Start()

    Implements

    MonoBehaviour
    IMixedRealityControllerPoseSynchronizer
    IMixedRealitySourcePoseHandler
    IMixedRealitySourceStateHandler
    IMixedRealityInputHandler
    IMixedRealityBaseInputHandler
    IMixedRealityInputHandler<T>
    IMixedRealityInputHandler<T>
    IMixedRealityInputHandler<T>
    IMixedRealityInputHandler<T>
    IMixedRealityInputHandler<T>
    IEventSystemHandler
    IMixedRealityMousePointer
    IMixedRealityPointer
    IEqualityComparer
    In This Article
    • Fields
      • isDisabled
      • isDisabled
      • timeoutTimer
      • timeoutTimer
    • Properties
      • Controller
      • Controller
      • ControllerName
      • ControllerName
      • HideCursorWhenInactive
      • HideCursorWhenInactive
      • HideTimeout
      • HideTimeout
      • IsInteractionEnabled
      • IsInteractionEnabled
      • MovementThresholdToUnHide
      • MovementThresholdToUnHide
      • Position
      • Position
    • Methods
      • OnInputDown(InputEventData)
      • OnInputDown(InputEventData)
      • OnInputUp(InputEventData)
      • OnInputUp(InputEventData)
      • OnSourceDetected(SourceStateEventData)
      • OnSourceDetected(SourceStateEventData)
      • OnSourceLost(SourceStateEventData)
      • OnSourceLost(SourceStateEventData)
      • SetVisibility(Boolean)
      • SetVisibility(Boolean)
      • Start()
      • Start()
    • Implements
    Back to top Generated by DocFX