Class FingerCursor

Cursor used to aide in near finger interactions.

Inheritance
Object
BaseCursor
FingerCursor
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public class FingerCursor : BaseCursor, IMixedRealityCursor, IMixedRealityFocusChangedHandler, IMixedRealitySourceStateHandler, IMixedRealityPointerHandler, IEventSystemHandler, MonoBehaviour

Fields

indexFingerRingRenderer

Declaration
protected Renderer indexFingerRingRenderer
Field Value
Type Description
Renderer

indexFingerRingRenderer

Declaration
protected Renderer indexFingerRingRenderer
Field Value
Type Description
Renderer

Methods

Awake()

Declaration
protected virtual void Awake()

Awake()

Declaration
protected virtual void Awake()

IsNearGrabbableObject(out Single)

Gets if the associated sphere pointer on this controller is near any grabbable objects.

Declaration
protected virtual bool IsNearGrabbableObject(out float dist)
Parameters
Type Name Description
Single dist

Out parameter gets the distance to the grabbable.
Returns
Type Description
Boolean

True if associated sphere pointer is near any grabbable objects, else false.

IsNearGrabbableObject(out Single)

Gets if the associated sphere pointer on this controller is near any grabbable objects.

Declaration
protected virtual bool IsNearGrabbableObject(out float dist)
Parameters
Type Name Description
Single dist

Out parameter gets the distance to the grabbable.
Returns
Type Description
Boolean

True if associated sphere pointer is near any grabbable objects, else false.

TryGetJoint(TrackedHandJoint, out Vector3, out Quaternion)

Tries and get's hand joints based on the current pointer.

Declaration
protected bool TryGetJoint(TrackedHandJoint joint, out Vector3 position, out Quaternion rotation)
Parameters
Type Name Description
TrackedHandJoint joint

The joint type to get.
Vector3 position

Out parameter filled with joint position, otherwise Vector3.zero
Quaternion rotation

Out parameter filled with joint rotation, otherwise Quaternion.identity
Returns
Type Description
Boolean

TryGetJoint(TrackedHandJoint, out Vector3, out Quaternion)

Tries and get's hand joints based on the current pointer.

Declaration
protected bool TryGetJoint(TrackedHandJoint joint, out Vector3 position, out Quaternion rotation)
Parameters
Type Name Description
TrackedHandJoint joint

The joint type to get.
Vector3 position

Out parameter filled with joint position, otherwise Vector3.zero
Quaternion rotation

Out parameter filled with joint rotation, otherwise Quaternion.identity
Returns
Type Description
Boolean

UpdateCursorTransform()

Override base behavior to align the cursor with the finger, else perform normal cursor transformations.

Declaration
protected override void UpdateCursorTransform()
Overrides

UpdateCursorTransform()

Override base behavior to align the cursor with the finger, else perform normal cursor transformations.

Declaration
protected override void UpdateCursorTransform()
Overrides

UpdateVisuals(Renderer, Single, Boolean)

Applies material overrides to a ring renderer.

Declaration
protected virtual void UpdateVisuals(Renderer ringRenderer, float distance, bool visible)
Parameters
Type Name Description
Renderer ringRenderer

Renderer using an MRTK/Standard material with the round corner feature enabled.
Single distance

Distance between the ring and surface.
Boolean visible

Should the ring be visible?

UpdateVisuals(Renderer, Single, Boolean)

Applies material overrides to a ring renderer.

Declaration
protected virtual void UpdateVisuals(Renderer ringRenderer, float distance, bool visible)
Parameters
Type Name Description
Renderer ringRenderer

Renderer using an MRTK/Standard material with the round corner feature enabled.
Single distance

Distance between the ring and surface.
Boolean visible

Should the ring be visible?

Implements

IEventSystemHandler
MonoBehaviour