Cleanup Variables

Land Desktop Development ARX CPP SDK

Up a level
Cleanup Variables
 
 

Cleanup variables store properties for cleanup models.

Cleanup variables are a subset of the configuration variables data structure.

Note  Data types cited below are AutoLISP types. The AutoLISP real corresponds to the C++ double. Similarly, integer corresponds to long.

ANCHOROBJS_FEATURES !! New !!  Classified objects to include, a comma-separated list of feature names (string), such as "Roads, Rivers, Streets". Default = "*" (all features).
ANCHOROBJS_LAYERS Anchored entities specified by tpm_cleaninitanchorset will be anchored only if they reside on layers specified here, with multiple layer names separated by commas. For example, "0,Layer1,Layer2". Default = "*" (any layer)
APPARENT_INTERSECTION_COLOR !! New !!  Color for apparent-intersection markers, an AutoCAD color index (integer). See Color Index Colors.
Default = 7 (white)
APPARENT_INTERSECTION_MARKER !! New !!  Marker shape for apparent-intersection errors (integer). See Marker Shapes.
Default = 2 (triangle)
ARC_TYPE Convert arcs to (integer):
0 = Arc (default)
1
= 2D polyline
CIRCLE_TYPE Convert circles to (integer):
0 = Circle (default)
1 = 2D polyline
2 = Arc
CLEAN_TOL Cleanup tolerance (positive real).
Default = 0.01
CLUSTER_COLOR Color for cluster markers, an AutoCAD color index (integer). See Color Index Colors.
Default = 5 (blue)
CLUSTER_MARKER Marker shape for cluster errors (integer). See Marker Shapes.
Default = 4 (square)
CONVERT Flag for the original entities conversion (integer).
0
= Do not convert (default)
1 = Convert
CORRIDOR Corridor width (positive real).
Default = 0.01
Note  If you are using an explicit cleanup action list (specifying cleanup actions using tpm_cleanactionlistins), this setting is ignored.
CROSS_COLOR Color for cross markers, an AutoCAD color index (integer). See Color Index Colors.
Default = 2 (yellow)
CROSS_MARKER Marker shape for cross errors (integer). See Marker Shapes.
Default = 1 (octagon)
DANGL_COLOR Color for dangling node markers, an AutoCAD color index (integer). See Color Index Colors.
Default = 1 (red)
DANGL_MARKER Marker shape for dangling node errors (integer). See Marker Shapes.
Default = 1 (octagon)
DEL_MARKER Whether to delete previous error markers (integer).
0 = Do not delete
1 = Delete (default)
DUPL_COLOR Color for duplicates markers, an AutoCAD color index (integer). See Color Index Colors.
Default = 6 (magenta)
DUPL_MARKER Marker shape for duplicate errors (integer). See Marker Shapes.
Default = 1 (octagon)
ENT_PROCESS Flag for original entities processing (integer).
1 = Convert original
2 = Create new and keep original
3 = Create new and delete original
Default = 0
GENERALIZE Flag for generalization (link simplication) (integer).
0 = Do not generalize (default)
1 = Generalize
Note  If you are using an explicit cleanup action list (specifying cleanup actions using tpm_cleanactionlistins), this setting is ignored.
INCLUDE_LINEAROBJS !! New !!  Whether to include linear objects while deleting duplicates (integer).
0 = Do not include.
1 = Include.
Default = 1.
INCLUDE_POINTS !! New !!  Whether to include points while deleting duplicates or snapping clustered nodes (integer).
0 = Do not include.
1 = Include.
Default = 1.
INCLUDE_BLOCKS !! New !!  Whether to include blocks while deleting duplicates or snapping clustered nodes (integer).
0 = Do not include.
1 = Include.
Default = 0.
INCLUDE_TEXT !! New !!  Whether to include text while deleting duplicates (integer).
0 = Do not include.
1 = Include.
Default = 0.
INCLUDE_MTEXT !! New !!  Whether to include mtext while deleting duplicates (integer).
0 = Do not include.
1 = Include.
Default = 1.
INCLUDE_ROTATION !! New !!  Whether to include rotation while deleting duplicates (integer).
0 = Do not include.
1 = Include.
Default = 0.
INCLUDE_ZVALUES !! New !!  Whether to include z-values while deleting duplicates (integer).
0 = Do not include.
1 = Include.
Default = 0.
SNAP_TO_NODE !! New !!  Whether to snap to nodes or links (integer).
0 = Snap to nodes.
1 = Snap to links.
Default = 0.
INCLUDEOBJS_AUTOSELECT How entities are specified for cleanup
0 = Select entities manually
(that is, by passing a selection set to tpm_cleaninit)
1 = Select all entities in the drawing
(in which case the selection set passed to tpm_cleaninit, if any, is ignored)
INCLUDEOBJS_FEATURES !! New !!  Classified objects to include, a comma-separated list of features (string), such as "Roads, Rivers, Streets". Default = "*" (all features).
INCLUDEOBJS_LAYERS Entities specified by tpm_cleaninit will be cleaned only if they reside on layers specified here, with multiple layer names separated by commas. For example, "0,Layer1,Layer2". Default = "*" (any layer)
LINE_TYPE Convert lines to (integer)
0 = Line (default)
1 = 2D polyline
LINK_COLOR Color for new links, an AutoCAD color index (integer). See Color Index Colors.
Negative integer = Current color
Default = -1
LINK_CORRECT Flag for link error correction (integer).
0 = Do not correct
1 = Correct (default)
Note  If you are using an explicit cleanup action list (specifying cleanup actions using tpm_cleanactionlistins), this setting is ignored.
LINK_ERROR Link error types (integer), sum of the desired options.
0 = None
1 = Short
2 = Cross
4 = Undershoot
8 = Duplicate
Default = 15
LINK_LAYER Layer name for new links (string).
nil = Current layer
Default = ""
MAINTAIN_MARKERS Flag to maintain markers when cleanup ends
0 = Do not maintain
1 = Maintain markers
This variable affects only errors that have not been fixed. If an error has been fixed, its marker is deleted at the end of the cleanup process no matter what (by tpm_cleanend).
MARKER_HEIGHT The height of error markers, a percent of screen height (positive real).
Default = 5.0
NODE_CORRECT Flag for node error correction (integer).
0 = Do not correct
1 = Correct (default)
Note  If you are using an explicit cleanup action list (specifying cleanup actions using tpm_cleanactionlistins), this setting is ignored.
NODE_ERROR Node error types (integer), sum of the desired options.
 0 = None
