IStrokeBuilder

パケットデータからプログラムによってストロークを作成するために使用するインターフェイスです。

このインターフェイスは StrokeBuilder Class によって実装されます。

StrokeBuilder Class は、データを自分で管理するアプリケーション向けに、ストロークを作成するもう 1 つの方法を提供します。このクラスには、StylusDown、Packets、StylusUp の各通知から呼び出せるメソッドが用意されています。

次の 2 つのモデルがサポートされます。

• IStrokeBuilder::CreateStroke Method メソッドを使用して、カスタムのストローク情報をアトミックにストロークへ変換する方法。
• StylusDown、Packets、StylusUp の各通知に対応する IStrokeBuilder::BeginStroke Method、IStrokeBuilder::AppendPackets Method、IStrokeBuilder::EndStroke Method の各メソッドを使用してストロークを構築する方法。

例

次の C++ の例は、IStylusPlugin Interface クラスの部分的な実装を示します。このプラグインは StrokeBuilder オブジェクトを使用して、新しいインク ストロークを作成します。

// CStrokeBuilderPlugin

// Helper functions
HRESULT CStrokeBuilderPlugin::GetInk(IInkDisp** pInk)
{
    return m_pStrokeBuilder->get_Ink(pInk);
}

// IStylusAsyncPlugin Interface implementation

STDMETHODIMP CStrokeBuilderPlugin::RealTimeStylusEnabled( 
            /* [in] */ IRealTimeStylus *piRtsSrc,
            /* [in] */ ULONG cTcidCount,
            /* [size_is][in] */ const TABLET_CONTEXT_ID *pTcids)
{
    // Create an IStrokeBuilder object
    return CoCreateInstance(CLSID_StrokeBuilder, NULL, CLSCTX_INPROC, IID_IStrokeBuilder, (VOID **)&m_pStrokeBuilder);
}

STDMETHODIMP CStrokeBuilderPlugin::DataInterest( 
            /* [retval][out] */ RealTimeStylusDataInterest *pDataInterest)
{
    // Set up the messages we want to receive
    *pDataInterest = (RealTimeStylusDataInterest)(RTSDI_StylusDown | RTSDI_Packets |
                                                  RTSDI_StylusUp | RTSDI_Error);
    return S_OK;
}

STDMETHODIMP CStrokeBuilderPlugin::StylusDown( 
            /* [in] */ IRealTimeStylus *piRtsSrc,
            /* [in] */ const StylusInfo *pStylusInfo,
            /* [in] */ ULONG cPropCountPerPkt,
            /* [size_is][in] */ LONG *pPacket,
            /* [out][in] */ LONG **ppInOutPkt)
{
    FLOAT fInkToDeviceScaleX;
    FLOAT fInkToDeviceScaleY;
    ULONG cPacketProperties;
    PACKET_PROPERTY* pPacketProperties;

    // Get the info we need to call BeginStroke
    HRESULT hr = piRtsSrc->GetPacketDescriptionData(pStylusInfo->tcid, &fInkToDeviceScaleX, &fInkToDeviceScaleY, 
                                                    &cPacketProperties, &pPacketProperties);

    if (SUCCEEDED(hr))
    {
        // Start creating the stroke
        hr = m_pStrokeBuilder->BeginStroke(pStylusInfo->tcid, pStylusInfo->cid, pPacket, cPropCountPerPkt, 
                                            pPacketProperties, fInkToDeviceScaleX, fInkToDeviceScaleY, &m_piStroke);
    }
    
    return hr;
}

STDMETHODIMP CStrokeBuilderPlugin::Packets( 
            /* [in] */ IRealTimeStylus *piRtsSrc,
            /* [in] */ const StylusInfo *pStylusInfo,
            /* [in] */ ULONG cPktCount,
            /* [in] */ ULONG cPktBuffLength,
            /* [size_is][in] */ LONG *pPackets,
            /* [out][in] */ ULONG *pcInOutPkts,
            /* [out][in] */ LONG **ppInOutPkts)
{
    // Add packet to the stroke
    return m_pStrokeBuilder->AppendPackets(pStylusInfo->tcid, pStylusInfo->cid, cPktBuffLength, pPackets);
}

STDMETHODIMP CStrokeBuilderPlugin::StylusUp( 
            /* [in] */ IRealTimeStylus *piRtsSrc,
            /* [in] */ const StylusInfo *pStylusInfo,
            /* [in] */ ULONG cPropCountPerPkt,
            /* [size_is][in] */ LONG *pPacket,
            /* [out][in] */ LONG **ppInOutPkt)
{
    // Finish the stroke. This adds the stroke to the StrokeBuilder's Ink object.
    return m_pStrokeBuilder->EndStroke(pStylusInfo->tcid, pStylusInfo->cid, &m_piStroke, NULL);
}

STDMETHODIMP CStrokeBuilderPlugin::Error( 
            /* [in] */ IRealTimeStylus *piRtsSrc,
            /* [in] */ IStylusPlugin *piPlugin,
            /* [in] */ RealTimeStylusDataInterest dataInterest,
            /* [in] */ HRESULT hrErrorCode,
            /* [out][in] */ LONG_PTR *lptrKey)
{
    CString strError;
    strError.Format(L"An error occurred. Error code: %d", hrErrorCode);
    TRACE(strError);
    return S_OK;
}

// The remaining interface methods are not used

RealTimeStylus Class オブジェクトから送られたパケットデータを使用して、インク オブジェクト上にストロークを作成します。

戻り値の説明については、RealTimeStylus Classes and Interfaces を参照してください。

