DrawingVisual オブジェクトの使用

[アーティクル]
08/09/2011

ここでは、WPF ビジュアル層で DrawingVisual オブジェクトを使用する方法の概要を説明します。

このトピックは、次のセクションで構成されています。

DrawingVisual オブジェクト
DrawingVisual ホストコンテナー
DrawingVisual オブジェクトの作成
FrameworkElement メンバーのオーバーライドの作成
ヒットテストのサポート
関連トピック

DrawingVisual オブジェクト

DrawingVisual は、図形、イメージ、またはテキストの描画に使用する軽量の描画クラスです。このクラスが軽量と見なされる理由は、レイアウトやイベントの処理を行わないため、パフォーマンスが向上するからです。このため、描画は背景やクリップアートに適しています。

DrawingVisual ホストコンテナー

DrawingVisual オブジェクトを使用するには、オブジェクトのホストコンテナーを作成する必要があります。ホストコンテナーオブジェクトは、FrameworkElement クラスから継承する必要があります。このクラスは、DrawingVisual クラスがサポートしていないレイアウトやイベント処理をサポートします。ホストコンテナーオブジェクトの主な目的は子オブジェクトを格納することなので、ホストコンテナーオブジェクトには表示プロパティは表示されません。ただし、ホストコンテナーの Visibility プロパティは、Visible に設定する必要があります。この値に設定しない場合、その子要素のいずれも表示されなくなります。

ビジュアルオブジェクトのホストコンテナーオブジェクトを作成する場合は、VisualCollection にビジュアルオブジェクト参照を格納する必要があります。 Add メソッドを使用して、ビジュアルオブジェクトをホストコンテナーに追加します。次の例では、ホストコンテナーオブジェクトを作成し、3 つのビジュアルオブジェクトをその VisualCollection に追加します。

    ' Create a host visual derived from the FrameworkElement class.
    ' This class provides layout, event handling, and container support for
    ' the child visual objects.
    Public Class MyVisualHost
        Inherits FrameworkElement
        ' Create a collection of child visual objects.
        Private _children As VisualCollection

        Public Sub New()
            _children = New VisualCollection(Me)
            _children.Add(CreateDrawingVisualRectangle())
            _children.Add(CreateDrawingVisualText())
            _children.Add(CreateDrawingVisualEllipses())

            ' Add the event handler for MouseLeftButtonUp.
            AddHandler MouseLeftButtonUp, AddressOf MyVisualHost_MouseLeftButtonUp
        End Sub

// Create a host visual derived from the FrameworkElement class.
// This class provides layout, event handling, and container support for
// the child visual objects.
public class MyVisualHost : FrameworkElement
{
    // Create a collection of child visual objects.
    private VisualCollection _children;

    public MyVisualHost()
    {
        _children = new VisualCollection(this);
        _children.Add(CreateDrawingVisualRectangle());
        _children.Add(CreateDrawingVisualText());
        _children.Add(CreateDrawingVisualEllipses());

        // Add the event handler for MouseLeftButtonUp.
        this.MouseLeftButtonUp += new System.Windows.Input.MouseButtonEventHandler(MyVisualHost_MouseLeftButtonUp);
    }

メモ
前のコード例を含むコードサンプル全体については、DrawingVisual を使用したヒットテストのサンプルを参照してください。

DrawingVisual オブジェクトの作成

DrawingVisual オブジェクトの作成時には、オブジェクトに描画内容は含まれていません。テキスト、グラフィックス、またはイメージコンテンツを追加するには、オブジェクトの DrawingContext を取得し、そのコンテキストに描画します。 DrawingContext は、DrawingVisual オブジェクトの RenderOpen メソッドを呼び出すことによって返されます。

DrawingContext に四角形を描画するには、DrawingContext オブジェクトの DrawRectangle メソッドを使用します。他の種類のコンテンツを描画するための同様のメソッドがあります。 DrawingContext へのコンテンツの描画が完了したら、Close メソッドを呼び出して DrawingContext を閉じ、コンテンツを保持します。

次の例では、DrawingVisual オブジェクトを作成し、その DrawingContext に四角形を描画します。

        ' Create a DrawingVisual that contains a rectangle.
        Private Function CreateDrawingVisualRectangle() As DrawingVisual
            Dim drawingVisual As New DrawingVisual()

            ' Retrieve the DrawingContext in order to create new drawing content.
            Dim drawingContext As DrawingContext = drawingVisual.RenderOpen()

            ' Create a rectangle and draw it in the DrawingContext.
            Dim rect As New Rect(New Point(160, 100), New Size(320, 80))
            drawingContext.DrawRectangle(Brushes.LightBlue, CType(Nothing, Pen), rect)

            ' Persist the drawing content.
            drawingContext.Close()

