SpatialInteractionSourceState Class

  • Reference

Definition

Namespace:
Windows.UI.Input.Spatial
Edit

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

public ref class SpatialInteractionSourceState sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class SpatialInteractionSourceState final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class SpatialInteractionSourceState
Public NotInheritable Class SpatialInteractionSourceState
Inheritance
Object Platform::Object IInspectable SpatialInteractionSourceState
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced in v2.0)

Remarks

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

Properties

ControllerProperties

Gets state specific to motion controllers.
IsGrasped

Gets whether an input device detects a grasp/grab action (how users take direct action on objects in order to manipulate them).
IsMenuPressed

Gets whether a motion controller is experiencing a Menu press.
IsPressed

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

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

Gets advanced state of the interaction source.
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

Gets the interaction source that this state describes.
Timestamp

Gets the timestamp at which this state snapshot was taken.

Methods

TryGetHandPose()

Gets the poses of the user's joints for this hand.
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.

Applies to

See also