AbyssLib 1.301
あびす謹製ノベルゲームフレームワークライブラリ

クラス TaskManager

描画タスク・スプライト・ボタン管理クラスの基底クラスです。 [詳細]

#include <TaskManager.h>

TaskManagerに対する継承グラフ
ITaskManager

すべてのメンバ一覧

Public メソッド

 TaskManager ()
 デフォルトコンストラクタです。
void Initialize ()
 初期化を行います。
void SetParent (INovelEngine *Parent)
 親エンジンを設定します。
void SetMaxZ (int z)
 Z座標の最大値を設定します。
void SetMinZ (int z)
 Z座標の最小値を設定します。
void SetReservedZBG (int z)
 背景のZ座標を設定します。
void SetReservedZCh1 (int z)
 立ち絵のZ座標を設定します。
void SetReservedZCh2 (int z)
 立ち絵のZ座標を設定します。
void SetReservedZCh3 (int z)
 立ち絵のZ座標を設定します。
void SetBG (const DrawTask &Task)
 背景の描画タスクを設定します。
void SetLCh (const DrawTask &Task)
 立ち絵(左)の描画タスクを設定します。
void SetCCh (const DrawTask &Task)
 立ち絵(中央)の描画タスクを設定します。
void SetRCh (const DrawTask &Task)
 立ち絵(右)の描画タスクを設定します。
void SetChPriority (unsigned int ChPriority)
 立ち絵の表示順を設定します。
void SetCharaSpace (unsigned int Space)
 立ち絵と画面左右端の間隔を設定します。
void AddSprite (const char *SpriteName)
 スプライトを新規追加します。
bool FindSprite (const char *SpriteName) const
 スプライトが存在するか?を取得します。
void SetAllSpriteShow (bool IsShow)
 全スプライトの表示状態を設定します。
void SetSpriteShow (const char *SpriteName, bool IsShow)
 スプライトの表示状態を設定します。
void SetSprite (const char *SpriteName, int x, int y, int z, BYTE a)
 スプライトの表示位置や透過度を絶対的に設定します。
void MoveSprite (const char *SpriteName, int x, int y, int z, int a)
 スプライトの表示位置や透過度を相対的に設定します。
相対基準は、本メソッドを前回呼び出した時に設定した値です。
void SetSpriteImage (const char *SpriteName, const char *FileName, unsigned int BltType, RECT Image)
 スプライトの画像を設定します。
void SetSpriteText (const char *SpriteName, const TextTokenSection &Text)
 スプライトのテキストを設定します。
void SetSprite (const char *SpriteName, const DrawTask &Task)
 スプライトを描画タスクで設定します。
void AddButton (const char *ButtonName)
 ボタンを新規追加します。
bool FindButton (const char *ButtonName) const
 ボタンが存在するか?を取得します。
void SetAllButtonShow (bool IsShow)
 全ボタンの表示状態を設定します。
void SetButtonShow (const char *ButtonName, bool IsShow)
 ボタンの表示状態を設定します。
void SetAllButtonEnable (bool IsEnable)
 全ボタンの有効状態を設定します。
void SetButtonEnable (const char *ButtonName, bool IsEnable)
 ボタンの有効状態を設定します。
void SetButton (const char *ButtonName, int x, int y, int z, BYTE a)
 ボタンの表示位置や透過度を絶対的に設定します。
void MoveButton (const char *ButtonName, int x, int y, int z, int a)
 ボタンの表示位置や透過度を相対的に設定します。
相対基準は、本メソッドを前回呼び出した時に設定した値です。
void SetButtonImage (const char *ButtonName, const char *FileName, unsigned int BltType, RECT Normal, RECT OnCursor, RECT OnHold, RECT Disable)
 ボタンの画像を設定します。
void SetButton (const char *ButtonName, const DrawTask &Task)
 ボタンを描画タスクで設定します。
void SetButtonClickRect (const char *ButtonName, RECT ClickRect)
 ボタンの判定矩形を設定します。
void SetButtonDestLabel (const char *ButtonName, const char *DestLabel)
 ボタンのクリック時遷移先ラベルを設定します。