fInkToDeviceScaleX パラメーターと fInkToDeviceScaleY パラメーターは、IStrokeBuilder::CreateStroke Method メソッドで作成されるストロークの内部表現に影響します。インク空間の x 座標に fInkToDeviceScaleX を掛けると、デジタイザー単位の x 座標が得られます。インク空間の y 座標に fInkToDeviceScaleY を掛けると、デジタイザー単位の y 座標が得られます。

スケールのパラメーターを取得するには、IRealTimeStylus::GetPacketDescriptionData Method を使用します。

RealTimeStylus Class オブジェクトからのパケットデータを使用して、インク オブジェクト上でストロークを開始します。

戻り値の説明については、RealTimeStylus Classes and Interfaces を参照してください。

IStrokeBuilder::AppendPackets Method メソッドおよび IStrokeBuilder::EndStroke Method メソッドと組み合わせて使用します。IStrokeBuilder::BeginStroke Method はストロークの構築を開始します。動きが続いて追加のパケットを受信すると、IStrokeBuilder::AppendPackets Method メソッドがその追加のストローク データを追加します。タブレット ペンが面から離され、受信するパケットがなくなると、IStrokeBuilder::EndStroke Method メソッドが呼び出されます。

例

次の C++ の例は、IStylusPlugin Interface オブジェクトにおける IStylusPlugin::StylusDown Method メソッドの実装を示します。このプラグインは StrokeBuilder オブジェクトを使用して、新しいインク ストロークを作成します。IStrokeBuilder::BeginStroke Method メソッドは、ストロークの構築を開始するために IStylusPlugin::StylusDown Method から呼び出されます。

STDMETHODIMP CStrokeBuilderPlugin::StylusDown( 
            /* [in] */ IRealTimeStylus *piRtsSrc,
            /* [in] */ const StylusInfo *pStylusInfo,
            /* [in] */ ULONG cPropCountPerPkt,
            /* [size_is][in] */ LONG *pPacket,
            /* [out][in] */ LONG **ppInOutPkt)
{
    FLOAT fInkToDeviceScaleX;
    FLOAT fInkToDeviceScaleY;
    ULONG cPacketProperties;
    PACKET_PROPERTY* pPacketProperties;

    // Get the info we need to call BeginStroke
    HRESULT hr = piRtsSrc->GetPacketDescriptionData(pStylusInfo->tcid, &fInkToDeviceScaleX, &fInkToDeviceScaleY, 
                                                    &cPacketProperties, &pPacketProperties);

    if (SUCCEEDED(hr))
    {
        // Start creating the stroke
        hr = m_pStrokeBuilder->BeginStroke(pStylusInfo->tcid, pStylusInfo->cid, pPacket, cPropCountPerPkt, 
                                            pPacketProperties, fInkToDeviceScaleX, fInkToDeviceScaleY, &m_piStroke);
    }
    
    return hr;
}

デジタイザー入力パケット リストの末尾にパケットを追加します。

戻り値の説明については、RealTimeStylus Classes and Interfaces を参照してください。

このメソッドは、スタイラスがデジタイザーに触れている状態、または検出範囲内にある状態で移動した結果としてデータ パケットが送信されたときに呼び出します。

例

次の C++ の例は、IStylusPlugin Interface オブジェクトにおける IStylusPlugin::Packets Method メソッドの実装を示します。このプラグインは StrokeBuilder オブジェクトを使用して、新しいインク ストロークを作成します。IStrokeBuilder::AppendPackets Method メソッドは、ユーザーがデジタイザー上でスタイラスをドラッグする間、作成中のストロークに新しいパケットデータを追加するために IStylusPlugin::Packets Method から呼び出されます。

STDMETHODIMP CStrokeBuilderPlugin::Packets( 
            /* [in] */ IRealTimeStylus *piRtsSrc,
            /* [in] */ const StylusInfo *pStylusInfo,
            /* [in] */ ULONG cPktCount,
            /* [in] */ ULONG cPktBuffLength,
            /* [size_is][in] */ LONG *pPackets,
            /* [out][in] */ ULONG *pcInOutPkts,
            /* [out][in] */ LONG **ppInOutPkts)
{
    // Add packet to the stroke
    return m_pStrokeBuilder->AppendPackets(pStylusInfo->tcid, pStylusInfo->cid, cPktBuffLength, pPackets);
}

ストロークを終了し、ストローク オブジェクトを返します。

戻り値の説明については、RealTimeStylus Classes and Interfaces を参照してください。

ダーティ領域とは、変更が加えられたタブレット上の範囲を表します。

例

次の C++ の例は、IStylusPlugin Interface オブジェクトにおける IStylusPlugin::StylusUp Method メソッドの実装を示します。このプラグインは StrokeBuilder オブジェクトを使用して、新しいインク ストロークを作成します。IStrokeBuilder::EndStroke Method メソッドは、ストロークの構築を完了して StrokeBuilder Class の Ink オブジェクトに追加するために IStylusPlugin::StylusUp Method から呼び出されます。

STDMETHODIMP CStrokeBuilderPlugin::StylusUp( 
            /* [in] */ IRealTimeStylus *piRtsSrc,
            /* [in] */ const StylusInfo *pStylusInfo,
            /* [in] */ ULONG cPropCountPerPkt,
            /* [size_is][in] */ LONG *pPacket,
            /* [out][in] */ LONG **ppInOutPkt)
{
    // Finish the stroke. This adds the stroke to the StrokeBuilder's Ink object.
    return m_pStrokeBuilder->EndStroke(pStylusInfo->tcid, pStylusInfo->cid, &m_piStroke, NULL);
}

IStrokeBuilder オブジェクトに関連付けられているインク オブジェクトを取得または設定します。