FineKernelToolKit 3.1.0

- 総合概要
- 名前空間
- クラス
- ファイル

- クラス一覧
- クラス階層
- クラスメンバ

公開メンバ関数 | プロパティ | 全メンバ一覧
FK_CLI::fk_Point クラス

点群を生成、管理するクラス [詳解]

FK_CLI::fk_Point の継承関係図
[凡例]
FK_CLI::fk_Point 連携図
[凡例]

## 公開メンバ関数
| fk_Point ()
| コンストラクタ1 [詳解]
| fk_Point (IEnumerable< fk_Vector^ >^array)
| コンストラクタ2 [詳解]
| ~fk_Point ()
| デストラクタ [詳解]
| !fk_Point ()
| ファイナライザ [詳解]
int | PushVertex (fk_Vector^ pos)
| 頂点追加メソッド [詳解]
bool | SetVertex (int ID, fk_Vector^ pos)
| 頂点位置設定メソッド [詳解]
bool | SetVertex (IEnumerable< fk_Vector^ >^array)
| 点群生成メソッド [詳解]
bool | RemoveVertex (int ID)
| 頂点削除メソッド [詳解]
fk_Vector^ | GetVertex (int ID)
| 頂点位置ベクトル取得メソッド [詳解]
void | SetDrawMode (int ID, bool mode)
| 頂点描画制御メソッド [詳解]
bool | GetDrawMode (void)
| 全頂点描画状態参照メソッド [詳解]
bool | GetDrawMode (int ID)
| 個別頂点描画状態参照メソッド [詳解]
void | SetColorID (int vID, int cID)
| 描画色設定メソッド [詳解]
int | GetColorID (int vID)
| 描画色参照メソッド [詳解]
void | AllClear (bool matFlag)
| 点群全消去メソッド1 [詳解]
void | AllClear (void)
| 点群全消去メソッド2 [詳解]
基底クラス FK_CLI::fk_Shape に属する継承公開メンバ関数
void | ClearMaterial (void)
| パレット初期化メソッド [詳解]
void | PushPalette (fk_Material^ mat)
| マテリアル追加メソッド [詳解]
void | SetPalette (fk_Material^ mat, int ID)
| マテリアル設定メソッド [詳解]
fk_Material^ | GetMaterial (int ID)
| マテリアル取得メソッド [詳解]
基底クラス FK_CLI::fk_Attribute に属する継承公開メンバ関数
bool | SetAttrII (int key, int value)
| キーが int 型、値が int 型である属性設定メソッド [詳解]
bool | SetAttrID (int key, double value)
| キーが int 型、値が double 型である属性設定メソッド [詳解]
bool | SetAttrIS (int key, String^ value)
| キーが int 型、値が String 型である属性設定メソッド [詳解]
bool | SetAttrSI (String^ key, int value)
| キーが String 型、値が int 型である属性設定メソッド [詳解]
bool | SetAttrSD (String^ key, double value)
| キーが String 型、値が double 型である属性設定メソッド [詳解]
bool | SetAttrSS (String^ key, String^ value)
| キーが String 型、値が String 型である属性設定メソッド [詳解]
int | GetAttrII (int key)
| キーが int 型、値が int 型である属性参照メソッド [詳解]
double | GetAttrID (int key)
| キーが int 型、値が double 型である属性参照メソッド [詳解]
String^ | GetAttrIS (int key)
| キーが int 型、値が String 型である属性参照メソッド [詳解]
int | GetAttrSI (String^ key)
| キーが String 型、値が int 型である属性参照メソッド [詳解]
double | GetAttrSD (String^ key)
| キーが String 型、値が double 型である属性参照メソッド [詳解]
String^ | GetAttrSS (String^ key)
| キーが String 型、値が String 型である属性参照メソッド [詳解]
bool | ExistAttrII (int key)
| キーが int 型、値が int 型である属性存在参照メソッド [詳解]
bool | ExistAttrID (int key)
| キーが int 型、値が double 型である属性存在参照メソッド [詳解]
bool | ExistAttrIS (int key)
| キーが int 型、値が String 型である属性存在参照メソッド [詳解]
bool | ExistAttrSI (String^ key)
| キーが String 型、値が int 型である属性存在参照メソッド [詳解]
bool | ExistAttrSD (String^ key)
| キーが String 型、値が double 型である属性存在参照メソッド [詳解]
bool | ExistAttrSS (String^ key)
| キーが String 型、値が String 型である属性存在参照メソッド [詳解]
bool | DeleteAttrII (int key)
| キーが int 型、値が int 型である属性消去メソッド [詳解]
bool | DeleteAttrID (int key)
| キーが int 型、値が double 型である属性消去メソッド [詳解]
bool | DeleteAttrIS (int key)
| キーが int 型、値が String 型である属性消去メソッド [詳解]
bool | DeleteAttrSI (String^ key)
| キーが String 型、値が int 型である属性消去メソッド [詳解]
bool | DeleteAttrSD (String^ key)
| キーが String 型、値が double 型である属性消去メソッド [詳解]
bool | DeleteAttrSS (String^ key)
| キーが String 型、値が String 型である属性消去メソッド [詳解]