void SetButtonSound (const char *ButtonName, const char *OnCursor, const char *OnClick)
 ボタンのSEを設定します。
void CheckButton ()
 ボタンの押下状態を検知し、状態を更新します。
void EnterBRCS ()
 ButtonResponseCriticalSection(BRCS、ボタン検知の排他的制御)に入ります、一時的に全てのボタンを無効にします。
void LeaveBRCS ()
 ButtonResponseCriticalSection(BRCS、ボタン検知の排他的制御)から出ます、全てのボタンの有効無効が元に戻ります。
void EnterBVCS ()
 ButtonVisibleCriticalSection(BVCS、ボタン表示の排他的制御)に入ります、一時的に全てのボタンを非表示とします。
void LeaveBVCS ()
 ButtonVisibleCriticalSection(BVCS、ボタン表示の排他的制御)から出ます、全てのボタンの表示非表示が元に戻ります。
void Update ()
 画面更新を行います。
int GetUpdateType () const
 現在実行中の画面更新の種類を取得します。
void SetUpdateParam (const UpdateParam &Parameter)
 実行する画面更新を設定します。
void ExecuteEffect1 ()
 画面効果を行います。
void ExecuteEffect2 ()
 画面効果を行います。
void ExecuteEffect3 ()
 画面効果を行います。
int GetEffectType () const
 現在実行中の画面効果の種類を取得します。
void SetEffectParam (const EffectParam &Parameter)
 実行する画面効果を設定します。
void SaveL (IIOStream *IOStream)
 ローカル設定の保存を行います。
void LoadL (IIOStream *IOStream)
 ローカル設定の読み込みを行います。
vector< DrawTask > & GetTaskList ()
 描画タスクリストを取得します。
const vector< DrawTask > & GetTaskList () const
 描画タスクリストを取得します。
bool IsUsedSE (const char *FileName) const
 音声ファイルが現在使用されているかを取得します。
bool IsUsedImage (const char *FileName) const
 画像ファイルが現在使用されているかを取得します。

フレンド

class TMAccessor
 TMAccessor クラスから本クラスのプライベートメンバにアクセス可能です。

説明

描画タスク・スプライト・ボタン管理クラスの基底クラスです。

本クラスは全ての描画タスク・スプライト・ボタンの管理を行います。


コンストラクタとデストラクタ

デフォルトコンストラクタです。


関数

void Initialize ( )

初期化を行います。

void SetParent ( INovelEngine *  Parent)

親エンジンを設定します。

本クラスの親となるノベルエンジンクラスを設定します。

引数:
Parent[in]本クラスの親となるノベルエンジンクラスを指定します。
void SetMaxZ ( int  z) [virtual]

Z座標の最大値を設定します。

Z座標最大値のデフォルト値は DEFAULT_MAX_Z です。
Z座標を設定するメソッドでこの値より大きな値を設定しようとした場合、ランタイムエラーが発生します。

引数:
z[in]Z座標の最大値を指定します。

ITaskManagerを実装しています。

void SetMinZ ( int  z) [virtual]

Z座標の最小値を設定します。

Z座標最小値のデフォルト値は DEFAULT_MIN_Z です。
Z座標を設定するメソッドでこの値より小さな値を設定しようとした場合、ランタイムエラーが発生します。

引数:
z[in]Z座標の最小値を指定します。

ITaskManagerを実装しています。

void SetReservedZBG ( int  z) [virtual]

背景のZ座標を設定します。

背景のZ座標のデフォルト値は DEFAULT_RESERVED_Z_BG です。

引数:
z[in]背景のZ座標を指定します。

ITaskManagerを実装しています。

void SetReservedZCh1 ( int  z) [virtual]

立ち絵のZ座標を設定します。

本メソッドでは一番目に表示される立ち絵のZ座標を設定します。
立ち絵のZ座標のデフォルト値は DEFAULT_RESERVED_Z_CH1 です。

引数:
z[in]立ち絵のZ座標を指定します。

ITaskManagerを実装しています。

void SetReservedZCh2 ( int  z) [virtual]

