IInkStrokeDisp::GetBoundingBox
4/8/2010
Gets the bounding box in ink space coordinates of an IInkStrokeDisp ink stroke object.
Syntax
HRESULT GetBoundingBox (
[in, optional, defaultvalue(IBBM_DEFAULT)] InkBoundingBoxMode BoundingBoxMode,
[out, retval] IInkRectangle **BoundingBox
);
Parameters
boundingBoxMode
[in, optional] Specifies the stroke characteristics to use to calculate the bounding box. For more details about the use of stroke characteristics to calculate a bounding box, see InkBoundingBoxMode.The boundingBoxMode parameter has a default value of IBBM_DEFAULT.
BoundingBox
[out, retval] Returns the rectangle that defines the bounding box of the IInkStrokeDisp object.Note
For an IInkStrokeDisp object, the returned bounding box is a copy of the stroke's bounding box, so altering the returned bounding box does not affect the stroke's location.
Return Value
- S_OK
Success.
- E_POINTER
A parameter contained an invalid pointer.
- E_INK_EXCEPTION
An exception occurred inside the method.
- E_UNEXPECTED
Unexpected parameter or property type.
- REGDB_CLASSNOTREG
The IInkRectangle object is not registered.
Remarks
When the bounding box is affected by the pen width, then this width is scaled appropriately for the IInkRenderer'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).
Requirements
| Header | msinkaut.h |
| Windows Embedded CE | Windows CE 5.0 and later |
| Windows Mobile | Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later |