FineKernelToolKit: FK_CLI::fk_DisplayLink クラス

FineKernelToolKit 4.3.0

読み取り中…
検索中…
一致する文字列を見つけられません
公開メンバ関数 | プロパティ | 全メンバ一覧
FK_CLI::fk_DisplayLink クラス

ディスプレイリストを制御するクラス [詳解]

`#include <CLI/FK_CLI/include/DList_CLI.h>`

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

## 公開メンバ関数

void | ClearDisplay (void)
| 初期化メソッド
void | ClearStereo (void)
| 立体視用設定情報初期化メソッド
void | EntryModel (fk_Model ^ model)
| 通常モデル登録メソッド
void | RemoveModel (fk_Model ^ model)
| 通常モデル解除メソッド
void | ClearModel (void)
| 通常モデル全解除メソッド
void | EntryOverlayModel (fk_Model ^ model)
| オーバーレイモデル登録メソッド
void | RemoveOverlayModel (fk_Model^ model)
| オーバーレイモデル解除メソッド
void | ClearOverlayModel (void)
| オーバーレイモデル全解除メソッド

## プロパティ

fk_Model^ | Camera`[get, set]`
| カメラモデルプロパティ
fk_Model^ | LeftCamera`[get, set]`
| 立体視用左眼カメラプロパティ
fk_Model^ | RightCamera`[get, set]`
| 立体視用右眼カメラプロパティ
fk_ProjectBase^ | Projection`[get, set]`
| 投影設定プロパティ
fk_ProjectBase^ | LeftProjection`[get, set]`
| 立体視用左眼投影プロパティ
fk_ProjectBase^ | RightProjection`[get, set]`
| 立体視用右眼投影プロパティ
bool | StereoOverlayMode`[get, set]`
| 立体視モード時のオーバーレイ描画モードプロパティ

## 詳解

ディスプレイリストを制御するクラス

このクラスは、ディスプレイリストを制御する機能を提供します。 ディスプレイリストとは、シーン中に表示するためのモデルを管理する仕組みです。 実際の利用時には、インスタンスは本クラスのものではなく 派生クラスの fk_Scene によるものを利用することになります。

ディスプレイリストに登録する要素は、以下のようなものがあります。

- 通常モデル: 3次元空間に表示するためのモデルです。
- オーバーレイモデル: オーバーレイモデルとして登録したモデルは、 カメラからの前後に関係なく常に全体が表示されます。 オーバーレイモデルが複数登録されている場合は、 後に登録されたものほど前面に表示されます。
- カメラ: シーンのカメラに当たるモデルです。 同時に登録できるモデルは1つだけですが、 どの時点でもモデルを変更することができます。
- 投影設定: シーンを表示する際の投影設定です。 詳細は fk_Perspective, fk_Frustum, fk_Ortho の 各マニュアルを参照して下さい。

参照
  fk_Scene, fk_Fog, fk_Model, fk_Perspective, , fk_Frustum, fk_Ortho

## 関数詳解

## ◆ ClearDisplay()

void FK_CLI::fk_DisplayLink::ClearDisplay | ( | void |  | ) |

初期化メソッド

ディスプレイリストに登録されていた全ての情報を解除します。 解除する対象は通常表示モデル、モデルオーバーレイモデル、 カメラ、投影設定です。

## ◆ ClearStereo()

void FK_CLI::fk_DisplayLink::ClearStereo | ( | void |  | ) |

立体視用設定情報初期化メソッド

立体視モードで使用する設定情報を初期化します。

## ◆ EntryModel()

void FK_CLI::fk_DisplayLink::EntryModel | ( | fk_Model ^ | model | ) |

通常モデル登録メソッド

通常モデルをディスプレイリストに登録します。

引数

  [in] | model | 登録モデルのアドレス

## ◆ RemoveModel()

void FK_CLI::fk_DisplayLink::RemoveModel | ( | fk_Model ^ | model | ) |

通常モデル解除メソッド

ディスプレイリストに登録されている通常モデルに対し、 登録を解除します。 もし登録されていないモデルが指定された場合は、 特に何も起こりません。

引数

  [in] | model | 解除モデルのアドレス

