CompassLib
このライブラリーは、装置のコンパスに対するアクセスを提供します。 コンパスとは、装置が指し示す方向 (通常は、装置の上部から) を検出するセンサーのことです。 コンパスは、0 度から 359.99 度までの向き (0 が北です) を測定します。
レコード
Heading は、コンパス・データを示します。
- magneticHeading float
- 一瞬間の 0 度から 359.99 度までの向き。
- trueHeading float
- 北極を基準にした一瞬間の 0 度から 359.99 度までの向き。
- headingAccuracy float
- 可能性のある偏差 (度)。
- h_timestamp timestamp
- コンパスのタイム・スタンプ。
CompassOption。
コンパスを監視するためのオプション。
- frequency int
- コンパス・データを取得する間隔 (ミリ秒)。
- filter float?
- onSuccess コールバックをトリガーするために必要となる変更 (度)。 この値が設定されているときは、頻度は無視されます。
- 関数
- getCurrentHeading (onSuccess CompassSuccess in, onError CordovaErrorHandler in)
- これは、現在のコンパスを取得し、onSuccess に戻ります。
- onSuccess
- CompassSuccess の成功コールバック。
コンパス・データが渡されます。
delegate CompassSuccess(heading Heading in) end - onError
- エラー・コールバック関数。
- watchHeading (onSuccess CompassSuccess in, onError CordovaErrorHandler in, options CompassOption in) returns(String)
- これは、定期的に装置のコンパスを取得して、その都度、onSuccess コールバック関数を実行します。
これは、監視をクリアするために使用できる監視 ID を返します。
- onSuccess
- 成功コールバック。
- onError
- エラー・コールバック関数。
- options
- 監視間隔またはフィルターを識別するための CompassOption のインスタンス。
- clearWatch(watchID String in)
- これは、コンパスの監視を停止します。
- watchID
- 停止される監視の監視 ID。