com.docomostar.ui.graphics3d
クラス Fog

Object
  com.docomostar.ui.graphics3d.Object3D
      com.docomostar.ui.graphics3d.Fog

public class Fog
extends Object3D

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

フォグ効果データを保持する、フォグクラスを定義します。

setTime(int) メソッド呼び出しによって 現在時刻が変更されても、保持しているデータ内容は変化しません。

導入されたバージョン:

Star-1.0

関連項目:

数値演算に関する共通の定義

フィールドの概要

static int	EXPONENTIAL 指数を表すフォグのモードの名前です(=80)。
static int	LINEAR 線形を表すフォグのモードの名前です(=81)。

クラス com.docomostar.ui.graphics3d.Object3D から継承されたフィールド

TYPE_ACTION_TABLE, TYPE_FIGURE, TYPE_FOG, TYPE_GROUP, TYPE_GROUP_MESH, TYPE_LIGHT, TYPE_NONE, TYPE_PRIMITIVE, TYPE_TEXTURE

コンストラクタの概要

Fog()
フォグのオブジェクトを生成します。

メソッドの概要

void	setColor(int RGB) フォグの色を設定します。
void	setDensity(float density) 指数モードのフォグに密度を設定します。
void	setLinear(float near, float far) 線形モードのフォグに距離を設定します。
void	setMode(int mode) フォグのモードを設定します。

クラス com.docomostar.ui.graphics3d.Object3D から継承されたメソッド

createInstance, createInstance, dispose, getTime, getType, setTime

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

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

フィールドの詳細

EXPONENTIAL

public static final int EXPONENTIAL

指数を表すフォグのモードの名前です(=80)。

関連項目:

定数フィールド値

LINEAR

public static final int LINEAR

線形を表すフォグのモードの名前です(=81)。

関連項目:

定数フィールド値

コンストラクタの詳細

Fog

public Fog()

フォグのオブジェクトを生成します。

初期状態は以下のようになります。

• モード : LINEAR
• 密度 : 1.0
• 開始距離 : 0.0
• 終了距離 : 1.0
• 色 : 0x00000000

メソッドの詳細

setMode

public void setMode(int mode)

フォグのモードを設定します。

パラメータ:

mode - フォグのモード値を指定します。 EXPONENTIAL, LINEAR のいずれかの値なことが必要です。

例外:

UIException -
(ILLEGAL_STATE)
既に dispose() されたオブジェクトに対して呼ばれた場合に発生します。

IllegalArgumentException -
引数 mode が EXPONENTIAL, LINEAR のいずれかではない場合に発生します。

setLinear

public void setLinear(float near,
                      float far)

線形モードのフォグに距離を設定します。

以下の数式により、フォグのブレンド値が計算されます。 この計算はレンダリング時に行われます。

z は視点からの距離です。

f = (far - z) / (far - near)

この計算結果は [0,1] の範囲に丸められて利用されます。

パラメータ:

near - 開始距離を指定します。

far - 終了距離を指定します。

例外:

UIException -
(ILLEGAL_STATE)
既に dispose() されたオブジェクトに対して呼ばれた場合に発生します。

IllegalArgumentException -
引数 near, far のいずれかが Float.NaN, Float.POSITIVE_INFINITY, Float.NEGATIVE_INFINITY である場合に発生します。

IllegalArgumentException -
引数 near と引数 far が等しい場合に発生します。

setDensity

public void setDensity(float density)

指数モードのフォグに密度を設定します。

以下の数式により、フォグのブレンド値が計算されます。 この計算はレンダリング時に行われます。

z は視点からの距離、d は引数 density です。

f = e^-dz

この計算結果は [0,1] の範囲に丸められて利用されます。

パラメータ:

density - 密度を指定します。

例外:

UIException -
(ILLEGAL_STATE)
既に dispose() されたオブジェクトに対して呼ばれた場合に発生します。

IllegalArgumentException -
引数 density が負数 または Float.NaN の場合に発生します。

setColor

public void setColor(int RGB)

フォグの色を設定します。

パラメータ:

RGB - 0x00RRGGBB の形式で、フォグの色を指定します。 上位 8 ビットは無視されます。

例外:

UIException -
(ILLEGAL_STATE)
既に dispose() されたオブジェクトに対して呼ばれた場合に発生します。