SpatialPointerPose SpatialPointerPose SpatialPointerPose SpatialPointerPose SpatialPointerPose Class

Definition

Represents the available spatial pointer poses, such as the user's head gaze, eye gaze and each motion controller's pointer pose, for use in targeting hand gestures, motion controller presses, and speech interactions.

public : sealed class SpatialPointerPose
struct winrt::Windows::UI::Input::Spatial::SpatialPointerPose
public sealed class SpatialPointerPose
Public NotInheritable Class SpatialPointerPose
// This class does not provide a public constructor.
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)

Remarks

The SpatialPointerPose provides the set of pointing rays available at the time represented by the Timestamp property.

When targeting a spatial interaction, such as a hand gesture, motion controller press or speech 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 head 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.

Version history

Windows version SDK version Value added
1703 15063 TryGetInteractionSourcePose
1903 18362 Eyes
1903 18362 IsHeadCapturedBySystem

Properties

Eyes Eyes Eyes Eyes Eyes

Gets the user's eye gaze for this timestamp.

Head Head Head Head Head

Gets the user's head gaze for this timestamp.

IsHeadCapturedBySystem IsHeadCapturedBySystem IsHeadCapturedBySystem IsHeadCapturedBySystem IsHeadCapturedBySystem

Gets whether the user's head gaze is being captured by system UI at the moment (preventing gaze-driven presses from being delivered to the view associated with this SpatialPointerPose ).

Timestamp Timestamp Timestamp Timestamp Timestamp

Gets the timestamp when the pointing rays are determined.

Methods

TryGetAtTimestamp(SpatialCoordinateSystem, PerceptionTimestamp) TryGetAtTimestamp(SpatialCoordinateSystem, PerceptionTimestamp) TryGetAtTimestamp(SpatialCoordinateSystem, PerceptionTimestamp) TryGetAtTimestamp(SpatialCoordinateSystem, PerceptionTimestamp) TryGetAtTimestamp(SpatialCoordinateSystem, PerceptionTimestamp)

Gets the head gaze and motion controller pointer poses for the specified timestamp.

TryGetInteractionSourcePose(SpatialInteractionSource) TryGetInteractionSourcePose(SpatialInteractionSource) TryGetInteractionSourcePose(SpatialInteractionSource) TryGetInteractionSourcePose(SpatialInteractionSource) TryGetInteractionSourcePose(SpatialInteractionSource)

Gets the pointer pose for a particular spatial interaction source, such as a motion controller, at a given timestamp.