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

コンパスが新しいセンサーの読み取り値を報告するたびに発生します。

適用対象

こちらもご覧ください