jp.go.aist.dmrc.platform.beans.graphics.ThreeDGraphics
クラス PFLightMaker

java.lang.Object
  上位を拡張 jp.go.aist.dmrc.platform.beans.graphics.ThreeDGraphics.PFLightMaker
すべての実装されたインタフェース:
java.io.Serializable, PFComponent, PFXMLSerializable, PFDataCreateEventSource, PFEventSource

public class PFLightMaker
extends java.lang.Object
implements PFComponent, PFDataCreateEventSource, PFXMLSerializable

PF3DViewer用の光源を生成するコンポーネント。

このコンポーネントから以下のイベントが発生します。

関連項目:
直列化された形式

フィールドの概要
static int AMBIENT
          0: 環境光源
static int DIRECTIONAL
          1: 平行光源
static int POINT
          2: 点光源
static int SPOT
          3: スポット光源
static int VIEW_LOCALE
          1: ビュー座標
static int WORLD_LOCALE
          0: ワールド座標
 
コンストラクタの概要
PFLightMaker()
          コンストラクタ
 
メソッドの概要
 void addPFDataCreateListener(PFDataCreateListener lis)
          引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを取得する。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentPublicName()
          コンポーネント公開名を取得する.
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 PFObjectList getLight()
          光源を生成し取得する。
 java.util.Iterator getPFDataCreateListenerList()
          データ生成イベントリスナ配列を取得する。
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 void localeUpdated()
          ロケール変更に対応する。
 void makeLight()
          光源を生成し、イベント内包データ(PFLightを含むPFObjectList)とする。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void removePFDataCreateListener(PFDataCreateListener lis)
          引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。
 void setAllowPullTransfer(boolean flag)
          他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowPushTransfer(boolean flag)
          他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowRemoteInvocation(boolean flag)
          他PFからのコンポーネント連携要求に対する可否属性を設定する.
 void setColor(float r, float g, float b)
          光源色を設定する。
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントキーを設定する。
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する。
 void setComponentPublicName(java.lang.String publicName)
          コンポーネント公開名を設定する.
 void setDirection(float x, float y, float z)
          光源方向を設定する。
 void setLocaleType(int type)
          座標系を設定する。
 void setPosition(float x, float y, float z)
          光源位置を設定する。
 void setSpotAngle(float angle)
          スポットライトの角度を設定する。
 void setType(int type)
          光源の種類を設定する。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

AMBIENT

public static final int AMBIENT
0: 環境光源

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

DIRECTIONAL

public static final int DIRECTIONAL
1: 平行光源

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

POINT

public static final int POINT
2: 点光源

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

SPOT

public static final int SPOT
3: スポット光源

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

WORLD_LOCALE

public static final int WORLD_LOCALE
0: ワールド座標

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

VIEW_LOCALE

public static final int VIEW_LOCALE
1: ビュー座標

関連項目:
定数フィールド値
コンストラクタの詳細

PFLightMaker

public PFLightMaker()
コンストラクタ

メソッドの詳細

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントキーを設定する。

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - コンポーネントキー文字列

getComponentKeys

public PFMultiLocaleString getComponentKeys()
全ロケール分のコンポーネントキーを取得する。

戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。

パラメータ:
keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID

setComponentID

public void setComponentID(int id)
コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式:"Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()
コンポーネント公開名を取得する.

定義:
インタフェース PFComponent 内の getComponentPublicName
戻り値:
コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException
コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:
インタフェース PFComponent 内の setComponentPublicName
パラメータ:
publicName - 設定するコンポーネント公開名
例外:
PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()
他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowRemoteInvocation
戻り値:
コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)
他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowRemoteInvocation
パラメータ:
flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()
他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowPullTransfer
戻り値:
Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)
他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowPullTransfer
パラメータ:
flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()
他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowPushTransfer
戻り値:
Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)
他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowPushTransfer
パラメータ:
flag - Push型コンポーネント転送要求に対する可否

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

定義:
インタフェース PFComponent 内の localeUpdated

getPFDataCreateListenerList

public java.util.Iterator getPFDataCreateListenerList()
データ生成イベントリスナ配列を取得する。

定義:
インタフェース PFDataCreateEventSource 内の getPFDataCreateListenerList
戻り値:
イベントリスナイテレータ

addPFDataCreateListener

public void addPFDataCreateListener(PFDataCreateListener lis)
引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。

定義:
インタフェース PFDataCreateEventSource 内の addPFDataCreateListener
パラメータ:
lis - 追加対象イベントリスナ

removePFDataCreateListener

public void removePFDataCreateListener(PFDataCreateListener lis)
引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。

定義:
インタフェース PFDataCreateEventSource 内の removePFDataCreateListener
パラメータ:
lis - 削除対象イベントリスナ

setPosition

public void setPosition(float x,
                        float y,
                        float z)
光源位置を設定する。

パラメータ:
x - 光源位置のx座標値
y - 光源位置のy座標値
z - 光源位置のz座標値

setDirection

public void setDirection(float x,
                         float y,
                         float z)
光源方向を設定する。

パラメータ:
x - 光源方向のx軸方向成分
y - 光源方向のy軸方向成分
z - 光源方向のz軸方向成分

setColor

public void setColor(float r,
                     float g,
                     float b)
光源色を設定する。

パラメータ:
r - 光源色のRed値
g - 光源色のGreen値
b - 光源色のBlue値

setSpotAngle

public void setSpotAngle(float angle)
スポットライトの角度を設定する。

パラメータ:
angle - スポットライトの角度

setType

public void setType(int type)
光源の種類を設定する。

パラメータ:
type - 光源の種類(0:環境光源, 1:平行光源, 2:点光源, 3:スポット光源)

setLocaleType

public void setLocaleType(int type)
座標系を設定する。

パラメータ:
type - 座標系の種類(0:ワールド座標, 1:ビュー座標)

getLight

public PFObjectList getLight()
光源を生成し取得する。

戻り値:
光源(PFLightを含むPFObjectList)

makeLight

public void makeLight()
               throws PFMethodException,
                      PFRuntimeException
光源を生成し、イベント内包データ(PFLightを含むPFObjectList)とする。

例外:
PFMethodException
PFRuntimeException

readXML

public void readXML(PFXMLLoader in)
コンポーネントのXML入力.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
コンポーネントのXML出力.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
out - XML出力ユーティリティ
例外:
java.io.IOException