LAnnAutomation::SetNodes

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::SetNodes(bShowNodes=TRUE, uGapNodes=0, uFlags=0)

L_BOOL bShowNodes;	/* flag that indicates whether to show the nodes */
L_UINT uGapNodes;	/* distance between nodes */
L_UINT uFlags;	/* flags that determine which objects to process */

Determines which nodes will be shown for a Polygon object.

Parameter	Description
bShowNodes	Flag that indicates whether to show the nodes. Possible values are:
	Value	Meaning
	TRUE	Show the nodes.
	FALSE	Do not show the nodes.
uGapNodes	The distance between nodes. Use 0 to display all nodes. This value does not represent the distance in pixels. Instead, it refers to the number of nodes to skip before displaying another node. Possible values are:
	Value	Meaning
	0	Show every node.
	1	Show a node, skip a node, show a node
	.
	.
	.
	9	Show a node, skip the next nine,
	.
	.
	.and so on.
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 LAnnContainer::GetSelectItems and LAnnotation::SetSelected 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_NODES menu item has been selected.

Returns

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

Comments

This function determines how the nodes for the next polyline, polygon, freehand, or freehand hotspot objects, created in automated mode, will be displayed.

If bShowNodes is FALSE, uGapNodes will be ignored since the nodes will not be shown anyway.

Note:

The last node is always shown. Therefore, using a large value for uGapNodes will probably result in only the first and last nodes being shown.

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::GetNodes
Topics:	Annotation Functions: Object Properties
	Annotation Objects - Default Values
	Annotation Objects - Automated Features

Example

L_INT LAnnAutomation_SetNodesExample() 
{
   L_INT nRet;
   LAnnAutomation MyAnnAutomation;
   L_BOOL bShowNodes;
   L_UINT uGapNodes;
   nRet = MyAnnAutomation.GetNodes(&bShowNodes, &uGapNodes);
   if(nRet != SUCCESS)
      return nRet;
   //skip more nodes than currently skipping
   nRet = MyAnnAutomation.SetNodes(bShowNodes, uGapNodes + 1);
   if(nRet != SUCCESS)
      return nRet;
   //Get default ShowFlags
   L_UINT uShowFlags;
   nRet = MyAnnAutomation.GetShowFlags(&uShowFlags);
   if(nRet != SUCCESS)
      return nRet;
   //Do not display ruler gauge
   uShowFlags &= ~ANNSHOW_GAUGE;
   nRet = MyAnnAutomation.SetShowFlags(uShowFlags);
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}