Win32 API 日本語リファレンス
ホーム › Graphics.DirectManipulation › IDirectManipulationViewport2

IDirectManipulationViewport2

COM
📘 Microsoft Learn (日本語) · English
IID923ccaac-61e1-4385-b726-017af189882a継承元IDirectManipulationViewport自前メソッド開始 vtbl31

公式ドキュメント

ビューポート上の動作(behavior)を管理する機能を提供します。behavior は Direct Manipulation ワークフローの特定の部分の機能に影響を与えます。

解説(Remarks)

IDirectManipulationViewport2 は IDirectManipulationViewport の代わりに使用できます。

behavior は IDirectManipulationManager2 と適切なクラス ID を使用して作成します。

behavior はいつでもアタッチまたは削除でき、(アクティブな操作中や慣性アニメーション中であっても)即座に有効になります。

メソッド 3

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

vtbl 31 HRESULT AddBehavior(IUnknown* behavior, DWORD* cookie)

ビューポートに behavior を追加し、呼び出し元にクッキーを返します。

behaviorIUnknown*inCreateBehavior メソッドを使用して作成された behavior。
cookieDWORD*out呼び出し元が後でこの behavior を削除できるように、クッキーが返されます。これにより、呼び出し元は behavior への参照を解放し、イベント ハンドラーと同様に、Direct Manipulation に適切な有効期間を維持させることができます。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。このビューポートまたは別のビューポートに既にアタッチされている behavior をアタッチすると失敗します。

解説(Remarks)

behavior は AddBehavior の呼び出し後に即座に有効になります。アクティブな操作フェーズや慣性フェーズの間に behavior を追加する場合は、この点を考慮する必要があります。

vtbl 32 HRESULT RemoveBehavior(DWORD cookie)

指定されたクッキーに一致する behavior をビューポートから削除します。

cookieDWORDin同じビューポートに対する AddBehavior の呼び出しから返された有効なクッキー。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。behavior が既に削除されている場合、またはその behavior がこのビューポートにアタッチされていない場合は失敗が返されます。

vtbl 33 HRESULT RemoveAllBehaviors()

ビューポートに追加されたすべての behavior を削除します。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

解説(Remarks)

RemoveAllBehaviors は、ビューポートからの behavior の削除に失敗した場合にのみエラーを返します。特定の behavior が正常に削除されなかった場合でも、RemoveAllBehaviors は残りのすべての behavior を削除します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDirectManipulationViewport2 "{923CCAAC-61E1-4385-B726-017AF189882A}"
#usecom global IDirectManipulationViewport2 IID_IDirectManipulationViewport2 "{34E211B6-3650-4F75-8334-FA359598E1C5}"
#comfunc global IDirectManipulationViewport2_AddBehavior         31 sptr,var
#comfunc global IDirectManipulationViewport2_RemoveBehavior      32 int
#comfunc global IDirectManipulationViewport2_RemoveAllBehaviors  33
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。