## ◆ ClearModel()

void FK_CLI::fk_DisplayLink::ClearModel | ( | void |  | ) |

通常モデル全解除メソッド

ディスプレイリストに登録されている全ての通常モデルに対し、 登録を解除します。

## ◆ EntryOverlayModel()

void FK_CLI::fk_DisplayLink::EntryOverlayModel | ( | fk_Model ^ | model | ) |

オーバーレイモデル登録メソッド

オーバーレイモデルをディスプレイリストに登録します。 オーバーレイモデルは、後に登録したものほど前面に表示されるようになります。 もし既に登録されているモデルを再度登録した場合は、 一度解除したのちに改めて登録しなおすことと同義となります。

引数

  [in] | model | 登録モデルのアドレス

## ◆ RemoveOverlayModel()

void FK_CLI::fk_DisplayLink::RemoveOverlayModel | ( | fk_Model^ | model | ) |

オーバーレイモデル解除メソッド

ディスプレイリストに登録されているオーバーレイモデルに対し、 登録を解除します。 もし登録されていないモデルが指定された場合は、 特に何も起こりません。

引数

  [in] | model | 解除モデルのアドレス

## ◆ ClearOverlayModel()

void FK_CLI::fk_DisplayLink::ClearOverlayModel | ( | void |  | ) |

オーバーレイモデル全解除メソッド

ディスプレイリストに登録されている全てのオーバーレイモデルに対し、 登録を解除します。

## プロパティ詳解

## ◆ Camera

fk_Model^ FK_CLI::fk_DisplayLink::Camera

getset

カメラモデルプロパティ

ディスプレイリストでのカメラモデルの設定・参照を行います。

参照
  fk_Model

## ◆ LeftCamera

fk_Model^ FK_CLI::fk_DisplayLink::LeftCamera

getset

立体視用左眼カメラプロパティ

立体視における左眼を表すカメラモデルの設定・参照を行います。

参照
  fk_Model

## ◆ RightCamera

fk_Model^ FK_CLI::fk_DisplayLink::RightCamera

getset

立体視用右眼カメラプロパティ

立体視における右眼を表すカメラモデルの設定・参照を行います。

参照
  fk_Model

## ◆ Projection

fk_ProjectBase^ FK_CLI::fk_DisplayLink::Projection

getset

投影設定プロパティ

シーンにおける投影状態の設定・参照を行います。

参照
  fk_Perspective, fk_Ortho, fk_Frustum

## ◆ LeftProjection

fk_ProjectBase^ FK_CLI::fk_DisplayLink::LeftProjection

getset

立体視用左眼投影プロパティ

立体視における、左眼を表すカメラ投影状態の設定・参照を行います。

参照
  fk_Perspective, fk_Ortho, fk_Frustum

## ◆ RightProjection

fk_ProjectBase^ FK_CLI::fk_DisplayLink::RightProjection

getset

立体視用右眼投影プロパティ

立体視における、右眼を表すカメラ投影状態の設定・参照を行います。

参照
  fk_Perspective, fk_Ortho, fk_Frustum

## ◆ StereoOverlayMode

bool FK_CLI::fk_DisplayLink::StereoOverlayMode

getset

立体視モード時のオーバーレイ描画モードプロパティ

立体視モード時のオーバーレイ描画モデルに対する動作の設定・参照を行います。 一般的なゲームアプリケーションでは、3DCG をレンダリングした画面上に 2D の画像や文字などを情報として表示(いわゆる HUD 表示)しますが、 立体視を有効にした場合はそれらの表示にも視差が適用されます。 この動作は状況によっては望ましくない場合もあります。 このプロパティによって、オーバーレイ描画を行うモデルに対して視差を適用するか、 しないかを選択することができます。 HUD 表示はオーバーレイ描画によって実現することが多いため、 多くの場合はこのプロパティによる設定で十分制御が可能となるはずです。 デフォルトではオーバーレイ描画モデルにも視差を適用する設定(true)になっています。 true だった場合、オーバーレイ描画モデルの視差を有効にします。 false だった場合、オーバーレイ描画モデルの視差を無効にします。