SpatialInteractionDetectedEventArgs SpatialInteractionDetectedEventArgs SpatialInteractionDetectedEventArgs SpatialInteractionDetectedEventArgs Class

Definition

Provides data for the SpatialInteractionManager.InteractionDetected event.

public : sealed class SpatialInteractionDetectedEventArgs : ISpatialInteractionDetectedEventArgs, ISpatialInteractionDetectedEventArgs2public sealed class SpatialInteractionDetectedEventArgs : ISpatialInteractionDetectedEventArgs, ISpatialInteractionDetectedEventArgs2Public NotInheritable Class SpatialInteractionDetectedEventArgs Implements ISpatialInteractionDetectedEventArgs, ISpatialInteractionDetectedEventArgs2// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Properties

Interaction Interaction Interaction Interaction

Gets the detected interaction, for routing to a SpatialGestureRecognizer.

public : SpatialInteraction Interaction { get; }public SpatialInteraction Interaction { get; }Public ReadOnly Property Interaction As SpatialInteraction// You can use this property in JavaScript.

Remarks

Pass this SpatialInteraction object to the SpatialGestureRecognizer.CaptureInteraction method to route this interaction to that gesture recognizer.

InteractionSource InteractionSource InteractionSource InteractionSource

Gets the specific source associated with the detected interaction.

public : SpatialInteractionSource InteractionSource { get; }public SpatialInteractionSource InteractionSource { get; }Public ReadOnly Property InteractionSource As SpatialInteractionSource// You can use this property in JavaScript.
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

InteractionSourceKind InteractionSourceKind InteractionSourceKind InteractionSourceKind

Gets the kind of source associated with the detected interaction.

public : SpatialInteractionSourceKind InteractionSourceKind { get; }public SpatialInteractionSourceKind InteractionSourceKind { get; }Public ReadOnly Property InteractionSourceKind As SpatialInteractionSourceKind// You can use this property in JavaScript.

Methods

TryGetPointerPose(SpatialCoordinateSystem) TryGetPointerPose(SpatialCoordinateSystem) TryGetPointerPose(SpatialCoordinateSystem) TryGetPointerPose(SpatialCoordinateSystem)

Gets the available pointer poses, such as the user's head gaze and each motion controller's pointer pose, for use in routing this interaction to a SpatialGestureRecognizer.

public : SpatialPointerPose TryGetPointerPose(SpatialCoordinateSystem coordinateSystem)public SpatialPointerPose TryGetPointerPose(SpatialCoordinateSystem coordinateSystem)Public Function TryGetPointerPose(coordinateSystem As SpatialCoordinateSystem) As SpatialPointerPose// You can use this method in JavaScript.
Parameters
coordinateSystem
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The coordinate system in which to express the pointer poses.

Returns

Remarks

When targeting a spatial interaction, such as a hand gesture, motion controller press or voice interaction, apps should choose a pointing ray available from the interaction's SpatialPointerPose, based on the nature of the interaction's SpatialInteractionSource:

  • If the interaction source does not support pointing (IsPointingSupported is false), the app should target based on the user's gaze, available through the Head property.
  • If the interaction source does support pointing (IsPointingSupported is true), the app may instead target based on the source's pointer pose, available through the TryGetInteractionSourcePose method.

The app should then intersect the chosen pointing ray with its own holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with.

Once an interaction has started, relative motions of the hand or controller may be used to control the gesture, as with the Manipulation or Navigation gesture.

This method will return null if the specified coordinate system cannot be located at the moment.