JParticle

JParticle　(script/fgs/system_multipart.fges)

このクラスはパーティクルの基本機能を注入するための抽象クラスです。

●継承/注入

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

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

implements IParticle IsReady GetPriority HasExParams SetDrawType GetDR GetDrawMode Halt GetDefaultSize Update UpdateEx

●クラスメソッド

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

●クラスメンバメソッド

名前	概要
`SetPriority`	優先度を設定します
`Halt`	パーティクルの表示中止を通知します
`IsReady`	パーティクルを開始可能か判定します
`GetDR`	パーティクルを描画するDRを取得します
`Update`	パーティクルを更新し、基本パラメータを取得します
`UpdateEx`	パーティクルを更新し、拡張パラメータを含めて取得します

●クラス共有変数

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

●インスタンス変数

名前	概要
`split_mode`	描画先の分割タイプ
`has_exparams`	拡張パラメータフラグ
`drawmode`	パーティクルの描画方法
`def_width`	パーティクルの基本横幅
`def_width`	パーティクルの基本縦幅
`priority`	パーティクルの優先度

JParticle::IParticle@@IsReady

portable Bool IParticle@@IsReady()const

   パーティクルを開始できる状態になっているか判定します。
   このメソッドが真を返すまではパーティクルは表示されず、更新も行われません。

   ただし、開始準備が出来ていなくても Halt は呼ばれる可能性があります。

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

先頭へ

JParticle::IParticle@@GetPriority

portable Integer IParticle@@GetPriority()const

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

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

先頭へ

JParticle::IParticle@@HasExParams

portable Bool IParticle@@HasExParams()const

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

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

先頭へ

JParticle::IParticle@@SetDrawType

portable void IParticle@@SetDrawType( Bool split_mode)

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

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

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

先頭へ

JParticle::IParticle@@GetDR

portable INativeDrawResource@ IParticle@@GetDR()

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

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

先頭へ

JParticle::IParticle@@GetDrawMode

portable Integer IParticle@@GetDrawMode()const

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

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

先頭へ

JParticle::IParticle@@Halt

portable void IParticle@@Halt()

   パーティクルの処理を中止することを通知します。
   このメソッドが呼び出された後、パーティクルオブジェクトは削除されます。

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

先頭へ

JParticle::IParticle@@GetDefaultSize

portable void IParticle@@GetDefaultSize(editable Integer width,editable Integer height)

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

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

先頭へ

JParticle::IParticle@@Update

portable Bool IParticle@@Update(editable Integer x,editable Integer y,editable Integer a)

   パーティクルの表示状態を1フレーム分更新し、新しい表示状態を返します。
   このメソッドは基本パラメータのみを返します。

   このメソッドが偽を返すとパーティクル処理が完了したとみなされ、
   パーティクルオブジェクトが削除されます。
   この時、 Halt は呼び出されません。

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

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

先頭へ

JParticle::IParticle@@UpdateEx

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

先頭へ

JParticle::SetPriority

public portable void SetPriority( Integer priority)

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

Integer priority ：パーティクルの優先度。本文参照。

先頭へ

JParticle::Halt

public portable void Halt()

   パーティクルの処理を中止することを通知します。
   このメソッドが呼び出された後、パーティクルオブジェクトは削除されます。

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

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

先頭へ

JParticle::IsReady

public abstract Bool IsReady()const

   パーティクルを開始できる状態になっているか判定します。
   このメソッドが真を返すまではパーティクルは表示されず、更新も行われません。

   ただし、開始準備が出来ていなくても Halt は呼ばれる可能性があります。

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

先頭へ

JParticle::GetDR

public abstract INativeDrawResource@ GetDR()

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

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

先頭へ

JParticle::Update

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

   パーティクルの表示状態を1フレーム分更新し、新しい表示状態を返します。
   このメソッドは基本パラメータのみを返します。

   このメソッドが偽を返すとパーティクル処理が完了したとみなされ、
   パーティクルオブジェクトが削除されます。
   この時、 Halt は呼び出されません。

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

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

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

先頭へ

JParticle::UpdateEx

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

先頭へ

JParticle::split_mode

internal Bool split_mode

   パーティクルホストがパーティクル描画を扱う方法。

   真の場合はパーティクルDRの描画先は一時領域です(分割描画)。
   偽の場合はパーティクルDRの描画先は最終描画領域です。

先頭へ

JParticle::has_exparams

internal Bool has_exparams

   パーティクルが拡張パラメータを持つ場合は真に設定します。

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

先頭へ

JParticle::drawmode

internal Integer drawmode

分割描画モードの時、パーティクルホストが一時領域を描画する描画方法を設定します。

先頭へ

JParticle::def_width

internal Integer def_width

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

先頭へ

JParticle::def_height

internal Integer def_height

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

先頭へ

JParticle::priority

internal Integer priority

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

先頭へ

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

最終更新 2023/02/01