com.docomostar.device.location
クラス AccelerationSensor

Object
  上位を拡張 com.docomostar.device.location.AccelerationSensor

public class AccelerationSensor
extends Object
 [iアプリオプションAPI]

加速度センサ機能を提供します。

加速度センサ機能は、基本機能として加速度を取得する機能を提供します。 加速度センサ機能が計測できる加速度そのもの、 およびその値を変換して得られる値(ロール角、ピッチ角)を取得できます。 また、メインスクリーンの縦横の向き等を取得できます。 ただし、実装によって取得可能な値は異なります。 計測データの種類については、 AccelerationDataクラスを参照してください。
加速度取得機能では、現在の加速度値を得るワンショット計測と、 周期的に連続して加速度値を得る周期計測を提供します。 周期計測では、実装内部の計測データ蓄積バッファに計測結果を蓄積します。 アプリケーションは、周期計測中あるいは計測後に蓄積バッファ内の計測結果を取得できます。

計測結果は、AccelerationData オブジェクトを介して取得できます。 AccelerationData オブジェクトは ワンショット計測用、 周期計測(全データ)用、 周期計測(最新データ)用に各 1 つずつ生成され、 計測結果は各オブジェクトが保持する配列に格納されます。

加速度センサ機能は、オプション機能としてイベント検知機能を提供します。 イベント検知機能は、 メインスクリーンの縦横の向きの変化、ダブルタップした位置等を検知し、イベントとして通知します。 実装によってはイベント検知機能をサポートしないことがあります。 また、実装によって検知可能なイベントは異なります。

周期計測中またはイベント検知中にワンショット計測周期計測開始イベント検知開始 を行うと例外が発生します。

加速度取得機能により 「ロール(roll)角」 「ピッチ(pitch)角」を取得することができますが、 「ヨー(yaw)角」に相当する値を知る必要がある場合は、 電子コンパス機能における方位角の値を利用して下さい。

実装によっては、加速度センサ機能をサポートしていない場合があります。
また、電子コンパス機能のサポート有無と、 加速度センサ機能のサポート有無は独立しており、 任意のサポート有無の組み合わせが有り得ることに注意して下さい。

[Star-1.3 以降]
端末によっては、デバイス ID を指定して加速度センサのインスタンスを取得できます。
デバイス ID が 0 以外の加速度センサは、常にアクセス可能とは限りません。 加速度センサにアクセスできるかどうかを確認するには isAccessible() メソッドを利用してください。 また、アクセス可否状態の変更を検知するには startEventDetection(EVENT_ACCESSIBILITY) メソッドを利用してください。
加速度センサのアクセス可否の状態と、周期計測の開始・停止状態は独立しています。 よって、加速度センサのアクセス可否状態が変更された場合でも、周期計測の開始・停止状態は変更されません。
加速度センサにアクセスできない場合、周期計測中でも測定結果蓄積バッファに結果は蓄積されません。 加速度センサにアクセスできるようになると、自動的に測定結果蓄積バッファへの結果の蓄積が再開されます。

[Star-1.5 以降]
周期計測中に Canvas の座標系を変更する(Canvas2 を使用する)場合、 蓄積バッファ内のデータの一貫性が保証されなくなるため、 Star アプリが期待する計測結果が得られない場合があります。 Star アプリが期待する結果を得るためには、 一度周期計測を停止した上で蓄積バッファからデータを取得してから、 Canvas の座標系を変更し、周期計測を再開して下さい。 なお、getAccelerationSensor(int) によるデバイス ID の指定をサポートしている端末において、 デバイス ID が 0 以外の加速度センサによる計測が Canvas の座標系の変更の影響を受けるかどうかは機種依存です。

導入されたバージョン:
Star-1.0

フィールドの概要
static int ACCELERATION_X
          計測データの種類を示す値で、X軸方向の加速度を表します(=1)。
static int ACCELERATION_Y
          計測データの種類を示す値で、Y軸方向の加速度を表します(=2)。
static int ACCELERATION_Z
          計測データの種類を示す値で、Z軸方向の加速度を表します(=3)。
static int ACCESSIBLE_FALSE
          加速度センサにアクセスが不可能になったことを表します(=1)。
static int ACCESSIBLE_TRUE
          加速度センサにアクセスが可能になったことを表します(=0)。
static int DOUBLE_TAP_BACK
          ダブルタップ時の位置を示す値で、端末の背面のダブルタップを表します(=3)。
static int DOUBLE_TAP_FRONT
          ダブルタップ時の位置を示す値で、端末のLCD面のダブルタップを表します(=2)。
