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

IParticle　(script/fgs/system_multipart.fges)


このインターフェイスはパーティクルを制御するインターフェイスです。
このインターフェイスは基本的に IParticleHost インターフェイスを持つクラスを通じて利用します。

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

名前概要
比較・判定メソッドconst IsReadyパーティクルを開始可能か判定します
取得メソッドconst GetPriorityパーティクルの優先度を取得します
取得メソッドconst HasExParamsパーティクルが拡張パラメータを持つか取得します
設定メソッド SetDrawTypeパーティクルの描画タイプを設定します
取得メソッド GetDRパーティクルを描画するDRを取得します
取得メソッドconst GetDrawModeパーティクルの描画方法を取得します
操作メソッド Haltパーティクルの表示中止を通知します
取得メソッド GetDefaultSizeパーティクルの基本描画サイズを取得します
操作メソッド Updateパーティクルを更新し、基本パラメータを取得します
操作メソッド UpdateExパーティクルを更新し、拡張パラメータを含めて取得します




IParticle@@IsReady

Bool IsReady()const

   パーティクルを開始できる状態になっているか判定します。
   このメソッドが真を返すまではパーティクルは表示されず、更新も行われません。
   
   ただし、開始準備が出来ていなくても Halt は呼ばれる可能性があります。

戻り値：パーティクルを開始できる状態になっていれば真を返します。

先頭へ

IParticle@@GetPriority

Integer GetPriority()const

   パーティクルの優先度を返します。
   パーティクルの優先度は処理落ち検出時に消去するパーティクルの選択に使われます。
   有効な値は0〜5で、大きい程最後まで残されます。
   また、優先度5のパーティクルは処理落ち検出時でも消去対象になりません。

戻り値：パーティクルの優先度を0〜5で返します。

先頭へ

IParticle@@HasExParams

Bool HasExParams()const

   パーティクルが拡張パラメータを持つか取得します。
   拡張パラメータは「回転角度」「拡大率」「色変換」の3つで、
   パーティクルの表示にこれらが必要な場合は真を返します。

戻り値：パーティクルが拡張パラメータを持つ場合真を返します。

先頭へ

IParticle@@SetDrawType

void SetDrawType( Bool split_mode)

   パーティクルホストがパーティクル描画を扱う方法を設定します。
   split_mode が真の場合はパーティクルDRの描画先は一時領域です。
   split_mode が偽の場合はパーティクルDRの描画先は最終描画領域です。

   このメソッドはパーティクルホストが呼び出します。
   それ以外から呼び出すことは避けてください。

Bool split_mode ：パーティクルの描画先。本文参照。

先頭へ

IParticle@@GetDR

INativeDrawResource@ GetDR()

   パーティクルを描画するのに使用するDRを取得します。
   パーティクルホストはこのDRを使用してパーティクルを描画します。

戻り値：パーティクルを描画するDRの参照を返します。

先頭へ

IParticle@@GetDrawMode

Integer GetDrawMode()const

   パーティクルを描画する描画方法を取得します。

戻り値：パーティクルを描画する描画方法を返します。

先頭へ

IParticle@@Halt

void Halt()

   パーティクルの処理を中止することを通知します。
   このメソッドが呼び出された後、パーティクルオブジェクトは削除されます。
   
   このメソッドはパーティクルの初期化以降、完了までの間に
   パーティクルホスト側の都合でパーティクル処理を中止する場合に呼び出されます。
   パーティクルの開始前でも呼び出されることに注意してください。

先頭へ

IParticle@@GetDefaultSize

void GetDefaultSize(editable Integer width,editable Integer height)

   このパーティクルを描画する基本サイズを取得します。
   基本サイズは拡張パラメータの拡大率を反映する前の大きさです。

editable Integer width ：[出力]横幅を出力するオブジェクト。
editable Integer height ：[出力]縦幅を出力するオブジェクト。

先頭へ

IParticle@@Update

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

   パーティクルの表示状態を1フレーム分更新し、新しい表示状態を返します。
   このメソッドは基本パラメータのみを返します。
   
   このメソッドが偽を返すとパーティクル処理が完了したとみなされ、
   パーティクルオブジェクトが削除されます。
   この時、 Halt は呼び出されません。

戻り値：パーティクルの表示と更新を継続する場合は真を返します。

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

先頭へ

IParticle@@UpdateEx

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フレーム分更新し、新しい表示状態を返します。
   このメソッドは基本パラメータと拡張パラメータ両方を返します。
   
   このメソッドが偽を返すとパーティクル処理が完了したとみなされ、
   パーティクルオブジェクトが削除されます。
   この時、 Halt は呼び出されません。

戻り値：パーティクルの表示と更新を継続する場合は真を返します。

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 ：[出力]パーティクルの色変換の青強度を出力するオブジェクト。

先頭へ

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

最終更新 2023/02/01