LAnnPolyRuler::GetTicMarkLength
Summary
Gets the length of the tic mark of an ANNOBJECT_RULER or ANNOBJECT_POLYRULER. The tic marks are the perpendicular lines that measure the units.
Syntax
#include "ltwrappr.h"
virtual L_INT LAnnPolyRuler::GetTicMarkLength(pdLength)
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:
- ANNOBJECT_AUTOMATION
- ANNOBJECT_RULER
- ANNOBJECT_POLYRULER
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.
Required DLLs and Libraries
- LTANN
- For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.
Platforms
Win32, x64.
See Also
Functions
Topics
- Annotation Functions: Object Properties
- Implementing Annotations
- Automated User Interface for Annotations
- Annotation Functions: Creating and Deleting Annotations
- Annotation Functions: Working with the Toolbar
- Types of Annotations
- Key Annotation Features
- Calibrating Annotation Ruler Objects
Example
For an example, refer to LAnnPolyRuler::SetTicMarkLength.
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.