static int DOUBLE_TAP_LEFT
          ダブルタップ時の位置を示す値で、端末の左側面のダブルタップを表します(=0)。
static int DOUBLE_TAP_RIGHT
          ダブルタップ時の位置を示す値で、端末の右側面のダブルタップを表します(=1)。
static int EVENT_ACCESSIBILITY
          イベント検知機能が検知可能なイベントの種類で、 加速度センサのアクセス可否が変更されたことを表します(=4)。
static int EVENT_DOUBLE_TAP
          イベント検知機能が検知可能なイベントの種類で、 ダブルタップ操作を表します(=2)。
static int EVENT_SCREEN_ORIENTATION
          イベント検知機能が検知可能なイベントの種類で、 メインスクリーンの縦横の向きの変化を表します(=1)。
static int PITCH
          計測データの種類を示す値で、端末の傾き(ピッチ角)を表します(=5)。
static int ROLL
          計測データの種類を示す値で、端末の傾き(ロール角)を表します(=4)。
static int SCREEN_ORIENTATION
          計測データの種類を示す値で、メインスクリーンの縦横の向きを表します(=6)。
 
メソッドの概要
 void disposeData()
          周期計測用の蓄積バッファをクリアします。
static AccelerationSensor getAccelerationSensor()
          加速度センサ機能のインスタンスを返します。
static AccelerationSensor getAccelerationSensor(int id)
          使用するデバイスを指定して、加速度センサ機能のインスタンスを返します。
 int[] getAvailableData()
          実装がサポートしている計測データの種類を取得します。
 int[] getAvailableEvent()
          イベント検知機能 がサポートする検知イベントを返します。
 AccelerationData getCurrentData()
          現在の加速度を計測し、結果を取得します(ワンショット計測)。
 AccelerationData getData()
          周期計測用の蓄積データバッファから計測結果を取得します。
 int getDataSize()
          周期計測用の蓄積データバッファに蓄積されているデータ数を取得します。
 int getIntervalResolution()
          周期計測の計測間隔の解像度を取得します。
 int getMaxDataSize()
          周期計測において実装内部で蓄積可能な最大データ数を取得します。
 int getMaxDataValue(int type)
          計測データの最大値を取得します。
 int getMinDataValue(int type)
          計測データの最小値を取得します。
 boolean isAccessible()
           加速度センサにアクセスできるかどうかを判定します。
 AccelerationData peekLatestData()
          周期計測用の蓄積データバッファから最新の計測値を1つ取得します。
 void setEventListener(AccelerationEventListener listener)
          イベント検知機能で使用するイベントリスナを設定します。
 void start(int interval)
          周期計測を開始します。
 void startEventDetection(int event)
          加速度センサ機能にイベント検知を依頼します。
 void stop()
          周期計測を停止します。
 void stopEventDetection()
          加速度センサ機能によるイベント検知を停止します。
 
クラス Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

ACCELERATION_X

public static final int ACCELERATION_X
計測データの種類を示す値で、X軸方向の加速度を表します(=1)。

関連項目:
定数フィールド値

ACCELERATION_Y

public static final int ACCELERATION_Y
計測データの種類を示す値で、Y軸方向の加速度を表します(=2)。

関連項目:
定数フィールド値

ACCELERATION_Z

public static final int ACCELERATION_Z
計測データの種類を示す値で、Z軸方向の加速度を表します(=3)。

関連項目:
定数フィールド値

ROLL

public static final int ROLL
計測データの種類を示す値で、端末の傾き(ロール角)を表します(=4)。

関連項目:
定数フィールド値

PITCH

public static final int PITCH
計測データの種類を示す値で、端末の傾き(ピッチ角)を表します(=5)。

関連項目:
定数フィールド値

SCREEN_ORIENTATION

public static final int SCREEN_ORIENTATION
計測データの種類を示す値で、メインスクリーンの縦横の向きを表します(=6)。

メインスクリーンの縦横の向きにおける計測データは以下になります。

関連項目:
定数フィールド値

EVENT_SCREEN_ORIENTATION

public static final int EVENT_SCREEN_ORIENTATION
イベント検知機能が検知可能なイベントの種類で、 メインスクリーンの縦横の向きの変化を表します(=1)。

イベントが発生した場合、 リスナのactionPerformedメソッド が呼ばれます。 このとき、第2引数にこのフィールドの値が、 第3引数にメインスクリーンの縦横の向きが渡されます。
[第3引数の説明]
メインスクリーンの縦横の向きとして渡される値については、 AccelerationData.getScreenOrientation() を参照して下さい。

関連項目:
startEventDetection(int), 螳壽焚繝輔ぅ繝シ繝ォ繝牙