Collapse All Expand All

LAnnAutomation::SetLineWidth

#include "ltwrappr.h"

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

L_DOUBLE dLineWidth;	/* the line width */
L_UINT uFlags;	/* reserved for future use */

Sets the unscaled line width of the annotation object.

Parameter	Description
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.
uFlags	Reserved for future versions, use 0.

Returns

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.

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:	LAnnAutomation::GetLineStyle, LAnnAutomation::SetLineStyle, LAnnAutomation::GetLineWidth, Class Members
Topics:	Annotation Functions: Object Properties

Example

For an example, refer to LAnnAutomation::GetLineWidth.