ScreenSpaceMousePointer Class

Definition

Namespace:

Microsoft.MixedReality.Toolkit.Input

Assembly:

Microsoft.MixedReality.Toolkit.SDK.dll

Uses the desktop mouse cursor instead of any mouse representation within the scene. Its movement is bound to screenspace.

public ref class ScreenSpaceMousePointer : Microsoft::MixedReality::Toolkit::Input::BaseMousePointer

[UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/ScreenSpaceMousePointer")]
public class ScreenSpaceMousePointer : Microsoft.MixedReality.Toolkit.Input.BaseMousePointer

[<UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/ScreenSpaceMousePointer")>]
type ScreenSpaceMousePointer = class
    inherit BaseMousePointer

Public Class ScreenSpaceMousePointer
Inherits BaseMousePointer

Inheritance

UnityEngine.MonoBehaviour

InputSystemGlobalHandlerListener

ControllerPoseSynchronizer

BaseControllerPointer

BaseMousePointer

ScreenSpaceMousePointer

Attributes

UnityEngine.AddComponentMenuAttribute

Constructors

ScreenSpaceMousePointer()

Fields

grabAction	(Inherited from BaseControllerPointer)
HasSelectPressedOnce	True if select has been pressed once since this component was enabled (Inherited from BaseControllerPointer)
isDisabled	(Inherited from BaseMousePointer)
IsGrabPressed	True if grab is pressed right now (Inherited from BaseControllerPointer)
IsHoldPressed	(Inherited from BaseControllerPointer)
IsSelectPressed	True if select is pressed right now (Inherited from BaseControllerPointer)
pointerAction	(Inherited from BaseControllerPointer)
raycastOrigin	(Inherited from BaseControllerPointer)
timeoutTimer	(Inherited from BaseMousePointer)
TrackingState	The current tracking state of the assigned IMixedRealityController (Inherited from ControllerPoseSynchronizer)

Properties

BaseCursor	The pointer's cursor. (Inherited from BaseControllerPointer)
Controller	The pointer's current controller reference. (Inherited from BaseMousePointer)
ControllerName	UnityEngine.MonoBehaviour.ControllerName
CursorModifier	The currently active cursor modifier. (Inherited from BaseControllerPointer)
DefaultPointerExtent	The length of the pointer when nothing is hit. (Inherited from BaseControllerPointer)
DestroyOnSourceLost	Should this GameObject clean itself up when its controller is lost? (Inherited from ControllerPoseSynchronizer)
DisableCursorOnStart	(Inherited from BaseControllerPointer)
FocusTarget	The currently focused target. (Inherited from BaseControllerPointer)
Handedness	The controller handedness this component is synchronized with. (Inherited from ControllerPoseSynchronizer)
HideCursorWhenInactive	If true, the cursor will hide on movement timeout (Inherited from BaseMousePointer)
HideTimeout	Time the mouse cursor must stay immobile to be hidden (Inherited from BaseMousePointer)
InputSourceParent	Obsolete. This pointer's input source parent. (Inherited from BaseControllerPointer)
IsActive	Controls whether the pointer dispatches input. (Inherited from BaseControllerPointer)
IsFocusLocked	Is the focus for this pointer currently locked? (Inherited from BaseControllerPointer)
IsInteractionEnabled	Is the pointer active and have the conditions for the interaction been satisfied to enable the interaction? (Inherited from BaseMousePointer)
IsTargetPositionLockedOnFocusLock	Specifies whether the pointer's target position (cursor) is locked to the target object when focus is locked. Most pointers want the cursor to "stick" to the object when manipulating, so set this to true by default. (Inherited from BaseControllerPointer)
IsTracked	Is the controller this Synchronizer is registered to currently tracked? (Inherited from ControllerPoseSynchronizer)
MovementThresholdToUnHide	Movement threshold to reach before un-hiding the mouse cursor (Inherited from BaseMousePointer)
PointerExtent	Maximum distance at which all pointers can collide with a GameObject, unless it has an override extent. (Inherited from BaseControllerPointer)
PointerId	This pointer's id. (Inherited from BaseControllerPointer)
PointerName	This pointer's name. (Inherited from BaseControllerPointer)
PoseAction	The input action that will drive the Transform's pose, position, or rotation. (Inherited from ControllerPoseSynchronizer)
Position	(Inherited from BaseMousePointer)
PrioritizedLayerMasksOverride	The physics layers to use when performing scene queries. (Inherited from BaseControllerPointer)
Rays	The scene query rays. (Inherited from BaseControllerPointer)
RayStabilizer	Ray stabilizer used when calculating position of pointer end point. (Inherited from BaseControllerPointer)
Result	The scene query pointer result. (Inherited from BaseControllerPointer)
Rotation	Pointer rotation. (Inherited from BaseControllerPointer)
SceneQueryType	The type of physics scene query to use. (Inherited from BaseControllerPointer)
SphereCastRadius	The radius to use when SceneQueryType is set to Sphere or SphereColliders. (Inherited from BaseControllerPointer)
UseSourcePoseAsFallback	Should the Transform's position use the source pose by default until the input handler events are received? (Inherited from ControllerPoseSynchronizer)
UseSourcePoseData	Should the Transform's position be driven from the source pose or from input handler? (Inherited from ControllerPoseSynchronizer)

Methods

EnsureInputSystemValid()	A task that will only complete when the input system has in a valid state. (Inherited from InputSystemGlobalHandlerListener)
Equals(Object)	(Inherited from BaseControllerPointer)
GetHashCode()	(Inherited from BaseControllerPointer)
InputEventDataUsable<T>(InputEventData<T>)	Helper function used to determine whether or not the controller pose synchronizer is configured to make use of the InputEventData (Inherited from ControllerPoseSynchronizer)
OnDisable()	(Inherited from BaseControllerPointer)
OnEnable()	(Inherited from BaseControllerPointer)
OnInputChanged(InputEventData<MixedRealityPose>)	Raised input event updates from the type of input specified in the interface handler implementation. (Inherited from ControllerPoseSynchronizer)
OnInputChanged(InputEventData<Quaternion>)	Raised input event updates from the type of input specified in the interface handler implementation. (Inherited from ControllerPoseSynchronizer)
OnInputChanged(InputEventData<Single>)	Raised input event updates from the type of input specified in the interface handler implementation. (Inherited from ControllerPoseSynchronizer)
OnInputChanged(InputEventData<Vector2>)	Raised input event updates from the type of input specified in the interface handler implementation. (Inherited from ControllerPoseSynchronizer)
OnInputChanged(InputEventData<Vector3>)	Raised input event updates from the type of input specified in the interface handler implementation. (Inherited from ControllerPoseSynchronizer)
OnInputDown(InputEventData)	(Inherited from BaseMousePointer)
OnInputUp(InputEventData)	(Inherited from BaseMousePointer)
OnPostSceneQuery()	Called after performing the scene query. (Inherited from BaseControllerPointer)
OnPreCurrentPointerTargetChange()	Called during the scene query just before the current pointer target changes. (Inherited from BaseControllerPointer)
OnPreSceneQuery()	Called before performing the scene query.
OnSceneQuery(LayerMask[], Boolean, GameObject, Vector3, Single)	Called to have the pointer query the scene to determine which objects it is hitting. Updates hitObject, hitPoint, and hitDistance. Used when the method for querying the scene does not utilize a RaycastHit. Examples of this include UnityEngine.Physics.SphereOverlap, which performs no raycast calls (Inherited from BaseControllerPointer)
OnSceneQuery(LayerMask[], Boolean, MixedRealityRaycastHit, RayStep, Int32)	Called to have the pointer query the scene to determine which objects it is hitting. Updates hitinfo. Used when the method for querying the scene utilizes a RaycastHit, such as when using UnityEngine.Physics.Raycast (Inherited from BaseControllerPointer)
OnSourceDetected(SourceStateEventData)	(Inherited from BaseMousePointer)
OnSourceLost(SourceStateEventData)	(Inherited from BaseMousePointer)
OnSourcePoseChanged(SourcePoseEventData<MixedRealityPose>)	Raised when the source pose is changed. (Inherited from ControllerPoseSynchronizer)
OnSourcePoseChanged(SourcePoseEventData<Quaternion>)	Raised when the source rotation is changed. (Inherited from ControllerPoseSynchronizer)
OnSourcePoseChanged(SourcePoseEventData<TrackingState>)	Raised when the source pose tracking state is changed. (Inherited from ControllerPoseSynchronizer)
OnSourcePoseChanged(SourcePoseEventData<Vector2>)	Raised when the source position is changed. (Inherited from ControllerPoseSynchronizer)
OnSourcePoseChanged(SourcePoseEventData<Vector3>)	Raised when the source position is changed. (Inherited from ControllerPoseSynchronizer)
RegisterHandlers()	Overload this method to specify, which global events component wants to listen to. Use RegisterHandler API of InputSystem (Inherited from ControllerPoseSynchronizer)
Reset()	Resets pointer to initial state. After invoked pointer should be functional and ready for re-use. (Inherited from BaseControllerPointer)
SetCursor(GameObject)	Set a new cursor for this IMixedRealityPointer (Inherited from BaseControllerPointer)
SetVisibility(Boolean)	UnityEngine.MonoBehaviour.SetVisibility(System.Boolean)
SourcePoseDataUsable<T>(SourcePoseEventData<T>)	Helper function used to determine whether or not the controller pose synchronizer is configured to make use of the SourcePoseEventData (Inherited from ControllerPoseSynchronizer)
Start()	(Inherited from BaseMousePointer)
UnregisterHandlers()	Overload this method to specify, which global events component should stop listening to. Use UnregisterHandler API of InputSystem (Inherited from ControllerPoseSynchronizer)

Explicit Interface Implementations

IEqualityComparer.Equals(Object, Object)	(Inherited from BaseControllerPointer)
IEqualityComparer.GetHashCode(Object)	(Inherited from BaseControllerPointer)