立ち絵のZ座標を設定します。

本メソッドでは二番目に表示される立ち絵のZ座標を設定します。
立ち絵のZ座標のデフォルト値は DEFAULT_RESERVED_Z_CH2 です。

引数:
z[in]立ち絵のZ座標を指定します。

ITaskManagerを実装しています。

void SetReservedZCh3 ( int  z) [virtual]

立ち絵のZ座標を設定します。

本メソッドでは三番目に表示される立ち絵のZ座標を設定します。
立ち絵のZ座標のデフォルト値は DEFAULT_RESERVED_Z_CH3 です。

引数:
z[in]立ち絵のZ座標を指定します。

ITaskManagerを実装しています。

void SetBG ( const DrawTask Task) [virtual]

背景の描画タスクを設定します。

引数:
Task[in]背景の描画タスクを指定します。
描画タスクの転送元矩形が誤った指定の場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetLCh ( const DrawTask Task) [virtual]

立ち絵(左)の描画タスクを設定します。

引数:
Task[in]立ち絵(左)の描画タスクを指定します。
描画タスクの転送元矩形が誤った指定の場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetCCh ( const DrawTask Task) [virtual]

立ち絵(中央)の描画タスクを設定します。

引数:
Task[in]立ち絵(中央)の描画タスクを指定します。
描画タスクの転送元矩形が誤った指定の場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetRCh ( const DrawTask Task) [virtual]

立ち絵(右)の描画タスクを設定します。

引数:
Task[in]立ち絵(右)の描画タスクを指定します。
描画タスクの転送元矩形が誤った指定の場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetChPriority ( unsigned int  ChPriority) [virtual]

立ち絵の表示順を設定します。

引数:
ChPriority[in]立ち絵の表示順を指定します。
TASKMANAGER_CHPRIORITY 列挙型で指定します。
誤った指定の場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetCharaSpace ( unsigned int  Space) [virtual]

立ち絵と画面左右端の間隔を設定します。

引数:
Space[in]立ち絵と画面左右端の間隔を指定します。

ITaskManagerを実装しています。

void AddSprite ( const char *  SpriteName) [virtual]

スプライトを新規追加します。

引数:
SpriteName[in]スプライト名を指定します。
既存のスプライト名を指定した場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

bool FindSprite ( const char *  SpriteName) const [virtual]

スプライトが存在するか?を取得します。

引数:
SpriteName[in]スプライト名を指定します。
戻り値:
スプライトが存在するか?を返します。
存在する場合はtrueを、存在しない場合はfalseを返します。

ITaskManagerを実装しています。

void SetAllSpriteShow ( bool  IsShow) [virtual]

全スプライトの表示状態を設定します。

引数:
IsShow[in]表示状態を指定します。
表示する場合はtrueを、表示しない場合はfalseを指定します。

ITaskManagerを実装しています。

void SetSpriteShow ( const char *  SpriteName,
bool  IsShow 
) [virtual]

スプライトの表示状態を設定します。

引数:
SpriteName[in]スプライト名を指定します。
存在しないスプライト名を指定した場合、ランタイムエラーが発生します。
IsShow[in]表示状態を指定します。
表示する場合はtrueを、表示しない場合はfalseを指定します。

ITaskManagerを実装しています。

void SetSprite ( const char *  SpriteName,
int  x,
int  y,
int  z,
BYTE  a 
) [virtual]

スプライトの表示位置や透過度を絶対的に設定します。

引数:
SpriteName[in]スプライト名を指定します。
存在しないスプライト名を指定した場合、ランタイムエラーが発生します。
x[in]X座標を指定します。
y[in]Y座標を指定します。
z[in]Z座標を指定します。
範囲外を指定した場合、ランタイムエラーが発生します。
a[in]透過度を指定します。

ITaskManagerを実装しています。

void MoveSprite ( const char *  SpriteName,
int  x,
int  y,
int  z,
int  a 
) [virtual]

スプライトの表示位置や透過度を相対的に設定します。
相対基準は、本メソッドを前回呼び出した時に設定した値です。