            Return drawingVisual
        End Function

// Create a DrawingVisual that contains a rectangle.
private DrawingVisual CreateDrawingVisualRectangle()
{
    DrawingVisual drawingVisual = new DrawingVisual();

    // Retrieve the DrawingContext in order to create new drawing content.
    DrawingContext drawingContext = drawingVisual.RenderOpen();

    // Create a rectangle and draw it in the DrawingContext.
    Rect rect = new Rect(new System.Windows.Point(160, 100), new System.Windows.Size(320, 80));
    drawingContext.DrawRectangle(System.Windows.Media.Brushes.LightBlue, (System.Windows.Media.Pen)null, rect);

    // Persist the drawing content.
    drawingContext.Close();

    return drawingVisual;
}

FrameworkElement メンバーのオーバーライドの作成

ホストコンテナーオブジェクトは、ビジュアルオブジェクトのコレクションを管理します。このため、ホストコンテナーは派生 FrameworkElement クラスのメンバーオーバーライドを実装する必要があります。

オーバーライドする必要がある 2 つのメンバーを次に示します。

GetVisualChild : 子要素のコレクションから指定したインデックス位置にある子を返します。
VisualChildrenCount : この要素内の子ビジュアル要素の数を取得します。

次の例では、2 つの FrameworkElement メンバーのオーバーライドを実装します。


        ' Provide a required override for the VisualChildrenCount property.
        Protected Overrides ReadOnly Property VisualChildrenCount() As Integer
            Get
                Return _children.Count
            End Get
        End Property

        ' Provide a required override for the GetVisualChild method.
        Protected Overrides Function GetVisualChild(ByVal index As Integer) As Visual
            If index < 0 OrElse index >= _children.Count Then
                Throw New ArgumentOutOfRangeException()
            End If

            Return _children(index)
        End Function


        // Provide a required override for the VisualChildrenCount property.
        protected override int VisualChildrenCount
        {
            get { return _children.Count; }
        }

        // Provide a required override for the GetVisualChild method.
        protected override Visual GetVisualChild(int index)
        {
            if (index < 0 || index >= _children.Count)
            {
                throw new ArgumentOutOfRangeException();
            }

            return _children[index];
        }

ヒットテストのサポート

ホストコンテナーオブジェクトは、表示プロパティが表示されない場合でもイベント処理を提供できますが、その Visibility プロパティは必ず Visible に設定する必要があります。これにより、マウスの左ボタンが離されるなどのマウスイベントをトラップできる、ホストコンテナーのイベント処理ルーチンを作成できます。作成されたイベント処理ルーチンは、HitTest メソッドを呼び出してヒットテストを実装できます。このメソッドの HitTestResultCallback パラメーターは、ヒットテストの結果アクションを決定するために使用できるユーザー定義のプロシージャを参照します。

次の例では、ホストコンテナーオブジェクトとその子に対してヒットテストのサポートを実装します。

        ' Capture the mouse event and hit test the coordinate point value against
        ' the child visual objects.
        Private Sub MyVisualHost_MouseLeftButtonUp(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
            ' Retreive the coordinates of the mouse button event.
            Dim pt As Point = e.GetPosition(CType(sender, UIElement))

            ' Initiate the hit test by setting up a hit test result callback method.
            VisualTreeHelper.HitTest(Me, Nothing, New HitTestResultCallback(AddressOf myCallback), New PointHitTestParameters(pt))
        End Sub

        ' If a child visual object is hit, toggle its opacity to visually indicate a hit.
        Public Function myCallback(ByVal result As HitTestResult) As HitTestResultBehavior
            If result.VisualHit.GetType() Is GetType(DrawingVisual) Then
                If (CType(result.VisualHit, DrawingVisual)).Opacity = 1.0 Then
                    CType(result.VisualHit, DrawingVisual).Opacity = 0.4
                Else
                    CType(result.VisualHit, DrawingVisual).Opacity = 1.0
                End If
            End If

            ' Stop the hit test enumeration of objects in the visual tree.
            Return HitTestResultBehavior.Stop
        End Function

// Capture the mouse event and hit test the coordinate point value against
// the child visual objects.
void MyVisualHost_MouseLeftButtonUp(object sender, System.Windows.Input.MouseButtonEventArgs e)
{
    // Retreive the coordinates of the mouse button event.
    System.Windows.Point pt = e.GetPosition((UIElement)sender);

    // Initiate the hit test by setting up a hit test result callback method.
    VisualTreeHelper.HitTest(this, null, new HitTestResultCallback(myCallback), new PointHitTestParameters(pt));
}

// If a child visual object is hit, toggle its opacity to visually indicate a hit.
public HitTestResultBehavior myCallback(HitTestResult result)
{
    if (result.VisualHit.GetType() == typeof(DrawingVisual))
    {
        if (((DrawingVisual)result.VisualHit).Opacity == 1.0)
        {
            ((DrawingVisual)result.VisualHit).Opacity = 0.4;
        }
        else
        {
            ((DrawingVisual)result.VisualHit).Opacity = 1.0;
        }
    }

    // Stop the hit test enumeration of objects in the visual tree.
    return HitTestResultBehavior.Stop;
}

参照

DrawingVisual

HitTest

概念

WPF グラフィックスレンダリングの概要

ビジュアル層でのヒットテスト

Share via

DrawingVisual オブジェクトの使用

DrawingVisual オブジェクト

DrawingVisual ホストコンテナー

DrawingVisual オブジェクトの作成

FrameworkElement メンバーのオーバーライドの作成

ヒットテストのサポート

参照

参照

概念

その他のリソース

Share via

DrawingVisual オブジェクトの使用

DrawingVisual オブジェクト

DrawingVisual ホスト コンテナー

DrawingVisual オブジェクトの作成

FrameworkElement メンバーのオーバーライドの作成

ヒット テストのサポート

参照

参照

概念

その他のリソース

DrawingVisual ホストコンテナー

ヒットテストのサポート