アニメ表示コントロールクラス [詳解]

#include <TnbMfcAnimateStatic.h>

CAnimateStatic の継承関係図

公開メンバ関数
bool	AddBaseFrame (CBitmapHandle bmp, UINT count, const IBitmapWipable &wiper)
	[設定] 次のベースフレーム画像設定 [詳解]

bool	AddBaseFrame (CBitmapHandle bmp, UINT count=1)
	[設定] 次のベースフレーム画像設定 [詳解]

	CAnimateStatic (void)
	コンストラクタ [詳解]

void	FlashCache (void)
	[処理] キャッシュ消去 [詳解]

CBitmapHandle	FrameAt (INDEX index) const
	[取得] フレーム取得 [詳解]

CBitmapHandle	FrameAtWithCache (INDEX index)
	[取得] フレーム取得 [詳解]

DWORD	GetExStyle (void) const
	[取得] ウィンドウ拡張スタイル取得. [詳解]

size_t	GetLength (void) const
	[取得] フレーム数取得 [詳解]

HWND	GetSafeHwnd (void) const
	[取得] ウィンドウハンドル取得. [詳解]

DWORD	GetStyle (void) const
	[取得] ウィンドウスタイル取得. [詳解]

BOOL	ModifyStyle (DWORD dwRemove, DWORD dwAdd, UINT nFlags=0)
	[設定] ウィンドウスタイル変更. [詳解]

BOOL	ModifyStyleEx (DWORD dwRemove, DWORD dwAdd, UINT nFlags=0)
	[設定] ウィンドウ拡張スタイル変更. [詳解]

bool	SetClientRgn (HRGN rgn)
	[設定] ウィンドウリージョン設定. [詳解]

bool	SetFirstFrame (CBitmapHandle bmp)
	[設定] 最初のフレーム画像設定 [詳解]

bool	SetFirstFrame (CBitmapHandle bmp, const IBitmapWipable &defaultWiper)
	[設定] 最初のフレーム画像設定 [詳解]

BOOL	SetWindowPos (const CWnd *pWndInsertAfter, int x, int y, int cx, int cy, UINT nFlags)
	[設定] ウィンドウサイズポジション設定. [詳解]

BOOL	ShowWindow (int nCmdShow)
	[設定] ウィンドウ表示状態. [詳解]

bool	StartAnimation (bool mode, DWORD interval, bool useCache=false, bool isStopInDrag=false)
	[設定] アニメ設定. [詳解]

void	StopAnimation (void)
	[設定] アニメ停止 [詳解]

限定公開メンバ関数
void	DeleteClientRgnHandle (void)
	[削除] クライアントリージョン破棄 [詳解]

virtual void	PreSubclassWindow (void)
	[通知] subclassing/unsubclassing functions. [詳解]

virtual LRESULT	WindowProc (UINT message, WPARAM wParam, LPARAM lParam)
	[通知] for processing Windows messages. [詳解]

限定公開変数類
HRGN	m_clientRgn
	クライアントリージョン [詳解]

詳解

アニメ表示コントロールクラス

覚え書き: Disable時、アニメを一時停止し、 Enable時に再開します。; Hide時、アニメを停止し、Show時、頭から再生します。

使い方: リソースエディタでスタティックコントロールを張り、コントロール変数に割り当て後、そのコントロール変数の型（CStatic）を本クラスに置き換えて使用します。

使用例

    // ダイアログのヘッダ、ダイアログクラスのメンバ。
    CAnimateStatic m_anime;

    // OnInitDialog() 内
    m_anime.SetFirstFrame("1.bmp", CPenetrateWiper());
    m_anime.AddBaseFrame("1.bmp", 5);
    m_anime.AddBaseFrame("2.bmp", 5);
    m_anime.AddBaseFrame("3.bmp", 5);
    m_anime.AddBaseFrame("4.bmp", 5);
    ASSERT( anime.GetLength() == 21 ); 
    m_anime.SetAnimationParameter(false, 1000 / 21, false, true);

必要ファイル: TnbMfcAnimateStatic.h

日付: 07/11/14 新規作成; 07/11/30 CBitmapAnimater 使用するように変更。; 07/12/04 HIDE時、Disable時に、アニメ停止するように変更。; 07/12/12 リージョン指定を可能にした。; 09/04/15 SetAnimationParameter() を StartAnimation()に改名。

TnbMfcAnimateStatic.h の 60 行目に定義があります。

構築子と解体子

◆ CAnimateStatic()

CAnimateStatic ( void )

コンストラクタ

TnbMfcAnimateStatic.h の 67 行目に定義があります。

関数詳解

◆ AddBaseFrame() [1/2]