## プロパティ
int | Num`[get]`
| 頂点数プロパティ [詳解]
bool | ColorCount`[get]`
| 描画色設定有無プロパティ [詳解]
基底クラス FK_CLI::fk_Shape に属する継承プロパティ
fk_RealShapeType^ | RealShapeType`[get]`
| 形状データ構造プロパティ [詳解]
fk_Palette^ | Palette`[get]`
| パレットプロパティ [詳解]
fk_MaterialMode | MaterialMode`[get, set]`
| マテリアルモード設定メソッド [詳解]
int | MaterialID`[get, set]`
| オブジェクトマテリアル ID プロパティ [詳解]
int | PaletteSize`[get]`
| パレット中のマテリアル格納数プロパティ [詳解]
cli::array< fk_Material^ >^ | MaterialVector`[get]`
| マテリアル配列取得メソッド [詳解]

## 詳解

点群を生成、管理するクラス

このクラスは、形状として点群を制御する機能を提供します。 1つのインスタンスで、複数の点を制御することが可能です。

このクラスの機能は大きく以下のようなものとなります。

- 点の生成や消去
- 点の移動
- 各点の描画有無の設定
- 各店の描画色の設定

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

参照
  fk_Shape, fk_Particle, fk_ParticleSet

## 構築子と解体子

FK_CLI::fk_Point::fk_Point | ( |  | ) |

コンストラクタ1

点が空の状態でインスタンスを生成します。

FK_CLI::fk_Point::fk_Point | ( | IEnumerable< fk_Vector^ >^ | array | ) |

コンストラクタ2

引数として fk_Vector 型の配列を与えることによって、 最初から点群を生成することができます。

引数

  [in] | array | 点群位置ベクトル配列。null の場合は何も生成しません。

FK_CLI::fk_Point::~fk_Point | ( |  | ) |

デストラクタ

FK_CLI::fk_Point::!fk_Point | ( |  | ) |

ファイナライザ

## 関数詳解

int FK_CLI::fk_Point::PushVertex | ( | fk_Vector^ | pos | ) |

頂点追加メソッド

頂点を新たに追加します。

引数

  [in] | pos | 追加する頂点の位置ベクトル

戻り値
  新しい頂点の ID

bool FK_CLI::fk_Point::SetVertex | ( | int | ID,
|  | fk_Vector^ | pos
| ) |  |

頂点位置設定メソッド

点群中の任意の頂点に対し、位置を設定します。

引数

  [in] | ID | 頂点ID
  [in] | pos | 移動先の位置ベクトル

戻り値
  移動に成功すれば true を、失敗すれば false を返します。

bool FK_CLI::fk_Point::SetVertex | ( | IEnumerable< fk_Vector^ >^ | array | ) |

点群生成メソッド

bool FK_CLI::fk_Point::RemoveVertex | ( | int | ID | ) |

頂点削除メソッド

fk_Vector ^ FK_CLI::fk_Point::GetVertex | ( | int | ID | ) |

頂点位置ベクトル取得メソッド

指定した頂点の位置ベクトルを返します。

引数

  [in] | ID | 頂点ID

戻り値
  頂点の位置ベクトル。 指定した頂点が存在しない場合は null を返します。

void FK_CLI::fk_Point::SetDrawMode | ( | int | ID,
|  | bool | mode
| ) |  |

頂点描画制御メソッド

個別の頂点に対し、描画の有無を設定します。

引数

  [in] | ID | 頂点ID
  [in] | mode | true であれば描画を有効に、false であれば無効にします。

bool FK_CLI::fk_Point::GetDrawMode | ( | void |  | ) |

全頂点描画状態参照メソッド

点群全体の描画状況を取得します。

戻り値
  点群中、1つでも描画される状態であれば true を、 そうでない場合は false を返します。 false を返す場合は、頂点が存在するが全て描画状態が無効である場合と、 1個も頂点が存在していない場合の2通りがありえます。

bool FK_CLI::fk_Point::GetDrawMode | ( | int | ID | ) |

個別頂点描画状態参照メソッド

個別の頂点に対し、描画状況をを取得します。

引数

  [in] | ID | 頂点ID

戻り値
  描画が有効であれば true を、無効であれば false を返します。 指定した ID を持つ頂点が存在しなかった場合も false を返します。

void FK_CLI::fk_Point::SetColorID | ( | int | vID,
|  | int | cID
| ) |  |

描画色設定メソッド

個別の頂点に対し、描画色の ID を設定します。 色そのものの設定は、 fk_Shape::SetPalette() を参照して下さい。

引数

  [in] | vID | 頂点ID
  [in] | cID | 色ID

int FK_CLI::fk_Point::GetColorID | ( | int | vID | ) |

描画色参照メソッド

個別の頂点の描画色を取得します。

引数

  [in] | vID | 頂点ID

戻り値
  描画色が設定されている場合はその描画色 ID を返します。 描画色が設定されていない場合は -1 を返します。 頂点が存在しない場合は -2 を返します。

void FK_CLI::fk_Point::AllClear | ( | bool | matFlag | ) |

点群全消去メソッド1

全ての頂点に関するデータを消去します。

引数

  [in] | matFlag | true の場合は、マテリアルパレットも初期化します。 false の場合は、マテリアルパレットに関しては消去しません。

void FK_CLI::fk_Point::AllClear | ( | void |  | ) |

点群全消去メソッド2

全ての頂点に関するデータを消去します。 マテリアルパレットも初期化します。

## プロパティ詳解

int FK_CLI::fk_Point::Num
| get

頂点数プロパティ

点群の頂点数を参照します。

bool FK_CLI::fk_Point::ColorCount
| get

描画色設定有無プロパティ

点群の描画色設定の有無を参照します。 1個以上の点に描画色が設定されている場合 true、 1つも描画色が設定されていない場合に false となります。