StrokeIntersection.BeginIndex Property

Article
10/19/2012

Gets or sets the beginning point of the StrokeIntersection structure.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Property BeginIndex As Single
'Usage
Dim instance As StrokeIntersection 
Dim value As Single 

value = instance.BeginIndex

instance.BeginIndex = value

public float BeginIndex { get; set; }

public:
property float BeginIndex {
    float get ();
    void set (float value);
}

public function get BeginIndex () : float 
public function set BeginIndex (value : float)

Property Value

Type: System.Single
The floating point index where the intersection begins.

Remarks

If the stroke begins within the intersected area, this value is -1.

A floating point index is a float value that represents a location somewhere between two points in the stroke. As examples, if 0.0 is the first point in the stroke and 1.0 is the second point in the stroke, 0.5 is halfway between the first and second points. Similarly, a floating point index value of 37.25 represents a location that is 25 percent along the line between points 37 and 38 of the stroke.

Examples

In this example, all segments of a passed Stroke object that are inside the specified Rectangle structure are deleted. This is acomplished by examining the StrokeIntersection structures to determine where to split the passed Stroke object, and which segments to delete.

Private Sub DeleteInsideRectangle(ByVal S As Stroke, ByVal R As Rectangle)
    ' get the StrokeIntersection array 
    Dim SI() As StrokeIntersection = S.GetRectangleIntersections(R)
    ' examine each StrokeIntersection 
    ' must work backwards through the array so that when splitting,  
    ' the remaining intersections are still valid for S 
    For k As Integer = SI.Length - 1 To 0 Step -1

        Dim enterRect As Single = SI(k).BeginIndex
        Dim exitRect As Single = SI(k).EndIndex

        ' check if the whole stroke is inside the rectangle 
        ' if so, delete the stroke 
        If enterRect = -1 And exitRect = -1 Then
            S.Ink.DeleteStroke(S)
            Continue For 
        End If 

        ' check if a segment enters and exits the rectangle 
        ' if so, split and delete the segment inside the rectangle 
        If enterRect > 0 And exitRect > 0 Then 
            ' the stroke resulting from split() is outside, keep it
            S.Split(exitRect)
            ' the stroke from this split() is inside, delete it 
            Dim temp As Stroke = S.Split(enterRect)
            temp.Ink.DeleteStroke(temp)
            Continue For 
        End If 

        ' check if stroke starts inside the rectangle and goes outside 
        ' if so, split and delete the segment inside the rectangle 
        If enterRect = -1 And exitRect > 0 Then 
            ' the stroke resulting from split() is outside, keep it
            S.Split(exitRect)
            ' delete the remaining segment of the stroke
            S.Ink.DeleteStroke(S)
            Continue For 
        End If 

        ' check if stroke starts outside the rectangle and ends inside 
        ' if so, split and delete the segment inside the rectangle 
        If enterRect > 0 And exitRect = -1 Then 
            Dim temp2 As Stroke = S.Split(enterRect)
            temp2.Ink.DeleteStroke(temp2)
        End If 
    Next 
End Sub

private void DeleteInsideRectangle(Stroke S, Rectangle R)
{
    // get the StrokeIntersection array
    StrokeIntersection[] SI = S.GetRectangleIntersections(R);

    // examine each StrokeIntersection 
    // must work backwards through the array so that when splitting,  
    // the remaining intersections are still valid for S 
    for (int k = SI.Length - 1; k >= 0; k--)
    {
        float enterRect = SI[k].BeginIndex;
        float exitRect = SI[k].EndIndex;

        // check if the whole stroke is inside the rectangle 
        // if so, delete the stroke 
        if (enterRect == -1 && exitRect == -1)
        {
            S.Ink.DeleteStroke(S);
            continue;
        }

        // check if a segment enters and exits the rectangle 
        // if so, split and delete the segment inside the rectangle 
        if (enterRect > 0 && exitRect > 0)
        {
            // the stroke resulting from split() is outside, keep it
            S.Split(exitRect);
            // the stroke from this split() is inside, delete it
            Stroke temp = S.Split(enterRect);
            temp.Ink.DeleteStroke(temp);
            continue;
        }

        // check if stroke starts inside the rectangle and goes outside 
        // if so, split and delete the segment inside the rectangle 
        if (enterRect == -1 && exitRect > 0)
        {
            // the stroke resulting from split() is outside, keep it
            S.Split(exitRect);
            // delete the remaining segment of the stroke
            S.Ink.DeleteStroke(S);
            continue;
        }

        // check if stroke starts outside the rectangle and ends inside 
        // if so, split and delete the segment inside the rectangle 
        if (enterRect > 0 && exitRect == -1)
        {
            Stroke temp2 = S.Split(enterRect);
            temp2.Ink.DeleteStroke(temp2);
        }
    }
}

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

Share via