パーティクル集合を制御するクラス [詳解]

#include <CLI/FK_CLI/include/ParticleSet_CLI.h>

FK_CLI::fk_ParticleSet の継承関係図

FK_CLI::fk_ParticleSet 連携図

公開メンバ関数
delegate void	ParticleMethod1 (void)

delegate void	ParticleMethod2 (fk_Particle^)

	fk_ParticleSet ()
	コンストラクタ

	~fk_ParticleSet ()
	デストラクタ

	!fk_ParticleSet ()
	ファイナライザ

void	Handle (void)
	実行メソッド

fk_Particle ^	NewParticle (void)
	パーティクル生成メソッド1

fk_Particle ^	NewParticle (fk_Vector^ pos)
	パーティクル生成メソッド2

fk_Particle ^	NewParticle (double x, double y, double z)
	パーティクル生成メソッド3

bool	RemoveParticle (fk_Particle ^ p)
	パーティクル削除メソッド1

bool	RemoveParticle (int ID)
	パーティクル削除メソッド2

fk_Particle ^	GetParticle (int ID)
	パーティクルインスタンス参照メソッド

fk_Particle ^	GetNextParticle (fk_Particle^ p)
	パーティクルインスタンス順次取得取得

公開変数類
ParticleMethod2 ^	GenMethod
	個別初期化用抽象メソッド

ParticleMethod1 ^	AllMethod
	全体動作用抽象メソッド

ParticleMethod2 ^	IndivMethod
	個別動作用抽象メソッド

プロパティ
fk_Shape^	Shape `[get]`
	モデル設定用プロパティ

unsigned int	Count `[get]`
	年齢プロパティ

unsigned int	ParticleNum `[get]`
	パーティクル個数プロパティ

unsigned int	MaxSize `[get, set]`
	パーティクル最大個数プロパティ

bool	AllMode `[get, set]`
	全体動作モードプロパティ

bool	IndivMode `[get, set]`
	個別動作モードプロパティ

詳解

パーティクル集合を制御するクラス

このクラスは、パーティクル集合を制御する機能を提供します。

「パーティクル」とは粒子のことで、流体表現などに利用します。本クラスは、そのままインスタンスを生成して利用するのではなく、このクラスの継承クラスに対して抽象メソッドを上書きして利用することを想定しています。具体的には、以下のような手順となります。

まず fk_ParticleSet を継承したクラスを準備します。
そのクラスで、各種抽象メソッドの上書きによってパーティクルの挙動を記述します。
新しいクラスのインスタンスを作成し、以下のようなコードでモデルに登録します。
```
 // fk_ParticleSet を継承した MyParticleSet クラスを事前に準備
 MyParticleSet   pSet = new MyParticleSet();
 fk_Model        mode = new fk_Model();

 model.Shape = pSet.Shape;
```
もちろん、そのモデルはシーンに登録しておく必要があります。
描画ループの中で Handle() を呼び出す。

このクラスと同様に点群を扱うクラスとして、 fk_Point があります。 fk_Particle や fk_ParticleSet が法則を記述することが主であることに対し、 fk_Point では点の制御をより直接的に行います。

参照: fk_Particle, fk_Point

構築子と解体子

◆ fk_ParticleSet()

FK_CLI::fk_ParticleSet::fk_ParticleSet ( )

コンストラクタ

◆ ~fk_ParticleSet()

FK_CLI::fk_ParticleSet::~fk_ParticleSet ( )

デストラクタ

◆ !fk_ParticleSet()

FK_CLI::fk_ParticleSet::!fk_ParticleSet ( )

ファイナライザ

関数詳解

◆ ParticleMethod1()

delegate void FK_CLI::fk_ParticleSet::ParticleMethod1 ( void )

◆ ParticleMethod2()

delegate void FK_CLI::fk_ParticleSet::ParticleMethod2 ( fk_Particle^ )

◆ Handle()

void FK_CLI::fk_ParticleSet::Handle ( void )

実行メソッド

パーティクル集合および各パーティクルに対し、時間経過処理を実行します。具体的には、以下の処理が行われます。