bool AddBaseFrame	(	CBitmapHandle	bmp,
		UINT	count,
		const IBitmapWipable &	wiper
	)

inherited

[設定] 次のベースフレーム画像設定

引数

bmp	ビットマップ
count	何フレーム追加するか。 1 ならワイパーは使わず、切り替わります。
wiper	一つ前のベース画像から本画像の切り替えで使うワイパー。複製を記憶しますので、破棄してかまいません。

戻り値

true	成功
false	失敗

TnbBitmapAnimater.h の 463 行目に定義があります。

◆ AddBaseFrame() [2/2]

bool AddBaseFrame	(	CBitmapHandle	bmp,
		UINT	count = `1`
	)

inherited

[設定] 次のベースフレーム画像設定

覚え書き: ワイパーは SetFirstFrame() 時に指定したものを使います。

引数

bmp	ビットマップ
count	何フレーム追加するか。 1 ならワイパーは使わず、切り替わります。

戻り値

true	成功
false	失敗

TnbBitmapAnimater.h の 480 行目に定義があります。

◆ DeleteClientRgnHandle()

void DeleteClientRgnHandle ( void )

protectedinherited

[削除] クライアントリージョン破棄

TnbMfcRgnControl.h の 44 行目に定義があります。

◆ FlashCache()

void FlashCache ( void )

inherited

[処理] キャッシュ消去

TnbBitmapAnimater.h の 560 行目に定義があります。

◆ FrameAt()

CBitmapHandle FrameAt ( INDEX index ) const

inherited

[取得] フレーム取得

覚え書き: 取得時に画像を合成します。

引数

index フレームNO。０以上、 GetLength() の値未満です。

戻り値: フレーム画像。

TnbBitmapAnimater.h の 504 行目に定義があります。

◆ FrameAtWithCache()

CBitmapHandle FrameAtWithCache ( INDEX index )

inherited

[取得] フレーム取得

覚え書き: 初めての取得時に画像を合成し、キャッシュします。

引数

index フレームNO。０以上、 GetLength() の値未満です。

戻り値: フレーム画像。

TnbBitmapAnimater.h の 540 行目に定義があります。

◆ GetExStyle()

DWORD GetExStyle ( void ) const

inherited

[取得] ウィンドウ拡張スタイル取得.

本インスタンスが管理しているウィンドウの拡張スタイルを返します。

戻り値: ウィンドウスタイル。 WS_EX_LEFT や WS_EX_TOPMOST などのシンボルが論理和(or)されている。

◆ GetLength()

size_t GetLength ( void ) const

inherited

[取得] フレーム数取得

戻り値: フレーム数。

TnbBitmapAnimater.h の 493 行目に定義があります。

◆ GetSafeHwnd()

HWND GetSafeHwnd ( void ) const

inherited

[取得] ウィンドウハンドル取得.

本インスタンスが管理しているウィンドウのハンドルを返します。

戻り値: ウィンドウハンドル

◆ GetStyle()

DWORD GetStyle ( void ) const

inherited

[取得] ウィンドウスタイル取得.

本インスタンスが管理しているウィンドウのスタイルを返します。

戻り値: ウィンドウスタイル。 WS_CHILD や WS_MINIMIZE などのシンボルが論理和(or)されている。

◆ ModifyStyle()

BOOL ModifyStyle	(	DWORD	dwRemove,
		DWORD	dwAdd,
		UINT	nFlags = `0`
	)

inherited

[設定] ウィンドウスタイル変更.

引数

dwRemove	除去するスタイルを指定する。
dwAdd	追加するスタイルを指定する。
nFlags	SetWindowPos() に渡すフラグ。０なら SetWindowPos() を呼びません。

戻り値

TRUE	成功.
FALSE	失敗.

◆ ModifyStyleEx()

BOOL ModifyStyleEx	(	DWORD	dwRemove,
		DWORD	dwAdd,
		UINT	nFlags = `0`
	)

inherited

[設定] ウィンドウ拡張スタイル変更.

引数

dwRemove	除去する拡張スタイルを指定する。
dwAdd	追加する拡張スタイルを指定する。
nFlags	SetWindowPos() に渡すフラグ。０なら SetWindowPos() を呼びません。

戻り値

TRUE	成功.
FALSE	失敗.

◆ PreSubclassWindow()

virtual void PreSubclassWindow ( void )

protectedvirtual

[通知] subclassing/unsubclassing functions.

サブクラス化する時コールされます。

覚え書き: CWndのメソッドをオーバーライドしています。

TnbMfcAnimateStatic.h の 265 行目に定義があります。

◆ SetClientRgn()

bool SetClientRgn ( HRGN rgn )

