FineKernelToolKit 3.1.0

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

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

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

マテリアルパレットを管理するクラス [詳解]

FK_CLI::fk_Palette 連携図
[凡例]

## 公開メンバ関数
| fk_Palette ()
| コンストラクタ [詳解]
| ~fk_Palette ()
| デストラクタ [詳解]
| !fk_Palette ()
| ファイナライザ [詳解]
void | ClearMaterial (void)
| 初期化メソッド [詳解]
void | PushPalette (fk_Material^ material)
| マテリアル追加メソッド [詳解]
void | SetPalette (fk_Material^ material, int ID)
| マテリアル設定メソッド [詳解]
fk_Material^ | GetMaterial (int ID)
| マテリアル取得メソッド [詳解]

## プロパティ
int | MaterialID`[get, set]`
| オブジェクトマテリアル ID プロパティ [詳解]
int | Size`[get]`
| パレット中のマテリアル格納数プロパティ [詳解]
cli::array< fk_Material^ >^ | MaterialVector`[get]`
| マテリアル配列プロパティ [詳解]

## 詳解

マテリアルパレットを管理するクラス

このクラスは、マテリアルパレットを制御する機能を提供します。 「マテリアルパレット」とは、複数のマテリアルを管理するデータベースのことです。 水彩や油彩で使う「パレット」のような機能を保持しており、 複数のマテリアルを登録することができます。

参照
  fk_Material, fk_Color, fk_Shape

## 構築子と解体子

FK_CLI::fk_Palette::fk_Palette | ( |  | ) |

コンストラクタ

FK_CLI::fk_Palette::~fk_Palette | ( |  | ) |

デストラクタ

FK_CLI::fk_Palette::!fk_Palette | ( |  | ) |

ファイナライザ

## 関数詳解

void FK_CLI::fk_Palette::ClearMaterial | ( | void |  | ) |

初期化メソッド

パレットを初期化します。

void FK_CLI::fk_Palette::PushPalette | ( | fk_Material^ | material | ) |

マテリアル追加メソッド

パレットにマテリアルを新たに追加します。 追加するマテリアルの ID は、 このメソッドを呼ぶ前に PaletteSize プロパティを参照することで得られます。 以下のコードは、マテリアルを追加しその ID を引数に代入します。

    fk_Palette      pal = new fk_Palette();
    fk_Material     mat = new fk_Material();
    int             id;

    id = pal.Size;
    pal.PushPalette(mat);

引数

  [in] | material | 追加するマテリアル

参照
  SetPalette()

void FK_CLI::fk_Palette::SetPalette | ( | fk_Material^ | material,
|  | int | ID
| ) |  |

マテリアル設定メソッド

パレットに対し、対応する ID でマテリアルを設定します。 ID の指定により、以下のように挙動が若干変わります。

- もし ID が負であった場合は、パレットは何も変化しません。
- もし ID で指定されているマテリアルが既にパレット中に存在する場合は、 旧マテリアルを破棄して新しいマテリアルで上書きします。
- もし ID が新規のものであった場合、 その ID で新たに登録します。

引数

  [in] | material | 設定するマテリアル
  [in] | ID | マテリアルID

参照
  PushPalette()

fk_Material ^ FK_CLI::fk_Palette::GetMaterial | ( | int | ID | ) |

マテリアル取得メソッド

指定された ID に対応するマテリアルのポインタを返します。

引数

  [in] | ID | マテリアルID

戻り値
  対象マテリアルのポインタ。 ID に対応するマテリアルがパレット中にない場合は、 デフォルト状態のマテリアルインスタンスへのポインタを返します。

参照
  PushPalette(), SetPalette(), Size

## プロパティ詳解

int FK_CLI::fk_Palette::MaterialID
| get set

オブジェクトマテリアル ID プロパティ

オブジェクトマテリアル ID の参照・設定を行います。

int FK_CLI::fk_Palette::Size
| get

パレット中のマテリアル格納数プロパティ

現在パレットに格納されているマテリアルの数を参照します。

戻り値
  マテリアル数

参照
  PushPalette(), SetPalette(), GetMaterial()

cli:: array< fk_Material^>^ FK_CLI::fk_Palette::MaterialVector
| get

マテリアル配列プロパティ

パレットに格納されているマテリアルを、配列として参照します。

参照
  GetMaterial()