[前へ]
[目次へ]
[次へ]
ParticleEmitter_Common_Base (script/fgs/system_multipart.fges)
このクラスは汎用エミッターを稼働するためのパーティクルエミッタークラスの抽象基底クラスです。
このクラスは
CommonParticleInfo
によるパーティクルを指定回数、指定周期で発生させます。
このクラスはエミッターを中止しても既に発生しているパーティクルには影響しません。
エミッターの中止は次のパーティクルの発生を停止するのみです。
●継承/注入
このクラスは継承/注入をしていません。
●インターフェイスとインターフェイスメソッド
implements
IParticleEmitter
Init
IsReady
Update
Halt
●クラスメソッド
このクラスはクラスメソッドを持っていません。
●クラスメンバメソッド
名前
概要
Setup_Internal
エミッターの内容を設定します
Update
エミッターを更新します
Halt
エミッターの処理を中止します
●クラス共有変数
このクラスはクラス共有変数を持っていません。
●インスタンス変数
名前
概要
repeat
パーティクルの生成回数
interval
パーティクルの生成周期
x
基準X座標
y
基準Y座標
pass_x
中継X座標
pass_y
中継Y座標
t
エミッターの経過時間
tmax
エミッターの完了時間
pass_x_enable
中継X座標の有効フラグ
pass_y_enable
中継Y座標の有効フラグ
handler_host
ハンドラのホストオブジェクト
handler_arg
ハンドラの引数オブジェクト
done_handler
完了ハンドラ
halt_handler
中止ハンドラ
info_p
生成するパーティクルデータ
memhost
エミッター寿命オブジェクト用メモリ管理オブジェクト
ParticleEmitter_Common_Base::IParticleEmitter@@Init
void IParticleEmitter@@Init(editable
IParticleHost
host)
エミッターを初期化します。
このメソッドから戻った後は
Halt
が呼ばれる可能性があります。
このメソッド中に処理中止を行えるようにしてください。
editable
IParticleHost
host
:このオブジェクトを管理するホストオブジェクト
先頭へ
ParticleEmitter_Common_Base::IParticleEmitter@@IsReady
Bool
IParticleEmitter@@IsReady(editable
IParticleHost
host)const
エミッターを開始できる状態になっているか判定します。
このメソッドが真を返すまではエミッターは更新されません。
ただし、開始準備が出来ていなくても
Halt
は呼ばれる可能性があります。
戻り値:エミッターを開始できる状態になっていれば真を返します。
editable
IParticleHost
host
:このオブジェクトを管理するホストオブジェクト
先頭へ
ParticleEmitter_Common_Base::IParticleEmitter@@Update
Bool
IParticleEmitter@@Update(editable
IParticleHost
host)
エミッターの状態を1フレーム分更新します。
エミッターがパーティクルを生成する場合は
host
に対して生成してください。
このメソッドが偽を返すとエミッター処理が完了したとみなされ、
エミッターオブジェクトが削除されます。
この時、
Halt
は呼び出されません。
戻り値:エミッターの処理を継続する場合は真を返します。
editable
IParticleHost
host
:このオブジェクトを管理するホストオブジェクト
先頭へ
ParticleEmitter_Common_Base::IParticleEmitter@@Halt
void IParticleEmitter@@Halt(editable
IParticleHost
host)
エミッターの処理を中止することを通知します。
このメソッドが呼び出された後、エミッターオブジェクトは削除されます。
このメソッドはエミッターの初期化以降、完了までの間に
パーティクルホスト側の都合でエミッター処理を中止する場合に呼び出されます。
エミッターの開始前でも呼び出されることに注意してください。
editable
IParticleHost
host
:このオブジェクトを管理するホストオブジェクト
先頭へ
ParticleEmitter_Common_Base::Setup_Internal
internal
Bool
Setup_Internal(
Integer
repeat,
Integer
interval,
Integer
x,
Integer
y,
Integer
? pass_x=NULL,
Integer
? pass_y=NULL,
editable
Any
? handler_host=NULL,
Arguments
? handler_arg=NULL,
INativeMethod
? done_handler=NULL,
INativeMethod
? halt_handler=NULL)
エミッターを設定します。
このメソッドは指定周期で指定回数、
CommonParticleInfo::Emit
を呼び出します。
このメソッドを呼び出すとエミッターは開始します。
このメソッドを呼び出す前にパーティクルの内容を設定してください。
戻り値:設定に成功すると真を返します。
Integer
repeat
:パーティクルの生成回数
Integer
interval
:パーティクルの生成周期(フレーム数)
Integer
x
:生成する基準X座標
Integer
y
:生成する基準Y座標
Integer
? pass_x=NULL
:中継点X座標。
空参照を指定した場合は中継点を使用しないものとして扱います。
Integer
? pass_y=NULL
:中継点Y座標。
空参照を指定した場合は中継点を使用しないものとして扱います。
editable
Any
? handler_host=NULL
:完了/中止ハンドラのホストオブジェクト。
このオブジェクトは発生したパーティクルが全て消滅するまで維持する必要があります。
エミッター寿命では足りないことに注意してください。
完了/中止ハンドラを使用しないか、両ハンドラが
static
の場合は空参照を指定することができます。
Arguments
? handler_arg=NULL
:完了/中止ハンドラの引数オブジェクト。
このオブジェクトは発生したパーティクルが全て消滅するまで維持する必要があります。
エミッター寿命では足りないことに注意してください。
完了/中止ハンドラを使用しない場合は空参照を指定することができます。
INativeMethod
? done_handler=NULL
:発生したパーティクルの完了時に呼ばれるハンドラ。
このオブジェクトは発生したパーティクルが全て消滅するまで維持する必要があります。
エミッター寿命では足りないことに注意してください。
空参照を指定した場合はパーティクルデータに設定されているハンドラ設定を使用します。
INativeMethod
? halt_handler=NULL
:発生したパーティクルの中止時に呼ばれるハンドラ。
このオブジェクトは発生したパーティクルが全て消滅するまで維持する必要があります。
エミッター寿命では足りないことに注意してください。
空参照を指定した場合はパーティクルデータに設定されているハンドラ設定を使用します。
先頭へ
ParticleEmitter_Common_Base::Update
public
Bool
Update(editable
IParticleHost
host)
エミッターの状態を1フレーム分更新します。
エミッターがパーティクルを生成する場合は
host
に対して生成してください。
このメソッドはエミッターの経過時間を進め、
周期が経過する度に設定されているパーティクルデータに従ってパーティクルを生成します。
このクラスのエミッターは設定されている回数のパーティクル生成が行われた時点で完了します。
このメソッドが偽を返すとエミッター処理が完了したとみなされ、
エミッターオブジェクトが削除されます。
この時、
Halt
は呼び出されません。
戻り値:エミッターの処理を継続する場合は真を返します。
editable
IParticleHost
host
:このオブジェクトを管理するホストオブジェクト
先頭へ
ParticleEmitter_Common_Base::Halt
public void Halt(editable
IParticleHost
host)
エミッターの処理を中止することを通知します。
editable
IParticleHost
host
:このオブジェクトを管理するホストオブジェクト
先頭へ
ParticleEmitter_Common_Base::repeat
readable
Integer
repeat
パーティクルの生成回数。
先頭へ
ParticleEmitter_Common_Base::interval
readable
Integer
interval
パーティクルの生成間隔(フレーム数)。
先頭へ
ParticleEmitter_Common_Base::x
readable
Integer
x
パーティクルの基準X座標。
先頭へ
ParticleEmitter_Common_Base::y
readable
Integer
y
パーティクルの基準Y座標。
先頭へ
ParticleEmitter_Common_Base::pass_x
readable
Integer
pass_x
パーティクルの中継点X座標。
先頭へ
ParticleEmitter_Common_Base::pass_y
readable
Integer
pass_y
パーティクルの中継点Y座標。
先頭へ
ParticleEmitter_Common_Base::t
readable
Integer
t
エミッターの経過時間。
先頭へ
ParticleEmitter_Common_Base::tmax
readable
Integer
tmax
エミッターの完了時間。
先頭へ
ParticleEmitter_Common_Base::pass_x_enable
readable
Bool
pass_x_enable
中継点X座標が有効な場合真になるフラグ。
先頭へ
ParticleEmitter_Common_Base::pass_y_enable
readable
Bool
pass_y_enable
中継点Y座標が有効な場合真になるフラグ。
先頭へ
ParticleEmitter_Common_Base::handler_host
readable
Pointer
handler_host
パーティクルの完了/中止ハンドラのホストオブジェクト。
先頭へ
ParticleEmitter_Common_Base::handler_arg
readable
Arguments
handler_arg
パーティクルの完了/中止ハンドラの引数オブジェクト。
先頭へ
ParticleEmitter_Common_Base::done_handler
readable
ConstPointer
<
INativeMethod
> done_handler
パーティクルの完了ハンドラ。
先頭へ
ParticleEmitter_Common_Base::halt_handler
readable
ConstPointer
<
INativeMethod
> halt_handler
パーティクルの中止ハンドラ。
先頭へ
ParticleEmitter_Common_Base::info_p
readable
ConstPointer
<
CommonParticleInfo
> info_p
生成するパーティクルデータ。
先頭へ
ParticleEmitter_Common_Base::memhost
public
MemoryHost
memhost
エミッター寿命オブジェクト用のメモリ管理オブジェクト。
先頭へ
[前へ]
[目次へ]
[次へ]
最終更新 2023/02/01