引数:
SpriteName[in]スプライト名を指定します。
存在しないスプライト名を指定した場合、ランタイムエラーが発生します。
x[in]X座標を指定します。
y[in]Y座標を指定します。
z[in]Z座標を指定します。
指定した値で範囲外になった場合、ランタイムエラーが発生します。
a[in]透過度を指定します。
指定した値で範囲外になった場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetSpriteImage ( const char *  SpriteName,
const char *  FileName,
unsigned int  BltType,
RECT  Image 
) [virtual]

スプライトの画像を設定します。

引数:
SpriteName[in]スプライト名を指定します。
存在しないスプライト名を指定した場合、ランタイムエラーが発生します。
FileName[in]画像ファイル名を指定します。
BltType[in]転送方法を指定します。
DRAWTASK_BLTTYPE 列挙型で指定します。
Image[in]転送元矩形を指定します。
誤った指定の場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetSpriteText ( const char *  SpriteName,
const TextTokenSection &  Text 
) [virtual]

スプライトのテキストを設定します。

引数:
SpriteName[in]スプライト名を指定します。
存在しないスプライト名を指定した場合、ランタイムエラーが発生します。
Text[in]テキストを指定します。

ITaskManagerを実装しています。

void SetSprite ( const char *  SpriteName,
const DrawTask Task 
) [virtual]

スプライトを描画タスクで設定します。

引数:
SpriteName[in]スプライト名を指定します。
Task[in]描画タスクを指定します。
誤った転送元矩形の場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void AddButton ( const char *  ButtonName) [virtual]

ボタンを新規追加します。

排他制御(BRCSまたはBVCS)内の場合、ランタイムエラーが発生します。

引数:
ButtonName[in]ボタン名を指定します。
既存のボタン名を指定した場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

bool FindButton ( const char *  ButtonName) const [virtual]

ボタンが存在するか?を取得します。

引数:
ButtonName[in]ボタン名を指定します。
戻り値:
ボタンが存在するか?を返します。
存在する場合はtrueを、存在しない場合はfalseを返します。

ITaskManagerを実装しています。

void SetAllButtonShow ( bool  IsShow) [virtual]

全ボタンの表示状態を設定します。

排他制御(BVCS)内の場合、ランタイムエラーが発生します。

引数:
IsShow[in]表示状態を指定します。
表示する場合はtrueを、表示しない場合はfalseを指定します。

ITaskManagerを実装しています。

void SetButtonShow ( const char *  ButtonName,
bool  IsShow 
) [virtual]

ボタンの表示状態を設定します。

排他制御(BVCS)内の場合、ランタイムエラーが発生します。

引数:
ButtonName[in]ボタン名を指定します。
存在しないボタン名を指定した場合、ランタイムエラーが発生します。
IsShow[in]表示状態を指定します。
表示する場合はtrueを、表示しない場合はfalseを指定します。

ITaskManagerを実装しています。

void SetAllButtonEnable ( bool  IsEnable) [virtual]

全ボタンの有効状態を設定します。

排他制御(BRCS)内の場合、ランタイムエラーが発生します。

引数:
IsEnable[in]有効状態を指定します。
有効状態の場合はtrueを、無効状態の場合はfalseを指定します。

ITaskManagerを実装しています。

void SetButtonEnable ( const char *  ButtonName,
bool  IsEnable 
) [virtual]

ボタンの有効状態を設定します。

排他制御(BRCS)内の場合、ランタイムエラーが発生します。

引数:
ButtonName[in]ボタン名を指定します。
存在しないボタン名を指定した場合、ランタイムエラーが発生します。
IsEnable[in]有効状態を指定します。
有効状態の場合はtrueを、無効状態の場合はfalseを指定します。

ITaskManagerを実装しています。

void SetButton ( const char *  ButtonName,
int  x,
int  y,
int  z,
BYTE  a 
) [virtual]

ボタンの表示位置や透過度を絶対的に設定します。

引数:
ButtonName[in]ボタン名を指定します。
存在しないボタン名を指定した場合、ランタイムエラーが発生します。
x[in]X座標を指定します。
y[in]Y座標を指定します。
z[in]Z座標を指定します。
範囲外を指定した場合、ランタイムエラーが発生します。
a[in]透過度を指定します。

