LAnnRuler::GetTicMarkLength

#include "ltwrappr.h"

virtual L_INT LAnnRuler::GetTicMarkLength(pdLength)

Gets the length of the tic mark of an ANNOBJECT_RULER or ANNOBJECT_RULER. The tic marks are the perpendicular lines that measure the units.

Parameters

L_DOUBLE *pdLength

Address of the variable to be updated with the object's tic mark length.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

The tic mark length applies only to the following annotation objects:

The pdLength parameter is expressed in pixels, not in points. The length is for the whole line, not just from the intersection point with the ruler to the end point of the tic mark - it is from one end of the tic mark to the other end of the tic mark.

Note that a ruler can have tic marks of different lengths. For example, the ruler in the figure below has tic marks with several different lengths. In this case, pdLength is updated with the length of the longest tic mark.

image\Ruler.gif

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to LAnnRuler::SetTicMarkLength.

Help Version 21.0.2021.4.8
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help