com.nttdocomo.ui.sound3d
クラス CartesianPosition

Object
  com.nttdocomo.ui.sound3d.CartesianPosition

すべての実装インタフェース:

Audio3DLocalization, SoundPosition

public class CartesianPosition

extends Object

implements SoundPosition, Audio3DLocalization

デカルト座標でリスナ(聴者)と仮想音源の位置関係を指定するオブジェクトを定義します。 このクラスでは、リスナの位置と向きおよび仮想音源の位置をデカルト座標で指定することによって、 リスナと仮想音源との位置関係を表します。

デカルト座標の各成分は float で指定しますが、 Vector3D と同様にシステム内部で整数演算に変換されて処理されます。

このオブジェクトに設定された座標などのパラメータは、 このオブジェクトが Audio3D.setLocalization(com.nttdocomo.ui.Audio3DLocalization) メソッドに渡された時点で参照され、 ネイティブの 3D サウンドの制御のエンジンに渡されます。

導入されたバージョン:

DoJa-4.0 (901i)

関連項目:

CartesianListener

コンストラクタの概要

CartesianPosition(CartesianListener listener)
デカルト座標で仮想音源の位置を指定するオブジェクトを生成します。

CartesianPosition(CartesianListener listener, float coordinateFactor)
デカルト座標で仮想音源の位置を指定するオブジェクトを生成します。

メソッドの概要

float	getCoordinateFactor() 座標変換係数を取得します。
CartesianListener	getListener() リスナの位置を表すオブジェクトを取得します。
Vector3D	getPosition() 仮想音源の位置を取得します。
Vector3D	getVelocity() [iアプリオプションAPI] 仮想音源の移動方向と速度を取得します。
static void	setDefaultCoordinateFactor(float coordinateFactor) 座標変換係数のデフォルト値を設定します。
void	setPosition(Vector3D vector) 仮想音源の位置を設定します。
void	setVelocity(Vector3D vector) [iアプリオプションAPI] 仮想音源の移動方向と速度を指定します。

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

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

コンストラクタの詳細

CartesianPosition

public CartesianPosition(CartesianListener listener)

デカルト座標で仮想音源の位置を指定するオブジェクトを生成します。 CartesianPosition(CartesianListener, float) コンストラクタの座標変換係数に setDefaultCoordinateFactor(float) メソッドで指定されたデフォルト値を指定して呼び出すのと同等です。

パラメータ:

listener - リスナの位置を表すオブジェクトを指定します。

例外:

NullPointerException - 引数 listener に null が指定された場合に発生します。

CartesianPosition

public CartesianPosition(CartesianListener listener,
                         float coordinateFactor)

デカルト座標で仮想音源の位置を指定するオブジェクトを生成します。

仮想音源の位置はこのオブジェクトに設定しますが、 リスナの位置と向きはコンストラクタで引数に指定した CartesianListener オブジェクトに設定します。 それらのオブジェクトに設定された位置や速度に座標変換係数をかけた値が位置や速度として使用されます。

デフォルトでは、各パラメータは以下のように設定されています。

• 仮想音源の位置は、座標系の原点に設定されます。 すなわち、(0.0f, 0.0f, 0.0f) が設定されます。
• [DoJa-5.0 (903i) 以降] 仮想音源の移動方向と速度は、null に設定されます。

パラメータ:

listener - リスナの位置を表すオブジェクトを指定します。

coordinateFactor - 座標変換係数を指定します。

例外:

NullPointerException - 引数 listener に null が指定された場合に発生します。

IllegalArgumentException - 引数 coordinateFactor に±∞やNaNが指定された場合、 または 0.0f 以下の値が指定された場合に発生します。

メソッドの詳細

getListener

public CartesianListener getListener()

リスナの位置を表すオブジェクトを取得します。 常にコンストラクタの引数に指定されたオブジェクトを返します。

戻り値:

リスナの位置を表すオブジェクトを返します。

setDefaultCoordinateFactor

public static void setDefaultCoordinateFactor(float coordinateFactor)

座標変換係数のデフォルト値を設定します。 このクラスのオブジェクトを生成する際に座標変換係数のデフォルト値として使用されます。 初期状態ではデフォルト値として 1.0f が設定されています。

パラメータ:

coordinateFactor - 座標変換係数のデフォルト値を指定します。

例外:

IllegalArgumentException - 引数 coordinateFactor に±∞やNaNが指定された場合、 または 0.0f 以下の値が指定された場合に発生します。

getCoordinateFactor

public float getCoordinateFactor()

座標変換係数を取得します。

戻り値:

座標変換係数を返します。

setPosition

public void setPosition(Vector3D vector)

仮想音源の位置を設定します。 引数で指定されたベクトルオブジェクトの参照をそのまま保持します。

このメソッドで指定した位置に座標変換係数をかけた値が実際の位置として使用されます。

パラメータ:

vector - 仮想音源の位置を表すベクトルを指定します。

例外:

NullPointerException - 引数 vector に null が指定された場合に発生します。

getPosition

public Vector3D getPosition()

仮想音源の位置を取得します。 setPosition(Vector3D) メソッドで指定されたベクトルオブジェクトの参照をそのまま返します (setPosition(Vector3D) メソッドが呼び出されていない場合は、 コンストラクタで内部的に生成されたベクトルオブジェクトの参照を返します)。

戻り値:

仮想音源の位置を表すベクトルを返します。

setVelocity

public void setVelocity(Vector3D vector) [iアプリオプションAPI]

仮想音源の移動方向と速度を指定します。 仮想音源の移動方向と速度はドップラー効果の計算のためにのみ使用され、 仮想音源の位置には影響しません。

このメソッドで指定した速度に座標変換係数をかけた値が実際の速度として使用されます。

[DoJa-4.0 (901i) 以降]
端末によってはサポートされない場合があります。 サポートされない場合、本メソッドの呼び出しは無視されます。 例外は発生しません。

[DoJa-5.0 (903i) 以降]
デフォルトでは null が指定されたのと同じ状態になっています。

パラメータ:

vector - 仮想音源の移動方向と速度を表すベクトルを指定します。 引数に null を指定した場合は零ベクトルが指定されたものとみなされます。

getVelocity

public Vector3D getVelocity() [iアプリオプションAPI]

仮想音源の移動方向と速度を取得します。 setVelocity(Vector3D) メソッドで null が設定された場合は、 このメソッドは null を返します。

[DoJa-4.0 (901i) 以降]
端末によってはサポートされない場合があります。 サポートされない場合は、 null を返します。

戻り値:

仮想音源の移動方向と速度を表すベクトルを返します。