ホーム › UI.Animation › IUIAnimationTimerUpdateHandler

IUIAnimationTimerUpdateHandler

COM

IID195509b7-5d5e-4e3e-b278-ee3759b367ad継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

タイミングの更新イベントを処理するためのメソッドを定義します。

解説(Remarks)

UIAnimationManager オブジェクトはこのインターフェイスを実装しています。そのため、クライアントアプリケーションは UIAnimationManager オブジェクトからこのインターフェイスを取得し、それを IUIAnimationTimer::SetTimerUpdateHandler に渡すことができます。UIAnimationManager オブジェクトと UIAnimationTimer オブジェクトの接続を明示的に解除する必要はありません。両方を解放すれば後始末としては十分です。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT OnUpdate(DOUBLE timeNow, UI_ANIMATION_UPDATE_RESULT* result)

タイマーからの更新イベントを処理します。

timeNow	DOUBLE	in	現在のタイマー時刻 (秒単位)。
result	UI_ANIMATION_UPDATE_RESULT*	out	更新の結果としてアニメーション変数が変化したかどうかを示す、UI_ANIMATION_UPDATE_RESULT 列挙型のメンバーを受け取ります。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

このメソッドは、UIAnimationManager オブジェクトの状態を更新するために UIAnimationTimer オブジェクトによって使用されます。UIAnimationTimer オブジェクトは、このメソッドの呼び出しが UI_ANIMATION_UPDATE_VARIABLES_CHANGED を返した場合にのみ、UIAnimationTimerEventHandler::OnPostUpdate を呼び出します。

vtbl 4 HRESULT SetTimerClientEventHandler(IUIAnimationTimerClientEventHandler* handler)

タイマークライアントの状態変化イベントのハンドラーを指定します。

handler

IUIAnimationTimerClientEventHandler*

タイマークライアントイベントのハンドラー。指定するオブジェクトは IUIAnimationTimerUpdateHandler を実装している必要があります。

戻り値

解説(Remarks)

更新ハンドラーが既にタイマーに接続されている場合、このメソッドは UI_E_TIMER_CLIENT_ALREADY_CONNECTED を返します。

vtbl 5 HRESULT ClearTimerClientEventHandler()

タイマークライアントの状態変化イベントのハンドラーをクリアします。

戻り値

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IUIAnimationTimerUpdateHandler "{195509B7-5D5E-4E3E-B278-EE3759B367AD}"
#usecom global IUIAnimationTimerUpdateHandler IID_IUIAnimationTimerUpdateHandler "{}"
#comfunc global IUIAnimationTimerUpdateHandler_OnUpdate                      3 double,var
#comfunc global IUIAnimationTimerUpdateHandler_SetTimerClientEventHandler    4 sptr
#comfunc global IUIAnimationTimerUpdateHandler_ClearTimerClientEventHandler  5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IUIAnimationTimerUpdateHandler "{195509B7-5D5E-4E3E-B278-EE3759B367AD}"
#usecom global IUIAnimationTimerUpdateHandler IID_IUIAnimationTimerUpdateHandler "{}"
#comfunc global IUIAnimationTimerUpdateHandler_OnUpdate                      3 double,sptr
#comfunc global IUIAnimationTimerUpdateHandler_SetTimerClientEventHandler    4 sptr
#comfunc global IUIAnimationTimerUpdateHandler_ClearTimerClientEventHandler  5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。