Stroke.GetBoundingBox Method (BoundingBoxMode)

Article
12/12/2007

Returns the bounding Rectangle that contains the Stroke object, by using the specified BoundingBoxMode flag to determine the bounds.

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

Syntax

'Declaration
Public Function GetBoundingBox ( _
    mode As BoundingBoxMode _
) As Rectangle
'Usage
Dim instance As Stroke
Dim mode As BoundingBoxMode
Dim returnValue As Rectangle

returnValue = instance.GetBoundingBox(mode)

public Rectangle GetBoundingBox (
    BoundingBoxMode mode
)

public:
Rectangle GetBoundingBox (
    BoundingBoxMode mode
)

public Rectangle GetBoundingBox (
    BoundingBoxMode mode
)

public function GetBoundingBox (
    mode : BoundingBoxMode
) : Rectangle

Not applicable.

Parameters

mode
A member of the BoundingBoxMode enumeration that specifies which characteristics of a Stroke object, such as drawing attributes, are used to calculate the bounding box of the Stroke object.

Return Value

Returns the bounding Rectangle that defines the bounding box for the Stroke object.

Remarks

The bounding Rectangle is in ink space coordinates.

The bounding Rectangle corresponds to the portion of the display to invalidate or redraw when displaying a Stroke object.

The bounding box is cached for all modes other than the BoundingBoxMode mode.

When the bounding box is affected by the pen width, then this width is scaled appropriately for the Renderer object's view transform. To do this, the pen width is multiplied by the square root of the determinant of the view transform.

Note

If you have not set the pen width explicitly, it is 53 by default. You must multiply the pen width by the square root of the determinant to yield the correct bounding box. The height and width of the bounding box are expanded by half this amount in each direction. For example, consider that the pen width is 53, the square root of the determinant is 50, and the bounding box is (0, 0, 1000, 1000). The pen width adjustment to the bounding box in each direction is calculated as (53 * 50) / 2, and the right and bottom sides are incremented by one. This results in a rendered bounding box of (-1325, -1325, 2326, 2326).

Note

The bounding Rectangle that this method returns is a copy of the bounding box of the Stroke object. Altering the Rectangle that this method returns has no affect on the bounding box of the original Stroke object.

Example

This C# example gets the bounding box from a Stroke object, theStroke. The example uses the CurveFit value of the BoundingBoxMode enumeration to determine the bounds of the bounding box.

Rectangle theBoundingBox = theStroke.GetBoundingBox(BoundingBoxMode.CurveFit);

This Microsoft® Visual Basic® .NET example gets the bounding box from a Stroke object, theStroke. The example uses the BoundingBoxMode value of the BoundingBoxMode enumeration to determine the bounds of the bounding box.

Dim theBoundingBox As Rectangle = theStroke.GetBoundingBox(BoundingBoxMode.CurveFit)

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Share via