SpatialHoldStartedEventArgs.TryGetPointerPose(SpatialCoordinateSystem) Method

Definition

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:
 virtual SpatialPointerPose ^ TryGetPointerPose(SpatialCoordinateSystem ^ coordinateSystem) = TryGetPointerPose;
SpatialPointerPose TryGetPointerPose(SpatialCoordinateSystem const& coordinateSystem);
public SpatialPointerPose TryGetPointerPose(SpatialCoordinateSystem coordinateSystem);
function tryGetPointerPose(coordinateSystem)
Public Function TryGetPointerPose (coordinateSystem As SpatialCoordinateSystem) As SpatialPointerPose

Parameters

coordinateSystem
SpatialCoordinateSystem

The coordinate system in which to express the pointer poses.

Returns

SpatialPointerPose

The pointer poses.

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.

Applies to