L_AnnSetLineWidth

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetLineWidth(hObject, dLineWidth, uFlags)

HANNOBJECT hObject;

handle to the annotation object

L_DOUBLE dLineWidth;

unscaled line width of an object

L_UINT uFlags;

flags that determine which objects to process

Sets the unscaled line width of one or more annotation objects.

Parameter Description
hObject Handle to the annotation object.
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 Flags that determine which objects to process. Most of the flags apply only to container objects. 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 L_AnnGetSelected and L_AnnSetSelected functions.
  ANNFLAG_NOTTHIS [0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
  ANNFLAG_RECURSE [0x0008] Process objects within a container, and within any subcontainers, down to any level.
  ANNFLAG_NOTCONTAINER [0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
  ANNFLAG_NOINVALIDATE [0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.
  ANNFLAG_CHECKMENU [0x0020] Process objects only if the ANNAUTOTEXT_MENU_LINE menu item has been selected.

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 L_AnnGetScalarX function, and C is the value that you get from the L_AnnGetScalarY function:

dLineWidth = A / sqrt( B * C )

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

This function applies to multiple and selected objects based on values of the uFlags parameter.

This function does not affect objects that do not have this property or that do not let you change the property. For descriptions of the various types of objects and their properties, refer to Types of 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:

L_AnnGetLineWidth, L_AnnSetLineStyle, L_AnnGetLineStyle, L_AnnGetLineFixedWidth, L_AnnSetLineFixedWidth

Topics:

Annotation Functions: Object Properties

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Altering Annotation Object Settings

Example

L_INT AnnSetLineWidthExample(HANNOBJECT  hAnnObject, 
                                             L_DOUBLE*    LineWidth) /* Object line width */ 
{ 
   L_INT nRet; 
   /* Double the line width */ 
   nRet = L_AnnGetLineWidth(hAnnObject, LineWidth); 
   if(nRet != SUCCESS) 
      return nRet; 
   nRet = L_AnnSetLineWidth(hAnnObject, *LineWidth * 2, 0); 
   if(nRet != SUCCESS) 
      return nRet; 
   return SUCCESS; 
} 
Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help