IDirectManipulationCompositor
COM公式ドキュメント
操作対象のコンテンツを、canvas(JavaScript を使用する Windows アプリ)や Canvas(C++、C#、または Visual Basic を使用する Windows ストアアプリ)などの描画サーフェスに関連付けるコンポジターオブジェクトを表します。
解説(Remarks)
Direct Manipulation ビューポートのコンテンツは、IDirectManipulationCompositor のカスタム実装の場合、入力イベント中に手動で更新する必要があります。Update を呼び出して、ビューポート内のコンテンツを再描画してください。
ビューポートに手動モードを指定するには、次のいずれかの関数を呼び出します。
メソッド 4
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
コンテンツ(呼び出し元が所有)をコンポジターに関連付け、そのコンテンツにコンポジションデバイスを割り当て、他のコンポジションビジュアルに対する相対的なコンポジションツリー内でのコンテンツの位置を指定します。
| content | IDirectManipulationContent* | in | コンポジションツリーに追加するコンテンツ。 content は、コンポジションツリー内で parentVisual と childVisual の間に配置されます。 |
| device | IUnknown* | inoptional | コンテンツの合成に使用するデバイス。 メモ device はアプリケーションによって作成されます。
|
| parentVisual | IUnknown* | inoptional | 追加されるコンテンツの、コンポジションツリー内における親ビジュアル。 parentVisual は、コンポジションツリー内で childVisual の親でもある必要があります。 |
| childVisual | IUnknown* | inoptional | 追加されるコンテンツの、コンポジションツリー内における子ビジュアル。 parentVisual は、コンポジションツリー内で childVisual の親でもある必要があります。 |
戻り値
メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
このメソッドは、小さなビジュアルツリー(Direct Manipulation デバイスが所有)を parentVisual と childVisual の間に挿入します。その後、挿入されたコンテンツに対して変換を適用できます。
すべてのコンテンツは、種類にかかわらずコンポジターに追加する必要があります。これは、GetPrimaryContent を呼び出してビューポートから取得したプライマリコンテンツの場合もあれば、CreateContent を呼び出して作成したパンニングインジケーターなどのセカンダリコンテンツの場合もあります。
アプリケーションがシステム提供の IDirectManipulationCompositor を使用する場合:
- device は IDCompositionDevice オブジェクトである必要があり、親ビジュアルと子ビジュアルは IDCompositionVisual オブジェクトである必要があります。
- device、parentVisual、childVisual を NULL にすることはできません。
- device、parentVisual、childVisual の各オブジェクトは、アプリケーションによって作成および所有されます。
- このメソッドを使用してコンテンツをコンポジションツリーに追加すると、新しいコンポジションビジュアルが parentVisual と childVisual の間に挿入されます。新しいビジュアルは、RemoveContent でコンポジターとの関連付けが解除されるまで破棄しないでください。
- device、parentVisual、childVisual は、コンポジターにとって有効な型である必要があります。IDCompositionDevice オブジェクトや IDCompositionVisual オブジェクトである必要はありません。
- device、parentVisual、childVisual は、コンポジターによっては NULL にできます。
コンポジターからコンテンツを削除します。
| content | IDirectManipulationContent* | in | コンポジションツリーから削除するコンテンツ。 |
戻り値
メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
このメソッドは、AddContent で追加されたコンテンツを削除し、コンポジションツリー内の親ビジュアルと子ビジュアルの元の関係を復元します。言い換えると、RemoveContent は AddContent を元に戻します。
コンポジターの更新を Direct Manipulation に送信するために使用するアップデートマネージャーを設定します。
| updateManager | IDirectManipulationUpdateManager* | in | アップデートマネージャー。 |
戻り値
メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
updateManager は、GetUpdateManager を呼び出して取得します。
コンポジターを update manager に接続するには、Direct Manipulation の初期化中にこのメソッドを呼び出してください。
コンポジター内の保留中のすべての更新を、レンダリングのためにシステムにコミットします。
戻り値
メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
このメソッドは、プロセスの中断などのシステムイベントの前に、Direct Manipulation が保留中の変更をそのビジュアルにフラッシュできるようにします。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IDirectManipulationCompositor "{537A0825-0387-4EFA-B62F-71EB1F085A7E}"
#usecom global IDirectManipulationCompositor IID_IDirectManipulationCompositor "{}"
#comfunc global IDirectManipulationCompositor_AddContent 3 sptr,sptr,sptr,sptr
#comfunc global IDirectManipulationCompositor_RemoveContent 4 sptr
#comfunc global IDirectManipulationCompositor_SetUpdateManager 5 sptr
#comfunc global IDirectManipulationCompositor_Flush 6
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。