inherited

[設定] ウィンドウリージョン設定.

引数

rgn リージョン。

戻り値

true	成功。指定した rgn は本オブジェクトが管理するので、破棄しないでください（不必要になったら破棄します）。
false	失敗。指定した rgn は有効なので、 DeleteObject する必要があります。

TnbMfcRgnControl.h の 117 行目に定義があります。

◆ SetFirstFrame() [1/2]

bool SetFirstFrame ( CBitmapHandle bmp )

[設定] 最初のフレーム画像設定

覚え書き: これを実行すると、今までの情報はクリアされます。

引数

bmp ビットマップ

戻り値

true	成功
false	失敗

TnbMfcAnimateStatic.h の 135 行目に定義があります。

◆ SetFirstFrame() [2/2]

bool SetFirstFrame	(	CBitmapHandle	bmp,
		const IBitmapWipable &	defaultWiper
	)

[設定] 最初のフレーム画像設定

覚え書き: これを実行すると、今までの情報はクリアされます。

引数

bmp	ビットマップ
defaultWiper	AddBaseFrame() でワイパーが省略された時に使用されるワイパー。複製を記憶しますので、破棄してかまいません。

戻り値

true	成功
false	失敗

TnbMfcAnimateStatic.h の 121 行目に定義があります。

◆ SetWindowPos()

BOOL SetWindowPos	(	const CWnd *	pWndInsertAfter,
		int	x,
		int	y,
		int	cx,
		int	cy,
		UINT	nFlags
	)

inherited

[設定] ウィンドウサイズポジション設定.

子ウィンドウ、ポップアップウィンドウ、およびトップレベルウィンドウのサイズ、位置、および Z オーダーを変更します。

引数

pWndInsertAfter	Z オーダーでこの CWnd オブジェクトより前に配置される CWnd オブジェクトを識別します。このパラメータへは、 CWnd へのポインタか次の値のいずれか 1 つを指定できます。 wndBottom ウィンドウを Z オーダーの一番下に置きます。この CWnd が最上位のウィンドウの場合、ウィンドウの最上位ステータスは失われます。システムでは、このウィンドウをほかのすべてのウィンドウよりも下に置きます。 wndTop ウィンドウを Z オーダーの先頭に置きます。 wndTopMost ウィンドウを最上位でないすべてのウィンドウの上に置きます。ウィンドウは、非アクティブになったときも、最上位の位置を保持します。 wndNoTopMost ウィンドウを最上位でないすべてのウィンドウの先頭に再配置します (つまり、一番手前のすべてのウィンドウの後ろに置きます)。ウィンドウが既に非最上位ウィンドウとなっているときは、このフラグは無効です。
x	ウィンドウの新しい左辺の位置を指定します。
y	ウィンドウの新しい上辺の位置を指定します。
cx	ウィンドウの新しい幅を指定します。
cy	ウィンドウの新しい高さを指定します。
nFlags	サイズ変更オプションおよび位置指定オプションを指定します。このパラメータには、次の値を組み合わせて指定できます。 SWP_DRAWFRAME ウィンドウの周りにフレーム (ウィンドウ作成時に定義されます) を描画します。 SWP_FRAMECHANGED ウィンドウのサイズが変化されていない場合でも、ウィンドウに WM_NCCALCSIZE メッセージを送信します。このフラグが指定されていない場合、WM_NCCALCSIZE メッセージはウィンドウのサイズが実際に変化しているときにだけ送られます。 SWP_HIDEWINDOW ウィンドウを非表示にします。 SWP_NOACTIVATE ウィンドウをアクティブにしません。このフラグが設定されていないと、ウィンドウはアクティブになり、最上位または非最上位のウィンドウグループのいずれかの先頭に移動されます (パラメータ pWndInsertAfter の設定に依存します)。 SWP_NOCOPYBITS クライアント領域の内容全体を破棄します。このフラグが指定されていない場合、クライアント領域の有効な内容はすべて保存されます。保存された内容は、ウィンドウのサイズや位置が再び変更されたときにクライアント領域に復元されます。 SWP_NOMOVE 現在位置を保持します (x パラメータと y パラメータを無視します)。 SWP_NOOWNERZORDER オーナーウィンドウの Z オーダーの位置を変更しません。 SWP_NOREDRAW 変更があっても再描画しません。このフラグが設定されていると、どのような種類の再描画も行われません。このことは、クライアント領域、非クライアント領域 (タイトルやスクロールバーを含みます)、ウィンドウが移動したことにより覆われない親ウィンドウのあらゆる部分に適用されます。このフラグが設定されているときは、アプリケーションは再描画が必要なウィンドウや親ウィンドウのあらゆる部分を明示的に無効領域または再描画する必要があります。 SWP_NOREPOSITION SWP_NOOWNERZORDER と同じです。 SWP_NOSENDCHANGING ウィンドウが WM_WINDOWPOSCHANGING メッセージを受信しないようにします。 SWP_NOSIZE 現在のサイズを保持します (cx パラメータと cy パラメータを無視します)。 SWP_NOZORDER 現在の順序を保持します (pWndInsertAfter を無視します)。 SWP_SHOWWINDOW ウィンドウを表示します。

