Compass 类

定义

命名空间:

Windows.Devices.Sensors

表示指南针传感器。

此传感器返回一个相对于“磁北”（可能为 True North）的标题。 (后者依赖于系统功能。)

有关实现的示例，请参阅指南针示例。

public ref class Compass sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Compass final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class Compass

Public NotInheritable Class Compass

继承

Object Platform::Object IInspectable Compass

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows 要求

设备系列	Windows 10 (在 10.0.10240.0 中引入)
API contract	Windows.Foundation.UniversalApiContract (在 v1.0 中引入)

注解

传感器数据相对于设备的固定传感器坐标系提供，与显示方向无关。 对于依赖传感器数据进行输入控制或操作屏幕上元素的应用程序，开发人员必须考虑当前显示方向并适当地补偿数据。 有关传感器坐标系的详细信息，请参阅 传感器数据和显示方向。

以下示例演示使用 XAML 和 C# 生成的 UWP 应用如何使用 GetDefault 方法建立与指南针的连接。 如果未找到集成指南针，该方法将返回 null 值。

_compass = Compass.GetDefault();

以下示例演示使用 XAML 生成的 UWP 应用如何注册 ReadingChanged 事件处理程序。

private void ScenarioEnable(object sender, RoutedEventArgs e)
{
    if (_compass != null)
    {
        // Establish the report interval
        _compass.ReportInterval = _desiredReportInterval;

        Window.Current.VisibilityChanged += new WindowVisibilityChangedEventHandler(VisibilityChanged);
        _compass.ReadingChanged += new TypedEventHandler<Compass, CompassReadingChangedEventArgs>(ReadingChanged);

        ScenarioEnableButton.IsEnabled = false;
        ScenarioDisableButton.IsEnabled = true;
    }
    else
    {
        rootPage.NotifyUser("No compass found", NotifyType.StatusMessage);
    }
}

以下示例演示 ReadingChanged 事件处理程序。

async private void ReadingChanged(object sender, CompassReadingChangedEventArgs e)
{
    await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
    {
        CompassReading reading = e.Reading;
        ScenarioOutput_MagneticNorth.Text = String.Format("{0,5:0.00}", reading.HeadingMagneticNorth);
        if (reading.HeadingTrueNorth != null)
        {
            ScenarioOutput_TrueNorth.Text = String.Format("{0,5:0.00}", reading.HeadingTrueNorth);
        }
        else
        {
            ScenarioOutput_TrueNorth.Text = "No data";
        }
    });
}

版本历史记录

Windows 版本	SDK 版本	增值
1709	16299	FromIdAsync
1709	16299	GetDeviceSelector
1709	16299	MaxBatchSize
1709	16299	ReportLatency
2004	19041	ReportThreshold

属性

DeviceId	获取设备标识符。
MaxBatchSize	获取传感器可以批处理的最大事件数。
MinimumReportInterval	获取指南针支持的最小报告间隔。
ReadingTransform	获取或设置需要应用于传感器数据的转换。 要应用的转换与用于对齐传感器数据的显示方向相关联。
ReportInterval	获取或设置指南针的当前报告间隔。
ReportLatency	获取或设置传感器信息批次之间的延迟。
ReportThreshold	获取 指南针传感器的 CompassDataThreshold 。

方法

FromIdAsync(String)	从其标识符异步获取传感器。
GetCurrentReading()	获取当前指南针读数。
GetDefault()	返回默认指南针。
GetDeviceSelector()	获取设备选择器。

事件

ReadingChanged

每次指南针报告新的传感器读数时发生。

另请参阅

• 指南针示例
• 传感器数据和显示方向
• 指南针示例 (Windows 10)