SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem Class

Definition

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

public : sealed class SpatialCoordinateSystem : ISpatialCoordinateSystempublic sealed class SpatialCoordinateSystem : ISpatialCoordinateSystemPublic NotInheritable Class SpatialCoordinateSystem Implements ISpatialCoordinateSystem// 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)

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) TryGetTransformTo(SpatialCoordinateSystem) TryGetTransformTo(SpatialCoordinateSystem) TryGetTransformTo(SpatialCoordinateSystem)

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

public : IReference<Matrix4x4> TryGetTransformTo(SpatialCoordinateSystem target)public Nullable<Matrix4x4> TryGetTransformTo(SpatialCoordinateSystem target)Public Function TryGetTransformTo(target As SpatialCoordinateSystem) As Nullable( Of Matrix4x4 )// You can use this method in JavaScript.
Parameters
target
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The target coordinate system that you want to transform geometry to.

Returns
IReference<Matrix4x4> Nullable<Matrix4x4> Nullable<Matrix4x4> Nullable<Matrix4x4>

If the transformation is successful, this parameter returns the matrix that you can use to transform geometry from being represented in the source SpatialCoordinateSystem to the specified target coordinate system.

Remarks

This method will return null if the target coordinate system cannot be located relative to this one at the moment.