各パーティクルの fk_Particle::Handle() 実行。
パーティクル集合および各パーティクルの年齢に 1 を追加。

◆ NewParticle() [1/3]

fk_Particle ^ FK_CLI::fk_ParticleSet::NewParticle ( void )

パーティクル生成メソッド1

パーティクルを原点上に新たに生成します。ただし、既にパーティクル数が設定した最大値に達していた場合は、生成を行いません。

戻り値: 生成した場合、新たなパーティクルのインスタンスを返します。失敗した場合は null を返します。

◆ NewParticle() [2/3]

fk_Particle ^ FK_CLI::fk_ParticleSet::NewParticle ( fk_Vector^ pos )

パーティクル生成メソッド2

パーティクルを指定した位置ベクトルの場所に新たに生成します。ただし、既にパーティクル数が設定した最大値に達していた場合は、生成を行いません。

引数

[in] pos 生成場所の位置ベクトル

戻り値: 生成した場合、新たなパーティクルのインスタンスを返します。失敗した場合は null を返します。

◆ NewParticle() [3/3]

fk_Particle ^ FK_CLI::fk_ParticleSet::NewParticle	(	double	x,
		double	y,
		double	z
	)

パーティクル生成メソッド3

パーティクルを指定した位置ベクトルの場所に新たに生成します。ただし、既にパーティクル数が設定した最大値に達していた場合は、生成を行いません。

引数

[in]	x	生成場所の位置ベクトルのx成分
[in]	y	生成場所の位置ベクトルのy成分
[in]	z	生成場所の位置ベクトルのz成分

戻り値: 生成した場合、新たなパーティクルのインスタンスを返します。失敗した場合は nullptr を返します。

◆ RemoveParticle() [1/2]

bool FK_CLI::fk_ParticleSet::RemoveParticle ( fk_Particle ^ p )

パーティクル削除メソッド1

指定したパーティクルを削除します。削除したパーティクルが持っていた ID は、新たに生成したパーティクルで再利用します。

引数

[in] p 削除パーティクル

戻り値: 削除に成功すれば true を、失敗すれば false を返します。

◆ RemoveParticle() [2/2]

bool FK_CLI::fk_ParticleSet::RemoveParticle ( int ID )

パーティクル削除メソッド2

指定した ID を持つパーティクルを削除します。削除したパーティクルが持っていた ID は、新たに生成したパーティクルで再利用します。

引数

[in] ID 削除パーティクル ID

戻り値: 削除に成功すれば true を、失敗すれば false を返します。

◆ GetParticle()

fk_Particle ^ FK_CLI::fk_ParticleSet::GetParticle ( int ID )

パーティクルインスタンス参照メソッド

指定した ID を持つパーティクルインスタンスを返します。

引数

[in] ID パーティクルID

戻り値: 存在した場合はインスタンスを、存在しない場合は nullptr を返します。

◆ GetNextParticle()

fk_Particle ^ FK_CLI::fk_ParticleSet::GetNextParticle ( fk_Particle^ p )

パーティクルインスタンス順次取得取得

存在しているパーティクルを順次取得するのに利用していきます。引数と返値は、以下のような関係を持ちます。

引数が null の場合は、IDが最も小さなパーティクルを返します。
引数のパーティクルに対し、次の大きな ID を持つパーティクルを返します。
もし引数のパーティクルの ID が最大のものであった場合は、 null を返します。

以下のソースコードは、 AllMethod() の中で全てのパーティクルの総和平均座標を求めているものです。ここで、「MyPaticleSet」は fk_ParticleSet クラスを派生したものとします。

void MyParticleSet::AllMethod(void)
{
    fk_Particle  p;
    fk_Vector    vec = new fk_Vector();

    p = GetNextParticle(null);
    while(p != null) {
        vec += p->GetPosition();
        p = GetNextParticle(p);
    }
    vec /= double(getParticleNum());
}

引数

[in] p パーティクルインスタンス

戻り値: 上記解説を参照して下さい。

メンバ詳解

◆ GenMethod

ParticleMethod2 ^ FK_CLI::fk_ParticleSet::GenMethod

個別初期化用抽象メソッド