16 = Cluster
32 = Pseudo
64 = Dangling
Default = 48
POLY3D_TYPE Convert 3D polylines to (integer).
0 = 3D polyline (default)
1 = 2D polyline
PSEUDO_COLOR Color for pseudo node markers, an AutoCAD color index (integer). See Color Index Colors.
Default = 6 (magenta)
PSEUDO_MARKER Marker shape for pseudo node errors (integer). See Marker Shapes.
Default = 2 (triangle)
SHORT_COLOR Color for short markers, an AutoCAD color index (positive integer). See Color Index Colors.
Default = 1 (red)
SHORT_MARKER Marker shape for short errors (integer). See Marker Shapes.
Default = 1 (octagon)
UNDER_COLOR Color for undershoot markers, an AutoCAD color index (integer). See Color Index Colors.
Default = 3 (green)
UNDER_MARKER Marker shape for undershoot errors (integer). See Marker Shapes.
Default = 1 (octagon)
WEED_DISTANCE !! New !!  Weeding distance (real). Default = 15.0
WEED_ANGLE !! New !!  Weed distance (real). Default = 4.0
WEED_SUPPLEMENT_DISTANCE !! New !!  Weed supplement distance (real). Default = 100.0
WEED_SUPPLEMENT_BULGE !! New !!  Weed supplement bulge (real). Default = 1.0