com.nttdocomo.device.location
クラス AccelerationData

Object
  com.nttdocomo.device.location.AccelerationData

public class AccelerationData

extends Object

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

加速度センサ機能の加速度取得機能により取得したデータを定義します。

X/Y/Z軸方向の加速度値を提供します。 加速度の単位は、mg(ミリジー) (g=9.8m/s²) です。
X/Y/Z軸は、Y軸を基準に以下のように定義されます。

• Y軸は、メインスクリーンを含む平面上にあり、 メインスクリーンの下部から上部へ向かう直線です。
• X軸は、Y軸と直交し、メインスクリーンを含む平面上にある、 メインスクリーンにそって左から右方向に向かう直線です。
• Z軸は、XおよびY軸と直行する直線で、 メインスクリーンの背面から前面に向かう直線です。

取得可能な方向の加速度は、実装によって異なります。 例えば2軸センサが搭載されている場合であれば、 X, Y方向の加速度が取得可能になる等です。

また、端末の傾きをロール角、ピッチ角として取得できます。

• メインスクリーンを含む平面上に有り、 メインスクリーンの下部から上部へ向かう直線を考えます。 ロール角は、その直線を軸としてどれだけ回転しているかを表します。 メインスクリーンの下部から見た時の、時計回り方向を+方向、 反時計回り方向を-方向と規定します。
  次に、上記のロール角の回転軸と直交しており、 メインスクリーンを含む平面上にある直線を考えます。 その直線と水平面が平行な状態を、ロール角 0 度と規定します。
• メインスクリーンを含む平面上に有り、 ロール角の回転軸と直交した直線を考えます。 ピッチ角は、その直線を軸としてどれだけ回転しているかを表します。 メインスクリーンの上部が上空を向く方向を+方向、 地面を向く方向を-方向と規定します。
  水平面とロール角の回転軸が平行な状態を、ピッチ角 0 度と規定します。

実装によって、傾きの取得をサポートしないことがあります。 また、取得できる傾きの幅が異なります。 [-180度, 180度) または [-90度, 90度]です。

実装によっては、メインスクリーンの縦横の向きを取得できます。
メインスクリーンが地面と直交しており、 メインスクリーンの上部が上空方向にある場合、 すなわち、加速度(X, Y, Z)が(0, -1g, 0)である状態を基準とし、 加速度のZ軸を軸として、メインスクリーンに向かって端末を 時計回り方向に回転した角度で表します。 0度、90度、180度、270度のいずれかの値です。

このオブジェクトの内部には、計測データを配列として保持しています。 このクラスのメソッドにおいて、戻り値として配列を返す場合、 オブジェクト内部で保持する配列への参照を返します。

計測データの各値を更新するためには、AccelerationSensor.getCurrentData(), AccelerationSensor.getData(), AccelerationSensor.peekLatestData() を呼び出す必要があります。

このオブジェクトの内部で保持している配列の長さは、 size() で取得できる計測データ数より長い場合があります。 その場合、配列の ( size() - 1 ) 番目までの要素には有効な計測値が格納されていますが、 size() 番目以降の要素には不定値が格納されています。 なお、 size() で取得できる計測データ数が 0 の場合は、 配列の全要素に不定値が格納されています。

なお、このクラス中の説明における、下記用語の具体的な位置は機種依存ですが、 「メインスクリーンの上部」の定義は、 電子コンパスにおける定義と同一であることが保証されています。 また、利用者が端末を自然に持った時の上下関係と、 下記定義が一致していなければなりません。

• メインスクリーンの上部
• メインスクリーンの下部

導入されたバージョン:

DoJa-5.0 (904i)

関連項目:

AccelerationSensor

メソッドの概要

int[]	getAccelerationX() X軸方向の加速度値を取得します。
int[]	getAccelerationY() Y軸方向の加速度値を取得します。
int[]	getAccelerationZ() Z軸方向の加速度値を取得します。
int[]	getPitch() 端末の傾き(ピッチ角)を取得します。
int[]	getRoll() 端末の傾き(ロール角)を取得します。
int[]	getScreenOrientation() メインスクリーンの縦横の向きを取得します。
int	size() このオブジェクトに含まれている計測データ数を取得します。

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

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

メソッドの詳細

size

public int size()

このオブジェクトに含まれている計測データ数を取得します。

このオブジェクトに計測データが含まれていない場合は0を返します。

戻り値:

計測データ数を返します。

getAccelerationX

public int[] getAccelerationX()

X軸方向の加速度値を取得します。

戻り値:

X軸方向の加速度値を返します。単位はmg(ミリジー) (g=9.8m/s2)です。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException - 実装がこの方向の加速度値をサポートしていない場合に発生します。

getAccelerationY

public int[] getAccelerationY()

Y軸方向の加速度値を取得します。

戻り値:

Y軸方向の加速度値を返します。単位はmg(ミリジー) (g=9.8m/s2)です。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException - 実装がこの方向の加速度値をサポートしていない場合に発生します。

getAccelerationZ

public int[] getAccelerationZ()

Z軸方向の加速度値を取得します。

戻り値:

Z軸方向の加速度値を返します。単位はmg(ミリジー) (g=9.8m/s2)です。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException - 実装がこの方向の加速度値をサポートしていない場合に発生します。

getRoll

public int[] getRoll()

端末の傾き(ロール角)を取得します。

戻り値:

端末の傾き（ロール角)を返します。 取得できる傾きの幅は[-180度, 180度) または [-90度, 90度]です。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException - 実装がロール角の取得 をサポートしていない場合に発生します。

getPitch

public int[] getPitch()

端末の傾き(ピッチ角)を取得します。

戻り値:

端末の傾き（ピッチ角)を返します。 取得できる傾きの幅は[-180度, 180度) または [-90度, 90度]です。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException - 実装がピッチ角の取得 をサポートしていない場合に発生します。

getScreenOrientation

public int[] getScreenOrientation()

メインスクリーンの縦横の向きを取得します。

向きが判定できる場合、 時計回りで、0, 90, 180, 270を返します。 向きが判定できない場合、 例えば Y軸方向の加速度が 0 に近い場合、 -1 を返します。

戻り値:

メインスクリーンの縦横の向きを返します。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException - 実装がメインスクリーンの向きの取得をサポート していない場合に発生します。