SpatialInteractionSourceState SpatialInteractionSourceState SpatialInteractionSourceState SpatialInteractionSourceState SpatialInteractionSourceState Class


Represents a snapshot of the state of a spatial interaction source (hand, motion controller, or speech) at a given time.

public : sealed class SpatialInteractionSourceState
struct winrt::Windows::UI::Input::Spatial::SpatialInteractionSourceState
public sealed class SpatialInteractionSourceState
Public NotInheritable Class SpatialInteractionSourceState
// This class does not provide a public constructor.

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)


Version history

Windows version SDK version Value added
1703 15063 ControllerProperties
1703 15063 IsGrasped
1703 15063 IsMenuPressed
1703 15063 IsSelectPressed
1703 15063 SelectPressedValue
1903 18362 TryGetHandPose


ControllerProperties ControllerProperties ControllerProperties ControllerProperties ControllerProperties

Gets state specific to motion controllers.

IsGrasped IsGrasped IsGrasped IsGrasped IsGrasped

Gets whether a motion controller is experiencing a grasp.

IsMenuPressed IsMenuPressed IsMenuPressed IsMenuPressed IsMenuPressed

Gets whether a motion controller is experiencing a Menu press.

IsPressed IsPressed IsPressed IsPressed IsPressed

Gets whether a hand or motion controller is experiencing any press.

IsSelectPressed IsSelectPressed IsSelectPressed IsSelectPressed IsSelectPressed

Gets whether a hand or motion controller is experiencing a primary Select press.

Properties Properties Properties Properties Properties

Gets advanced state of the interaction source.

SelectPressedValue SelectPressedValue SelectPressedValue SelectPressedValue SelectPressedValue

Gets the amount to which a hand or motion controller is experiencing a primary Select press, as a value between 0.0 and 1.0.

Source Source Source Source Source

Gets the interaction source that this state describes.

Timestamp Timestamp Timestamp Timestamp Timestamp

Gets the timestamp at which this state snapshot was taken.


TryGetHandPose() TryGetHandPose() TryGetHandPose() TryGetHandPose() TryGetHandPose()

Gets the poses of the user's joints for this hand.

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

Gets the available pointer poses, such as the user's head gaze, eye gaze and each motion controller's pointer pose, for the timestamp when this state snapshot was taken.

See also