SpatialHoldStartedEventArgs SpatialHoldStartedEventArgs SpatialHoldStartedEventArgs SpatialHoldStartedEventArgs Class

Definition

Provides data for the SpatialGestureRecognizer.HoldStarted event.

public : sealed class SpatialHoldStartedEventArgs : ISpatialHoldStartedEventArgspublic sealed class SpatialHoldStartedEventArgs : ISpatialHoldStartedEventArgsPublic NotInheritable Class SpatialHoldStartedEventArgs Implements ISpatialHoldStartedEventArgs// 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

InteractionSourceKind InteractionSourceKind InteractionSourceKind InteractionSourceKind

Gets the kind of interaction source associated with this gesture.

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 pointing ray, for use in targeting this gesture.

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

This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture.

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.