com.nttdocomo.device.location
クラス Compass

Object
  com.nttdocomo.device.location.Compass

public class Compass

extends Object

[iアプリオプションAPI]

電子コンパス機能を提供します。

端末のメインスクリーンの上部が向いている方角を、 方位角として取得することができます。 「メインスクリーンの上部」の具体的な位置は機種依存ですが、 利用者が自然に端末を向けた方向の方角が取得できなければなりません。

導入されたバージョン:

DoJa-5.0 (903i)

メソッドの概要

Degree	getAzimuth() この端末が向いている方角を、方位角として取得します。
static Compass	getCompass() 電子コンパス機能のインスタンスを返します。
void	setEnabled(boolean enabled) 電子コンパス機能を有効化・無効化します。

クラス Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

getCompass

public static Compass getCompass()

電子コンパス機能のインスタンスを返します。 複数回呼び出された場合は、常に同じインスタンスを返します。

実装によっては、電子コンパス機能をサポートしていない場合があります。

戻り値:

電子コンパス機能のインスタンスを返します。

例外:

UnsupportedOperationException - 電子コンパス機能をサポートしていない場合に発生します。

getAzimuth

public Degree getAzimuth()

この端末が向いている方角を、方位角として取得します。 すなわち、北の方向から、時計回りに、 この端末の方向をなす角度を取得します。

磁北(magnetic north)からの方位角を取得することができます。

このメソッドは、電子コンパスが有効化された状態で呼び出す必要があります。 無効化された状態で呼び出された場合には例外が発生します。

戻り値:

この端末が向いている方位角を表す Degree オブジェクトを返します。 様々な要因により、 正しい方位角を測定できていない可能性がある場合でも、 常に何らかの値を返します。

例外:

IllegalStateException - 電子コンパス機能が無効化されている場合に発生します。

setEnabled

public void setEnabled(boolean enabled)

電子コンパス機能を有効化・無効化します。 getAzimuth() を呼び出す前に電子コンパス機能を有効化する必要があります。

電子コンパス機能が有効化されている間は、通常より多くの電力を消費します。

電子コンパスが既に有効化されている状態で有効化しようとしたり、 既に無効化されている状態で無効化しようとした場合には、何もしません。

電子コンパスが有効化されている状態で、このアプリケーションが終了した場合は、 電子コンパスは無効化されます。

パラメータ:

enabled - 電子コンパス機能を有効化するには true を、 無効化するには false を、それぞれ指定します。