In This Topic ▼

LAnnPolyRuler::SetLineWidth

Summary

Sets the unscaled line width of the annotation object.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnPolyRuler::SetLineWidth(dLineWidth, uFlags=0)

Parameters

L_DOUBLE dLineWidth

The unscaled line width of an object, relative to its container object. The width is interpreted using the container's scaling factors, which are described in Low-Level Coordinate System for Annotations.

L_UINT uFlags

Flags that determine the object to process. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

Value	Meaning
0	Process only the specified object.
ANNFLAG_SELECTED	[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.
ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

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

Comments

The line width of an object is relative to its container object, and the value is interpreted using the container's scaling factors. For example, suppose you want the line to be three pixels wide on your screen using the current scaling factors. You would use the following calculation, where A is the desired width of three pixels, B is the value that you get from the LAnnotation::GetScalarX function, and C is the value that you get from the LAnnotation::GetScalarY function:

dLineWidth = A / sqrt( B * C )

For more information, refer to Low-Level Coordinate System for Annotations.