IDynamicRenderer
COM公式ドキュメント
RealTimeStylus Class オブジェクトがタブレット ペンのデータを処理している最中に、そのデータをリアルタイムで表示します。
解説(Remarks)
このインターフェイスは DynamicRenderer Class によって実装されます。
DynamicRenderer Class はパケット データを動的にレンダリングします。
DynamicRenderer Class を RealTimeStylus Class のプラグイン コレクションに追加する前に、必ずそのハンドルを設定してください。ハンドルが設定されていない場合、各プラグインの IStylusPlugin::Error Method 通知メソッドが呼び出されます。詳細については、Error Handling Considerations for the StylusInput APIs を参照してください。
DynamicRenderer Class は IStylusSyncPlugin インターフェイスを実装します。
DynamicRenderer Class オブジェクトは、ウィンドウが無効化された際にインク(手書き)を再描画できます。
1 つのプラグインを複数の RealTimeStylus Class オブジェクトに関連付けることは可能ですが、DynamicRenderer Class および GestureRecognizer Class のプラグインはこれをサポートするようには設計されていません。
変更が即座に反映されるプロパティは次のとおりです。
IDynamicRenderer::ClipRectangle Property
変更が即座には反映されず、遅延して反映されるプロパティは次のとおりです。
メソッド 15
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
動的レンダリングのオン/オフを切り替える値を取得または設定します。(Get)
| bEnabled | BOOL* | out | 動的レンダラが有効かどうかを受け取る出力ポインタである。 |
解説(Remarks)
このプロパティの変更は、ストロークの開始時または終了時、つまりストロークとストロークの間に適用されます。
動的レンダリングのオン/オフを切り替える値を取得または設定します。(Put)
| bEnabled | BOOL | in | 動的レンダラを有効にするかどうかを指定する。 |
解説(Remarks)
このプロパティの変更は、ストロークの開始時または終了時、つまりストロークとストロークの間に適用されます。
DynamicRenderer Class オブジェクトに関連付けられたウィンドウ ハンドル (HWND) を取得または設定します。(Get)
| hwnd | HANDLE_PTR* | out | 描画先ウィンドウのハンドルを受け取る出力ポインタである。 |
DynamicRenderer Class オブジェクトに関連付けられたウィンドウ ハンドル (HWND) を取得または設定します。(Put)
| hwnd | HANDLE_PTR | in | 描画先ウィンドウのハンドルを指定する。 |
DynamicRenderer Class オブジェクトのクリッピング矩形を取得または設定します。(Get)
| prcClipRect | RECT* | out | 描画をクリッピングする矩形領域を受け取る出力ポインタである。 |
解説(Remarks)
ClipRectangle プロパティは即座に設定され、現在描画中のストロークに適用されます。この点で、次に描画されるストロークに適用される IDynamicRenderer::DrawingAttributes Property プロパティとは異なります。これにより、ストロークの描画に合わせてクリップ矩形を拡大できます。
Paint イベント ハンドラー内から IDynamicRenderer::Refresh Method を呼び出す場合は、IDynamicRenderer::ClipRectangle Property に Paint イベントの矩形を設定してください。
DynamicRenderer Class オブジェクトのクリッピング矩形を取得または設定します。(Put)
| prcClipRect | RECT* | in | 描画をクリッピングする矩形領域を指すポインタである。 |
解説(Remarks)
ClipRectangle プロパティは即座に設定され、現在描画中のストロークに適用されます。この点で、次に描画されるストロークに適用される IDynamicRenderer::DrawingAttributes Property プロパティとは異なります。これにより、ストロークの描画に合わせてクリップ矩形を拡大できます。
Paint イベント ハンドラー内から IDynamicRenderer::Refresh Method を呼び出す場合は、IDynamicRenderer::ClipRectangle Property に Paint イベントの矩形を設定してください。
DynamicRenderer Class オブジェクトのクリッピング領域を取得または設定します。(Get)
| phClipRgn | HANDLE_PTR* | out | 描画をクリッピングするリージョンのハンドルを受け取る出力ポインタである。 |
解説(Remarks)
データは任意の定義済みサーフェスにレンダリングできます。動的レンダリング用の収集サーフェスは、複数のクリップ矩形で構成される場合があります。
DynamicRenderer Class オブジェクトのクリッピング領域を取得または設定します。(Put)
| hClipRgn | HANDLE_PTR | in | 描画をクリッピングするリージョンのハンドルを指定する。 |
解説(Remarks)
データは任意の定義済みサーフェスにレンダリングできます。動的レンダリング用の収集サーフェスは、複数のクリップ矩形で構成される場合があります。
DynamicRenderer Class オブジェクトが使用する DrawingAttributes オブジェクトを取得または設定します。
| ppiDA | IInkDrawingAttributes** | out | 動的に描画するインクの描画属性を表す IInkDrawingAttributes へのポインタを受け取る出力ポインタである。 |
解説(Remarks)
呼び出し元は、次のストロークに適用する描画属性を設定または変更できます。デバイスへのレンダリングには動的レンダラーを使用しないでください。動的レンダラーの唯一の目的は、ユーザー インターフェイスの一部としてリアルタイムの動的レンダリングを行うことです。
DynamicRenderer Class クラスのインスタンスを作成すると、既定の DrawingAttributes インスタンスが次の標準属性で作成されます。
- Color = Black
- Width = 53 (96 dpi の画面で 2 ピクセル)
- Height = 1
- PenTip = Ball
- Transparency = 0
- AntiAliased = true
- FitToCurve = false
- ExtendedProperties = 空のコレクション
ユーザーがストロークを描画している最中にこのプロパティを変更した場合、新しい描画属性は現在のストロークには適用されず、次に描画されるストロークから有効になります。たとえば、IStylusAsyncPlugin の実装中に IStylusPlugin::StylusDown Method でこのプロパティを設定しても、アクティブなストロークには影響しません。
DisplaySettingsChanged イベントが発生した場合は、その DisplaySettingsChanged イベント ハンドラー内で DrawingAttributes オブジェクトの Width プロパティと Height プロパティを再計算してください。これは、DisplaySettingsChanged イベントに伴う dots per inch (dpi) の変更に対応するために必要です。
描画属性の既定値は次のとおりです。
| 描画属性 | 値 |
|---|---|
| AntiAliased | True |
| Color | Color.Black |
| FitToCurve | false |
| Height | 1 |
| IgnorePressure | False |
| PenTip | Ball |
| RasterOperation | CopyPen |
| Transparency | 0 |
| Width | 53 |
| piDA | IInkDrawingAttributes* | inoptional | 動的に描画するインクに設定する描画属性を表す IInkDrawingAttributes へのポインタである。 |
DynamicRenderer Class オブジェクトでデータ キャッシュが有効かどうかを示す値を取得または設定します。(Get)
| pfCacheData | BOOL* | out | ストロークデータのキャッシュが有効かどうかを受け取る出力ポインタである。 |
解説(Remarks)
DataCacheEnabled プロパティを TRUE に設定すると、処理の遅いプロセスが出力キューをブロックする状況に対処できます。DynamicRenderer Class オブジェクトによってストロークが描画された後にウィンドウが無効化されると、収集済みのストロークが描画されるまでに遅延が生じることがあります。動的レンダラーのストロークをキャッシュに保持し、IDynamicRenderer::Refresh Method メソッドを使用してストロークを再描画してください。
ストロークが収集された後は、IDynamicRenderer::ReleaseCachedData Method メソッドを呼び出してキャッシュから解放する必要があります。ストロークの解放には IStylusPlugin::CustomStylusDataAdded Method メソッドを使用してください。
また、ストロークを描画されるとおりに表示したいものの、処理後にストロークを保存しておく必要がない場合にも、DataCacheEnabled プロパティを TRUE に設定すると便利です。この場合は、IStylusPlugin::CustomStylusDataAdded Method メソッドの data パラメーターにデータ識別子を格納しておき、キャッシュされたストロークが不要になった時点でデータを解放します。
このプロパティが TRUE の場合、インク収集オブジェクトに格納されたストロークについて IDynamicRenderer::ReleaseCachedData Method メソッドを呼び出す必要があります。FALSE の場合、IDynamicRenderer::ReleaseCachedData Method メソッドを呼び出す必要はありません。ただし、このプロパティを FALSE に設定する欠点として、最初は動的にレンダリングされたものの他の各種操作によって無効化されたストローク データは、そのストローク データがインク収集オブジェクトに到達してそこでレンダリングされるまで描画されません。
このプロパティを FALSE に設定すると、キャッシュされたデータはクリアされます。
DynamicRenderer Class オブジェクトでデータ キャッシュが有効かどうかを示す値を取得または設定します。(Put)
| fCacheData | BOOL | in | ストロークデータをキャッシュするかどうかを指定する。 |
解説(Remarks)
DataCacheEnabled プロパティを TRUE に設定すると、処理の遅いプロセスが出力キューをブロックする状況に対処できます。DynamicRenderer Class オブジェクトによってストロークが描画された後にウィンドウが無効化されると、収集済みのストロークが描画されるまでに遅延が生じることがあります。動的レンダラーのストロークをキャッシュに保持し、IDynamicRenderer::Refresh Method メソッドを使用してストロークを再描画してください。
ストロークが収集された後は、IDynamicRenderer::ReleaseCachedData Method メソッドを呼び出してキャッシュから解放する必要があります。ストロークの解放には IStylusPlugin::CustomStylusDataAdded Method メソッドを使用してください。
また、ストロークを描画されるとおりに表示したいものの、処理後にストロークを保存しておく必要がない場合にも、DataCacheEnabled プロパティを TRUE に設定すると便利です。この場合は、IStylusPlugin::CustomStylusDataAdded Method メソッドの data パラメーターにデータ識別子を格納しておき、キャッシュされたストロークが不要になった時点でデータを解放します。
このプロパティが TRUE の場合、インク収集オブジェクトに格納されたストロークについて IDynamicRenderer::ReleaseCachedData Method メソッドを呼び出す必要があります。FALSE の場合、IDynamicRenderer::ReleaseCachedData Method メソッドを呼び出す必要はありません。ただし、このプロパティを FALSE に設定する欠点として、最初は動的にレンダリングされたものの他の各種操作によって無効化されたストローク データは、そのストローク データがインク収集オブジェクトに到達してそこでレンダリングされるまで描画されません。
このプロパティを FALSE に設定すると、キャッシュされたデータはクリアされます。
DynamicRenderer Class が保持している一時データから、指定したストローク データを解放します。
| strokeId | DWORD | in | ストロークの識別子。 |
戻り値
戻り値の説明については、RealTimeStylus Classes and Interfaces を参照してください。
解説(Remarks)
このメソッドは、IDynamicRenderer::DataCacheEnabled Property プロパティが true に設定されている場合にのみ使用します。
IDynamicRenderer::ReleaseCachedData Method メソッドを使用すると、DynamicRenderer Class オブジェクトが保持している一時データから、指定したストローク データを解放できます。
DynamicRenderer Class のストロークはキャッシュに保持できるため、IDynamicRenderer::Refresh Method メソッドを呼び出して再描画できます。ストロークが収集された後は、IDynamicRenderer::ReleaseCachedData Method メソッドを呼び出してキャッシュから解放してください。通常、この解放は IStylusPlugin::CustomStylusDataAdded Method メソッド内で行います。
strokeId には 0 未満の値を指定できません。
DynamicRenderer Class オブジェクトに、現在レンダリング中のインク(手書き)データを再描画させます。
戻り値
このメソッドは次の値のいずれかを返します。
解説(Remarks)
IDynamicRenderer::DataCacheEnabled Property プロパティが true の場合、DynamicRenderer Class オブジェクトは、キャッシュからまだ解放されていないすべてのタブレット スタイラス データを再描画します。IDynamicRenderer::DataCacheEnabled Property プロパティが false の場合、DynamicRenderer Class オブジェクトは現在のストロークのみを再描画します。
Paint イベント ハンドラー内から IDynamicRenderer::Refresh Method を呼び出す場合は、IDynamicRenderer::ClipRectangle Property に Paint イベントの矩形を設定してください。
キャッシュされたデータを指定したデバイス コンテキストに描画します。
| hDC | HANDLE_PTR | in | 描画先のデバイス コンテキストのハンドル。 |
戻り値
戻り値の説明については、RealTimeStylus Classes and Interfaces を参照してください。
解説(Remarks)
IDynamicRenderer::Draw Method は、ダブル バッファリングなどの処理に使用できます。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IDynamicRenderer "{A079468E-7165-46F9-B7AF-98AD01A93009}" #usecom global IDynamicRenderer IID_IDynamicRenderer "{ECD32AEA-746F-4DCB-BF68-082757FAFF18}" #comfunc global IDynamicRenderer_get_Enabled 3 var #comfunc global IDynamicRenderer_put_Enabled 4 int #comfunc global IDynamicRenderer_get_HWND 5 var #comfunc global IDynamicRenderer_put_HWND 6 sptr #comfunc global IDynamicRenderer_get_ClipRectangle 7 var #comfunc global IDynamicRenderer_put_ClipRectangle 8 var #comfunc global IDynamicRenderer_get_ClipRegion 9 var #comfunc global IDynamicRenderer_put_ClipRegion 10 sptr #comfunc global IDynamicRenderer_get_DrawingAttributes 11 sptr #comfunc global IDynamicRenderer_putref_DrawingAttributes 12 sptr #comfunc global IDynamicRenderer_get_DataCacheEnabled 13 var #comfunc global IDynamicRenderer_put_DataCacheEnabled 14 int #comfunc global IDynamicRenderer_ReleaseCachedData 15 int #comfunc global IDynamicRenderer_Refresh 16 #comfunc global IDynamicRenderer_Draw 17 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IDynamicRenderer "{A079468E-7165-46F9-B7AF-98AD01A93009}" #usecom global IDynamicRenderer IID_IDynamicRenderer "{ECD32AEA-746F-4DCB-BF68-082757FAFF18}" #comfunc global IDynamicRenderer_get_Enabled 3 sptr #comfunc global IDynamicRenderer_put_Enabled 4 int #comfunc global IDynamicRenderer_get_HWND 5 sptr #comfunc global IDynamicRenderer_put_HWND 6 sptr #comfunc global IDynamicRenderer_get_ClipRectangle 7 sptr #comfunc global IDynamicRenderer_put_ClipRectangle 8 sptr #comfunc global IDynamicRenderer_get_ClipRegion 9 sptr #comfunc global IDynamicRenderer_put_ClipRegion 10 sptr #comfunc global IDynamicRenderer_get_DrawingAttributes 11 sptr #comfunc global IDynamicRenderer_putref_DrawingAttributes 12 sptr #comfunc global IDynamicRenderer_get_DataCacheEnabled 13 sptr #comfunc global IDynamicRenderer_put_DataCacheEnabled 14 int #comfunc global IDynamicRenderer_ReleaseCachedData 15 int #comfunc global IDynamicRenderer_Refresh 16 #comfunc global IDynamicRenderer_Draw 17 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。