Share via

SpatialCoordinateSystem Class

  • Reference

Definition

Namespace:
Windows.Perception.Spatial
Edit

Represents a coordinate system used to reason about the user's surroundings.

public ref class SpatialCoordinateSystem 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 SpatialCoordinateSystem 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 SpatialCoordinateSystem
Public NotInheritable Class SpatialCoordinateSystem
Inheritance
Object Platform::Object IInspectable SpatialCoordinateSystem
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

Methods that return spatial information, represented as points, rays, or volumes in the user's surroundings, will accept a SpatialCoordinateSystem parameter to let you decide the coordinate system in which it's most useful for those coordinates to be returned. The units for these coordinates will always be in meters.

Each SpatialCoordinateSystem has a dynamic relationship with other coordinate systems, including those that represent the user's position. At any point in time, the device may be able to locate some coordinate systems and not others. For most coordinate systems, your app must be ready to handle periods of time during which they cannot be located.

To get a SpatialCoordinateSystem based on the position of the device, use the SpatialLocator class to create either a locator-attached or stationary frame of reference.

Methods

TryGetTransformTo(SpatialCoordinateSystem)

Provides a transform matrix that you can use to convert geometry expressed in one coordinate system to another coordinate system.

Applies to

See also