Edit

IMixedRealityPointer Interface

  • Reference

Definition

Namespace:
Microsoft.MixedReality.Toolkit.Input
Assembly:
Microsoft.MixedReality.Toolkit.dll

Interface for handling pointers.

public interface class IMixedRealityPointer : System::Collections::IEqualityComparer
public interface IMixedRealityPointer : System.Collections.IEqualityComparer
type IMixedRealityPointer = interface
    interface IEqualityComparer
Public Interface IMixedRealityPointer
Implements IEqualityComparer
Derived
Implements
IEqualityComparer

Properties

BaseCursor

The pointer's cursor.
Controller

The pointer's current controller reference.
CursorModifier

The currently active cursor modifier.
FocusTarget

The currently focused target.
InputSourceParent

This pointer's input source parent.
IsActive

Controls whether the pointer dispatches input.
IsFocusLocked

Is the focus for this pointer currently locked?
IsInteractionEnabled

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

Specifies whether the pointer's target position (cursor) is locked to the target object when focus is locked.
PointerId

This pointer's id.
PointerName

This pointer's name.
Position

Pointer position.
PrioritizedLayerMasksOverride

The physics layers to use when performing scene queries.
Rays

The scene query rays.
Result

The scene query pointer result.
Rotation

Pointer rotation.
SceneQueryType

The type of physics scene query to use.
SphereCastRadius

The radius to use when SceneQueryType is set to Sphere or SphereColliders.

Methods

OnPostSceneQuery()

Called after performing the scene query.
OnPreCurrentPointerTargetChange()

Called during the scene query just before the current pointer target changes.
OnPreSceneQuery()

Called before performing the scene query.
Reset()

Resets pointer to initial state. After invoked pointer should be functional and ready for re-use.

Applies to