[前へ] [目次へ] [次へ]

PBC_Method　(script/fgs/system_multipart.fges)


このクラスはメソッドパーティクルの評価を行うクラスです。


●継承/注入

   このクラスは継承/注入をしていません。

●インターフェイスとインターフェイスメソッド

   このクラスはインターフェイスの実装宣言をしていません。

●クラスメソッド

   このクラスはクラスメソッドを持っていません。

●クラスメンバメソッド

名前概要
public比較・判定メソッドconst IsReadyパーティクルを開始可能か判定します
public設定メソッド Setupメソッドパーティクルを設定します
public設定メソッド SetupCメソッドパーティクルを設定します
public操作メソッド Updateパーティクルを更新し、基本パラメータを取得します
public操作メソッド UpdateExパーティクルを更新し、拡張パラメータを含めて取得します
public操作メソッド Haltパーティクルの表示中止を通知します

●クラス共有変数

   このクラスはクラス共有変数を持っていません。

●インスタンス変数

名前概要
readable t経過時間
readable update_handler更新ハンドラ
readable halt_handler中止ハンドラ
readable argハンドラへの引数オブジェクト



PBC_Method::IsReady

public Bool IsReady()const

   このオブジェクトの開始準備ができているか判定します。
   このクラスでは更新ハンドラが設定されていれば開始可能とみなされます。

戻り値：このオブジェクトの開始準備ができていれば真を返します。

先頭へ

PBC_Method::Setup

public void Setup(editable Any? host_obj,
             FGESMethod update_handler,editable Any? arg, FGESMethod? halt_handler=NULL)

   メソッドパーティクルの内容を設定します。
   このメソッドと SetupC の違いは host_obj の編集可能属性だけです。

   update_handler はパーティクルの更新処理を行うメソッドを指定します。
   このメソッドが偽を返すとパーティクル処理が完了したとみなされ、
   パーティクルオブジェクトが削除されます。
   このメソッドは拡張パラメータを使用しない場合は以下の形である必要があります。
      Bool( Integer t,editable Any? arg,
                  editable Integer x,editable Integer y,editable Integer a)

            戻り値：パーティクルの表示と更新を継続する場合は真を返します。
            
            Integer t ：パーティクル開始からの経過時間。
            editable Any? arg ：設定した引数オブジェクト。
            editable Integer x ：[出力]パーティクルの表示X座標を出力するオブジェクト。
            editable Integer y ：[出力]パーティクルの表示Y座標を出力するオブジェクト。
            editable Integer a ：[出力]パーティクルの透過度を出力するオブジェクト。

   このメソッドは拡張パラメータを使用する場合は以下の形である必要があります。
      Bool( Integer t,editable Any? arg,
                  editable Integer x,editable Integer y,editable Integer a,
                  editable Float angle,editable Float h_mag,editable Float v_mag,
                  editable Integer tone_color,editable Integer tone_rpow,
                  editable Integer tone_gpow,editable Integer tone_bpow)

            戻り値：パーティクルの表示と更新を継続する場合は真を返します。
            
            Integer t ：パーティクル開始からの経過時間。
            editable Any? arg ：設定した引数オブジェクト。
            editable Integer x ：[出力]パーティクルの表示X座標を出力するオブジェクト。
            editable Integer y ：[出力]パーティクルの表示Y座標を出力するオブジェクト。
            editable Integer a ：[出力]パーティクルの透過度を出力するオブジェクト。
            editable Float angle ：[出力]パーティクルの回転角度(度単位)を出力するオブジェクト。
            editable Float h_mag ：[出力]パーティクルの横軸拡大率を出力するオブジェクト。
            editable Float v_mag ：[出力]パーティクルの縦軸拡大率を出力するオブジェクト。
            editable Integer tone_color ：[出力]パーティクルの色変換の色を出力するオブジェクト。
            editable Integer tone_rpow ：[出力]パーティクルの色変換の赤強度を出力するオブジェクト。
            editable Integer tone_gpow ：[出力]パーティクルの色変換の緑強度を出力するオブジェクト。
            editable Integer tone_bpow ：[出力]パーティクルの色変換の青強度を出力するオブジェクト。

   halt_handler はパーティクルの中止処理を行うメソッドを指定します。
   このメソッドはパーティクルの中止通知が行われた時に呼び出されます。
   この引数に空参照を指定した場合は中止時には何も呼び出されません。
   このメソッドは以下の形である必要があります。
      void(editable Any? arg)

            editable Any? arg ：設定した引数オブジェクト。

editable Any? host_obj ：設定するメソッドのホストオブジェクト。
FGESMethod update_handler ：更新処理で呼び出すメソッドオブジェクト。
editable Any? arg ： update_handler や halt_handler の arg に渡すオブジェクト。
FGESMethod? halt_handler=NULL ：中止時に呼び出すメソッドオブジェクト。
      空参照を指定した場合は中止時には何も呼び出しません。

先頭へ

PBC_Method::SetupC

