Class BaseMousePointer

Base Mouse Pointer Implementation.

Inheritance
Object
InputSystemGlobalHandlerListener
ControllerPoseSynchronizer
BaseControllerPointer
BaseMousePointer
MousePointer
ScreenSpaceMousePointer
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public abstract class BaseMousePointer : BaseControllerPointer, 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

timeoutTimer

Declaration
protected float timeoutTimer
Field Value
Type Description
Single

Properties

Controller

The current controller reference.

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

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

HideTimeout

Time the mouse cursor must stay immobile to be hidden

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

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

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

Methods

OnInputDown(InputEventData)

Input Down updates from Interactions, Keys, or any other simple input.

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

OnInputUp(InputEventData)

Input Up updates from Interactions, Keys, or any other simple input.

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

OnSourceDetected(SourceStateEventData)

Raised when a source is detected.

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

OnSourceLost(SourceStateEventData)

Raised when a source is lost.

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

SetVisibility(Boolean)

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

Start()

Declaration
protected override void Start()
Overrides

Implements

IEventSystemHandler
IEqualityComparer