ITaskManagerを実装しています。

void MoveButton ( const char *  ButtonName,
int  x,
int  y,
int  z,
int  a 
) [virtual]

ボタンの表示位置や透過度を相対的に設定します。
相対基準は、本メソッドを前回呼び出した時に設定した値です。

引数:
ButtonName[in]ボタン名を指定します。
存在しないボタン名を指定した場合、ランタイムエラーが発生します。
x[in]X座標を指定します。
y[in]Y座標を指定します。
z[in]Z座標を指定します。
指定した値で範囲外になった場合、ランタイムエラーが発生します。
a[in]透過度を指定します。
指定した値で範囲外になった場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetButtonImage ( const char *  ButtonName,
const char *  FileName,
unsigned int  BltType,
RECT  Normal,
RECT  OnCursor,
RECT  OnHold,
RECT  Disable 
) [virtual]

ボタンの画像を設定します。

引数:
ButtonName[in]ボタン名を指定します。
存在しないボタン名を指定した場合、ランタイムエラーが発生します。
FileName[in]画像ファイル名を指定します。
BltType[in]転送方法を指定します。
DRAWTASK_BLTTYPE 列挙型で指定します。
Normal[in]転送元矩形(通常時)を指定します。
誤った指定の場合、ランタイムエラーが発生します。
OnCursor[in]転送元矩形(カーソル時)を指定します。
誤った指定の場合、ランタイムエラーが発生します。
OnHold[in]転送元矩形(クリック時)を指定します。
誤った指定の場合、ランタイムエラーが発生します。
Disable[in]転送元矩形(無効時)を指定します。
誤った指定の場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetButton ( const char *  ButtonName,
const DrawTask Task 
) [virtual]

ボタンを描画タスクで設定します。

引数:
ButtonName[in]ボタン名を指定します。
Task[in]描画タスクを指定します。
誤った転送元矩形の場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetButtonClickRect ( const char *  ButtonName,
RECT  ClickRect 
) [virtual]

ボタンの判定矩形を設定します。

引数:
ButtonName[in]ボタン名を指定します。
存在しないボタン名を指定した場合、ランタイムエラーが発生します。
ClickRect[in]判定矩形を相対的に指定します。
相対基準はボタンの表示位置(X、Y)です。
誤った指定の場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetButtonDestLabel ( const char *  ButtonName,
const char *  DestLabel 
) [virtual]

ボタンのクリック時遷移先ラベルを設定します。

引数:
ButtonName[in]ボタン名を指定します。
存在しないボタン名を指定した場合、ランタイムエラーが発生します。
DestLabel[in]クリック時遷移先ラベルを指定します。
存在しないラベル名を指定した場合、ランタイムエラーが発生します。

ITaskManagerを実装しています。

void SetButtonSound ( const char *  ButtonName,
const char *  OnCursor,
const char *  OnClick 
) [virtual]

ボタンのSEを設定します。

引数:
ButtonName[in]ボタン名を指定します。
存在しないボタン名を指定した場合、ランタイムエラーが発生します。
OnCursor[in]カーソル時SEを指定します。
OnClick[in]クリック時SEを指定します。

ITaskManagerを実装しています。

void CheckButton ( )

ボタンの押下状態を検知し、状態を更新します。

void EnterBRCS ( )

ButtonResponseCriticalSection(BRCS、ボタン検知の排他的制御)に入ります、一時的に全てのボタンを無効にします。

また、BRCSに入っている間はAddButtonメソッドとSetAllButtonEnableメソッドとSetButtonEnableメソッドの呼び出しが禁止となります(呼び出した場合はランタイムエラーが発生します)
重複しての呼び出しは禁止です、BRCSに入っている間に再度本メソッドを呼ぶとランタイムエラーが発生します。

void LeaveBRCS ( )

ButtonResponseCriticalSection(BRCS、ボタン検知の排他的制御)から出ます、全てのボタンの有効無効が元に戻ります。