public void SetupC( Any? host_obj,
             FGESMethod update_handler,editable Any? arg, FGESMethod? halt_handler=NULL)

   メソッドパーティクルの内容を設定します。
   このメソッドと Setup の違いは host_obj の編集可能属性だけです。

   update_handler はパーティクルの更新処理を行うメソッドを指定します。
   このメソッドが偽を返すとパーティクル処理が完了したとみなされ、
   パーティクルオブジェクトが削除されます。
   このメソッドは拡張パラメータを使用しない場合は以下の形である必要があります。
      Bool( Integer t,editable Any? arg,
                  editable Integer x,editable Integer y,editable Integer a)const

            戻り値：パーティクルの表示と更新を継続する場合は真を返します。
            
            Integer t ：パーティクル開始からの経過時間。
            editable Any? arg ：設定した引数オブジェクト。
            editable Integer x ：[出力]パーティクルの表示X座標を出力するオブジェクト。
            editable Integer y ：[出力]パーティクルの表示Y座標を出力するオブジェクト。
            editable Integer a ：[出力]パーティクルの透過度を出力するオブジェクト。

   このメソッドは拡張パラメータを使用する場合は以下の形である必要があります。
      Bool( Integer t,editable Any? arg,
                  editable Integer x,editable Integer y,editable Integer a,
                  editable Float angle,editable Float h_mag,editable Float v_mag,
                  editable Integer tone_color,editable Integer tone_rpow,
                  editable Integer tone_gpow,editable Integer tone_bpow)const

            戻り値：パーティクルの表示と更新を継続する場合は真を返します。
            
            Integer t ：パーティクル開始からの経過時間。
            editable Any? arg ：設定した引数オブジェクト。
            editable Integer x ：[出力]パーティクルの表示X座標を出力するオブジェクト。
            editable Integer y ：[出力]パーティクルの表示Y座標を出力するオブジェクト。
            editable Integer a ：[出力]パーティクルの透過度を出力するオブジェクト。
            editable Float angle ：[出力]パーティクルの回転角度(度単位)を出力するオブジェクト。
            editable Float h_mag ：[出力]パーティクルの横軸拡大率を出力するオブジェクト。
            editable Float v_mag ：[出力]パーティクルの縦軸拡大率を出力するオブジェクト。
            editable Integer tone_color ：[出力]パーティクルの色変換の色を出力するオブジェクト。
            editable Integer tone_rpow ：[出力]パーティクルの色変換の赤強度を出力するオブジェクト。
            editable Integer tone_gpow ：[出力]パーティクルの色変換の緑強度を出力するオブジェクト。
            editable Integer tone_bpow ：[出力]パーティクルの色変換の青強度を出力するオブジェクト。

   halt_handler はパーティクルの中止処理を行うメソッドを指定します。
   このメソッドはパーティクルの中止通知が行われた時に呼び出されます。
   この引数に空参照を指定した場合は中止時には何も呼び出されません。
   このメソッドは以下の形である必要があります。
      void(editable Any? arg)const

            editable Any? arg ：設定した引数オブジェクト。

editable Any? host_obj ：設定するメソッドのホストオブジェクト。
FGESMethod update_handler ：更新処理で呼び出すメソッドオブジェクト。
editable Any? arg ： update_handler や halt_handler の arg に渡すオブジェクト。
FGESMethod? halt_handler=NULL ：中止時に呼び出すメソッドオブジェクト。
      空参照を指定した場合は中止時には何も呼び出しません。

先頭へ

PBC_Method::Update

public Bool Update(editable Integer x,editable Integer y,editable Integer a)

   パーティクルの状態を1フレーム分更新し、新しい状態を返します。
   このメソッドは基本パラメータのみを返します。
   
戻り値：パーティクルの表示と更新を継続する場合は真を返します。

editable Integer x ：[出力]パーティクルの表示X座標を出力するオブジェクト。
editable Integer y ：[出力]パーティクルの表示Y座標を出力するオブジェクト。
editable Integer a ：[出力]パーティクルの透過度を出力するオブジェクト。

先頭へ

PBC_Method::UpdateEx

public Bool UpdateEx(editable Integer x,editable Integer y,editable Integer a,
            editable Float angle,editable Float h_mag,editable Float v_mag,
            editable Integer tone_color,editable Integer tone_rpow,
            editable Integer tone_gpow,editable Integer tone_bpow)

   パーティクルの状態を1フレーム分更新し、新しい状態を返します。
   このメソッドは基本パラメータと拡張パラメータ両方を返します。
   
戻り値：パーティクルの表示と更新を継続する場合は真を返します。

editable Integer x ：[出力]パーティクルの表示X座標を出力するオブジェクト。
editable Integer y ：[出力]パーティクルの表示Y座標を出力するオブジェクト。
editable Integer a ：[出力]パーティクルの透過度を出力するオブジェクト。
editable Float angle ：[出力]パーティクルの回転角度(度単位)を出力するオブジェクト。
editable Float h_mag ：[出力]パーティクルの横軸拡大率を出力するオブジェクト。
editable Float v_mag ：[出力]パーティクルの縦軸拡大率を出力するオブジェクト。
editable Integer tone_color ：[出力]パーティクルの色変換の色を出力するオブジェクト。
editable Integer tone_rpow ：[出力]パーティクルの色変換の赤強度を出力するオブジェクト。
editable Integer tone_gpow ：[出力]パーティクルの色変換の緑強度を出力するオブジェクト。
editable Integer tone_bpow ：[出力]パーティクルの色変換の青強度を出力するオブジェクト。

先頭へ

PBC_Method::Halt

public void Halt()

   このオブジェクトに中止ハンドラが設定されている場合、中止ハンドラを呼び出します。

先頭へ

PBC_Method::t

readable Integer t

   パーティクルが開始してからの更新回数。
   Update または UpdateEx が呼び出される度に1増えます。

先頭へ

PBC_Method::update_handler

readable BoundMethod update_handler

   パーティクルを更新するためのハンドラ。

先頭へ

PBC_Method::halt_handler

readable BoundMethod halt_handler

   パーティクルを中止する時に通知するためのハンドラ。

先頭へ

PBC_Method::arg

readable Pointer arg

   ハンドラに渡す引数オブジェクト。

先頭へ

[前へ] [目次へ] [次へ]

最終更新 2023/02/01