SpatialInteractionSourceProperties SpatialInteractionSourceProperties SpatialInteractionSourceProperties SpatialInteractionSourceProperties Class

Definition

Represents advanced state of a hand or motion controller.

public : sealed class SpatialInteractionSourceProperties : ISpatialInteractionSourcePropertiespublic sealed class SpatialInteractionSourceProperties : ISpatialInteractionSourcePropertiesPublic NotInheritable Class SpatialInteractionSourceProperties Implements ISpatialInteractionSourceProperties// 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

SourceLossRisk SourceLossRisk SourceLossRisk SourceLossRisk

Gets the risk that detection of a hand or motion controller will be lost as a value from 0.0 to 1.0.

public : double SourceLossRisk { get; }public double SourceLossRisk { get; }Public ReadOnly Property SourceLossRisk As double// You can use this property in JavaScript.
Value
double double double double

The source loss risk.

Remarks

As the value nears 1.0, you should suggest that the user moves this source in the direction indicated by TryGetSourceLossMitigationDirection.

Methods

TryGetLocation(SpatialCoordinateSystem) TryGetLocation(SpatialCoordinateSystem) TryGetLocation(SpatialCoordinateSystem) TryGetLocation(SpatialCoordinateSystem)

Get the position, orientation and velocity of the hand or motion controller, expressed in the specified coordinate system.

public : SpatialInteractionSourceLocation TryGetLocation(SpatialCoordinateSystem coordinateSystem)public SpatialInteractionSourceLocation TryGetLocation(SpatialCoordinateSystem coordinateSystem)Public Function TryGetLocation(coordinateSystem As SpatialCoordinateSystem) As SpatialInteractionSourceLocation// You can use this method in JavaScript.
Parameters
coordinateSystem
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The coordinate system in which to express the hand's location.

Returns

Remarks

This method will return null if the specified coordinate system cannot be located at the moment.

TryGetSourceLossMitigationDirection(SpatialCoordinateSystem) TryGetSourceLossMitigationDirection(SpatialCoordinateSystem) TryGetSourceLossMitigationDirection(SpatialCoordinateSystem) TryGetSourceLossMitigationDirection(SpatialCoordinateSystem)

Gets the direction you should suggest that the user move their hand or motion controller if it is nearing the edge of the detection area.

public : IReference<Vector3> TryGetSourceLossMitigationDirection(SpatialCoordinateSystem coordinateSystem)public Nullable<Vector3> TryGetSourceLossMitigationDirection(SpatialCoordinateSystem coordinateSystem)Public Function TryGetSourceLossMitigationDirection(coordinateSystem As SpatialCoordinateSystem) As Nullable( Of Vector3 )// You can use this method in JavaScript.
Parameters
coordinateSystem
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The coordinate system in which to express the mitigation direction.

Returns
IReference<Vector3> Nullable<Vector3> Nullable<Vector3> Nullable<Vector3>

The mitigation direction vector, or null if there is no mitigation direction.

Remarks

This method will return null if the specified coordinate system cannot be located at the moment.