重複しての呼び出しは禁止です、BRCSに入っていないのに本メソッドを呼ぶとランタイムエラーが発生します。

void EnterBVCS ( )

ButtonVisibleCriticalSection(BVCS、ボタン表示の排他的制御)に入ります、一時的に全てのボタンを非表示とします。

また、BVCSに入っている間はAddButtonメソッドとSetAllButtonVisibleメソッドとSetButtonVisibleメソッドの呼び出しが禁止となります(呼び出した場合はランタイムエラーが発生します)
重複しての呼び出しは禁止です、BVCSに入っている間に再度本メソッドを呼ぶとランタイムエラーが発生します。

void LeaveBVCS ( )

ButtonVisibleCriticalSection(BVCS、ボタン表示の排他的制御)から出ます、全てのボタンの表示非表示が元に戻ります。

重複しての呼び出しは禁止です、BVCSに入っていないのに本メソッドを呼ぶとランタイムエラーが発生します。

void Update ( )

画面更新を行います。

不正な画面更新パターンが設定されていた場合、ランタイムエラーが発生します。

int GetUpdateType ( ) const [virtual]

現在実行中の画面更新の種類を取得します。

戻り値:
現在実行中の画面更新の種類を返します。

ITaskManagerを実装しています。

void SetUpdateParam ( const UpdateParam Parameter) [virtual]

実行する画面更新を設定します。

引数:
Parameter[in]実行する画面更新を指定します。
nsAbyssLib::nsTaskManager::UpdateParam 構造体で指定します。

ITaskManagerを実装しています。

void ExecuteEffect1 ( )

画面効果を行います。

本メソッドは他の描画の前に実行されます。
不正な画面効果パターンが設定されていた場合、ランタイムエラーが発生します。

void ExecuteEffect2 ( )

画面効果を行います。

テキストウインドウ描画前に実行されます。
不正な画面効果パターンが設定されていた場合、ランタイムエラーが発生します。

void ExecuteEffect3 ( )

画面効果を行います。

テキストウインドウ描画後に実行されます。
不正な画面効果パターンが設定されていた場合、ランタイムエラーが発生します。

int GetEffectType ( ) const [virtual]

現在実行中の画面効果の種類を取得します。

戻り値:
現在実行中の画面効果の種類を返します。

ITaskManagerを実装しています。

void SetEffectParam ( const EffectParam Parameter) [virtual]

実行する画面効果を設定します。

引数:
Parameter[in]実行する画面効果を指定します。
nsAbyssLib::nsTaskManager::EffectParam 構造体で指定します。

ITaskManagerを実装しています。

void SaveL ( IIOStream *  IOStream)

ローカル設定の保存を行います。

引数:
IOStream[in]データ入出力クラスを指定します。
void LoadL ( IIOStream *  IOStream)

ローカル設定の読み込みを行います。

引数:
IOStream[in]データ入出力クラスを指定します。
vector<DrawTask>& GetTaskList ( )

描画タスクリストを取得します。

戻り値:
描画タスクリストを返します。
const vector<DrawTask>& GetTaskList ( ) const

描画タスクリストを取得します。

戻り値:
描画タスクリストを返します。
bool IsUsedSE ( const char *  FileName) const [virtual]

音声ファイルが現在使用されているかを取得します。

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
音声ファイルが現在使用されているかを返します。
使用されている場合はtrueを、そうでない場合はfalseを返します。

ITaskManagerを実装しています。

bool IsUsedImage ( const char *  FileName) const [virtual]

画像ファイルが現在使用されているかを取得します。

引数:
FileName[in]画像ファイル名を指定します。
戻り値:
画像ファイルが現在使用されているかを返します。
使用されている場合はtrueを、そうでない場合はfalseを返します。

ITaskManagerを実装しています。


フレンドと関連する関数

friend class TMAccessor [friend]

TMAccessor クラスから本クラスのプライベートメンバにアクセス可能です。


このクラスの説明は次のファイルから生成されました:
 全て クラス ネームスペース ファイル 関数 変数 型定義 列挙型 列挙型の値 フレンド マクロ定義