このメソッドは、 NewParticle() によってパーティクルが生成されたときに、自動的に実行されます。初期状態としては特に何も行いませんが、このメソッドを上書き定義することによって、パーティクル生成時にそのパーティクルに対して様々な制御を行うことができます。

引数

[in] p 新たに生成されたパーティクルインスタンス

◆ AllMethod

ParticleMethod1 ^ FK_CLI::fk_ParticleSet::AllMethod

全体動作用抽象メソッド

このメソッドは、 Handle() が呼び出された時点で自動的に実行されます。 (ただし、 fk_ParticleSet::AllMode プロパティで false が設定されている場合は呼び出されません。) 初期状態としては何も行いませんが、このメソッドを上書き定義することによって、パーティクル集合に対して様々な制御を行うことができます。

◆ IndivMethod

ParticleMethod2 ^ FK_CLI::fk_ParticleSet::IndivMethod

個別動作用抽象メソッド

このメソッドは、 Handle() が呼び出された時点で、各パーティクル個別に自動的に実行されます。 (ただし、 fk_ParticleSet::IndivMode プロパティで false が設定されている場合は呼び出されません。) 初期状態としては何も行いませんが、このメソッドを上書き定義することによって、各パーティクルに対して様々な制御を行うことができます。

引数

[in] p 個別パーティクルインスタンス

プロパティ詳解

◆ Shape

fk_Shape^ FK_CLI::fk_ParticleSet::Shape

get

モデル設定用プロパティ

モデルに形状を設定するためのプロパティです。

覚え書き: 現時点では、この形状インスタンスの型は fk_Point になっています。しかし、将来においてはこの型が変更となる可能性があります。このメソッドで得られるインスタンスが fk_Point であることを前提とするような記述を行った場合、将来のバージョンにおいて問題が生じる可能性があります。

◆ Count

unsigned int FK_CLI::fk_ParticleSet::Count

get

年齢プロパティ

パーティクル集合の年齢を参照します。年齢とは、パーティクル集合が生成されてから Handle() が呼ばれた回数のことです。

覚え書き: 個別のパーティクルで呼ばれた fk_Particle::Handle() はカウントしません。

◆ ParticleNum

unsigned int FK_CLI::fk_ParticleSet::ParticleNum

get

パーティクル個数プロパティ

現在生存しているパーティクルの個数を参照します。

◆ MaxSize

unsigned int FK_CLI::fk_ParticleSet::MaxSize

getset

パーティクル最大個数プロパティ

パーティクル集合における、パーティクル個数の最大値の参照・設定を行います。もし生存数がこの個数に達した場合、 NewParticle() を呼び出しても生成を行いません。 0 の場合無制限となります。デフォルトは 0 です。

◆ AllMode

bool FK_CLI::fk_ParticleSet::AllMode

getset

全体動作モードプロパティ

Handle() 呼び出し時の、 AllMethod() の自動実行を制御します。 true の場合は AllMethod() の自動実行を行います。 false の場合は行いません。デフォルトでは true となっています。

◆ IndivMode

bool FK_CLI::fk_ParticleSet::IndivMode

getset

個別動作モードプロパティ

handle() 呼び出し時の、 IndivMethod() の自動実行を制御します。 true の場合は IndivMethod() の自動実行を行います。 false の場合は行いません。デフォルトでは true となっています。

公開メンバ関数

公開変数類

プロパティ

詳解

構築子と解体子

◆ fk_ParticleSet()

◆ ~fk_ParticleSet()

◆ !fk_ParticleSet()

関数詳解

◆ ParticleMethod1()

◆ ParticleMethod2()

◆ Handle()

◆ NewParticle() [1/3]

◆ NewParticle() [2/3]

◆ NewParticle() [3/3]

◆ RemoveParticle() [1/2]

◆ RemoveParticle() [2/2]

◆ GetParticle()

◆ GetNextParticle()

メンバ詳解

◆ GenMethod

◆ AllMethod

◆ IndivMethod

プロパティ詳解

◆ Shape

◆ Count

◆ ParticleNum

◆ MaxSize

◆ AllMode

◆ IndivMode