戻り値

TRUE	成功.
FALSE	失敗.

◆ ShowWindow()

BOOL ShowWindow ( int nCmdShow )

inherited

[設定] ウィンドウ表示状態.

引数

nCmdShow

CWnd を表示する方法を指定します。次の値のいずれかになります。

SW_HIDE このウィンドウを非表示にし、他のウィンドウをアクティブにします。
SW_MINIMIZE ウィンドウを最小化し、システムのリストのトップレベルウィンドウをアクティブにします。
SW_RESTORE ウィンドウをアクティブにし、表示します。ウィンドウが最小化または最大化されている場合は、Windows によって元のサイズと位置に戻されます。
SW_SHOW ウィンドウをアクティブにし、現在のサイズと位置で表示します。
SW_SHOWMAXIMIZED ウィンドウをアクティブにし、最大表示します。
SW_SHOWMINIMIZED ウィンドウをアクティブにし、最小化して表示します。
SW_SHOWMINNOACTIVE ウィンドウを最小化して表示します。現在アクティブなウィンドウはアクティブなまま表示します。
SW_SHOWNA 現在の状態でウィンドウを表示します。現在アクティブなウィンドウはアクティブなまま表示します。
SW_SHOWNOACTIVATE ウィンドウを直前のサイズと位置で表示します。現在アクティブなウィンドウはアクティブなまま表示します。
SW_SHOWNORMAL ウィンドウをアクティブにし、表示します。ウィンドウが最小化または最大化されている場合は、Windows によって元のサイズと位置に戻されます。

戻り値

TRUE	成功.
FALSE	失敗.

◆ StartAnimation()

bool StartAnimation	(	bool	mode,
		DWORD	interval,
		bool	useCache = `false`,
		bool	isStopInDrag = `false`
	)

[設定] アニメ設定.

覚え書き: 設定し、アニメを開始します。

引数

mode	true なら正順、降順を繰り返します。 false なら正順を繰り返します。
interval	指定時間(ms)ごとにフレームを書き換えます。
useCache	省略か false なら、キャッシュ使いません。true ならキャッシュを使用します。 ※キャッシュはメモリは使いますが、処理は軽くなります。
isStopInDrag	省略か false なら、ドラック中もアニメーションします。

戻り値

true	成功
false	失敗

TnbMfcAnimateStatic.h の 83 行目に定義があります。

◆ StopAnimation()

void StopAnimation ( void )

[設定] アニメ停止

TnbMfcAnimateStatic.h の 106 行目に定義があります。

◆ WindowProc()

virtual LRESULT WindowProc	(	UINT	message,
		WPARAM	wParam,
		LPARAM	lParam
	)

protectedvirtual

[通知] for processing Windows messages.

メッセージ受信したらコールされます。

覚え書き: CWndのメソッドをオーバーライドしています。

引数

message	メッセージ
wParam	WPARAM
lParam	LPARAM

戻り値: リザルト。

CRgnControlAddinT< CWnd >を再実装しています。

TnbMfcAnimateStatic.h の 163 行目に定義があります。

メンバ詳解

◆ m_clientRgn

HRGN m_clientRgn

protectedinherited

クライアントリージョン

TnbMfcRgnControl.h の 39 行目に定義があります。

公開メンバ関数

限定公開メンバ関数

限定公開変数類

詳解

構築子と解体子

◆ CAnimateStatic()

関数詳解

◆ AddBaseFrame() [1/2]

◆ AddBaseFrame() [2/2]

◆ DeleteClientRgnHandle()

◆ FlashCache()

◆ FrameAt()

◆ FrameAtWithCache()

◆ GetExStyle()

◆ GetLength()

◆ GetSafeHwnd()

◆ GetStyle()

◆ ModifyStyle()

◆ ModifyStyleEx()

◆ PreSubclassWindow()

◆ SetClientRgn()

◆ SetFirstFrame() [1/2]

◆ SetFirstFrame() [2/2]

◆ SetWindowPos()

◆ ShowWindow()

◆ StartAnimation()

◆ StopAnimation()

◆ WindowProc()

メンバ詳解

◆ m_clientRgn