The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
.VectorScript|VectorScript
..VS:Function Reference|Function Reference
..VS:Function_Reference_Appendix|Appendix
Appendix D - Vectorworks Object Types and Subtypes
The numeric types in the table below are useful for identifying what type of object is referenced by a handle. The function GetTypeN(h) will return one of these numeric types. The Criteria values in the table below are used in search criteria statements. They are used along with the criteria T= to search for objects of a specific type. For example, the following statement will count the number of rectangles in the active document:
Message(Count(T=RECT));
Object Types
Object |
Type |
Criteria
|
Line |
2 |
LINE
|
Rectangle |
3 |
RECT
|
Oval |
4 |
OVAL
|
Polygon |
5 |
POLY
|
Arc |
6 |
ARC
|
Freehand |
8 |
FHAND
|
3D Locus |
9 |
LOCUS3D
|
Text |
10 |
TEXT
|
Group |
11 |
GROUP
|
Rounded rectangle |
13 |
RRECT
|
Bitmap Image |
14 |
BITMAP
|
Symbol in document |
15 |
SYMBOL
|
Symbol definition |
16 |
|
2D Locus |
17 |
LOCUS
|
Worksheet |
18 |
SPRDSHEET
|
Polyline |
21 |
POLYLINE
|
PICT Image |
22 |
PICT
|
Extrude |
24 |
XTRD
|
3D Polygon |
25 |
POLY3D
|
Layer Link |
29 |
LAYERLINK
|
Layer |
31 |
|
Sweep |
34 |
SWEEP
|
Multiple extrude |
38 |
MXTRD
|
Mesh |
40 |
MESH
|
Mesh vertex |
41 |
|
Record Definition (Format) |
47 |
|
Record |
48 |
|
Document script (1) |
49 |
|
Script palette (1) |
51 |
|
Worksheet container |
56 |
|
Dimension |
63 |
DIMENSION
|
Hatch definition (1) |
66 |
|
Wall |
68 |
WALL
|
Column, Floor, Roof Face |
71 |
SLAB
|
Light |
81 |
LIGHT
|
Roof edge |
82 |
|
Roof object |
83 |
ROOF
|
CSG Solid (Addition, Subtraction) |
84 |
CSGSOLID
|
Plug-in object |
86 |
PLUGINOBJECT
|
Roof element |
87 |
ROOFELEMENT
|
Round walls |
89 |
ROUNDWALL
|
Symbol folder |
92 |
|
Texture |
93 |
|
Class definition (1) |
94 |
|
Texture Definition (Material) |
97 |
|
Solid (Cone, Sphere, ...) |
95 |
SOLID
|
NURBS Curve |
111 |
NURBSCURVE
|
NURBS Surface |
113 |
NURBSSURFACE
|
Image Fill Definition (1) |
119 |
|
Gradient Fill Definition (1) |
120 |
|
Fill Space (1) |
121 |
|
ViewPort |
122 |
|
- Notes
- These special objects are not directly displayed in the document. They may contain definition information used by other objects or features.
Object Subtypes
Object |
Type |
Criteria
|
Directional Light |
500 |
DIRLIGH
|
Spot Light |
501 |
SPOTLIGHT
|
Point Light |
502 |
POINTLIGHT
|
Custom Light |
503 |
CUSTLIGH
|
Area Light |
504 |
AREALIGH
|
Line Light |
505 |
LINELIGH
|
Sheet Layer Viewport |
506 |
REGVIEWPOR
|
Section Viewport |
507 |
SECTVIEWPOR
|
Floor |
508 |
FLOO
|
Roof Face |
509 |
ROOFFAC
|
Pillar |
510 |
PILLA
|
Cone |
511 |
CON
|
Sphere |
512 |
SPHER
|
Hemisphere |
513 |
HEMISPHER
|
Circle |
514 |
CIRCL
|
Opened Arc |
515 |
OPENEDAR
|
Solid Subtraction |
516 |
CSGSUBT
|
Solid Addition |
517 |
CSGAD
|
Solid Intersection |
518 |
CSGINTE
|
Solid Section |
519 |
CSGSEC
|
Solid Shell |
520 |
CSGSHEL
|
Chamfer |
521 |
CSGCHAMFE
|
Fillet |
522 |
CSGFILLE
|
Control point based NURBS surface |
523 |
NURBSSURFCTRL
|
Interpolated NURBS surface |
524 |
NURBSSURFINTER
|
- Notes
- These special objects are not directly displayed in the document. They may contain definition information used by other objects or features.
Appendix E - Miscellaneous Selectors
Attribute Criteria
Attribute Type |
Selector |
Type |
Exampl
|
All Objects |
ALL |
|
ALL
|
Attached Record |
R |
64 character STRING |
R IN ['Part Data'])
|
Class |
C |
64 character STRING |
C=DOOR
|
Descend into Objects |
INOBJECT |
|
(T=RECT) & INOBJECT
|
Descend into Symbols |
INSYMBOL |
|
(T=RECT) & INSYMBOL
|
Fill Background |
FB |
Color index (0 to 255) |
FB=34
|
Fill Foreground |
FF |
Color index (0 to 255) |
FF=56
|
Fill Pattern |
FP |
INTEGER |
FP=1
|
Flipped Status |
ISFLIPPED |
|
((S='3680 Door') & (ISFLIPPED))
|
Font |
FOT |
|
FOT=“Arial”
|
Font Size |
FSZ |
|
FSZ=10
|
Gradient Fill |
GFI |
|
GFI=“Fall”
|
Hatch Fill |
HFI |
|
HFI=“Stipple Dark”
|
Image Fill |
IFI |
|
IFI=“Stones”
|
Layer |
L |
64 character STRING |
L="Plan1"
|
Line Weight |
LW |
INTEGER |
W=20
|
Location is contained within boundary of a named object |
LOC |
|
(LOC='MyRoom')
|
Marker |
AR |
INTEGER (0 - 27) |
AR=3
|
Object Name |
N |
64 character STRING |
N="Joe"
|
Object Type |
T |
See Object Type table |
T=RECT
|
Pen Background |
PB |
Color index (0 to 255) |
PB=128
|
Pen Foreground |
PF |
Color index (0 to 255) |
PF=256
|
Pen Pattern / Line Style |
PP |
INTEGER (patterns 0 to 71) or (dash -1 to -10) |
PP=-1
|
Selected status |
SEL |
BOOLEAN |
SEL=TRUE
|
Sketch Style |
SST |
|
SST=“Rough”
|
Symbol Name |
S |
64 character STRING |
S="Window"
|
Texture |
TX |
|
TX=“Glass”
|
Visibility Status |
V |
BOOLEAN |
V=TRUE
|
Wall Style |
WST |
|
WST=“Wallstyle-1”
|
Fill Patterns
Color Palette
Linestyles
Style |
Selector
|
Short Dash |
-1
|
Medium Dash |
-2
|
Long Dash |
-3
|
Very Long Dash |
-4
|
Dotted |
-5
|
Dash-Dot |
-6
|
Dash-Dash-Dot |
-7
|
Dash-Dot-Dot |
-8
|
Centerline |
-9
|
Break Line |
-10
|
SetTool - CallTool Selectors
Tool |
Selector |
Tool |
Selector
|
2D Selection Cursor |
-240 |
Regular Polygon |
-225
|
3D Selection Cursor |
-349 |
Clipping |
-226
|
Pan |
-241 |
Quarter Arc |
-227
|
Zoom In |
-242 |
Center Mark |
-228
|
Zoom Out |
-243 |
Number Stamp |
-229
|
Text |
-200 |
3D View Translate |
-300
|
Line |
-201 |
3D View Rotate |
-301
|
Arc |
-202 |
Walkthrough |
-302
|
Rectangle |
-203 |
Flyover |
-303
|
Polyline |
-204 |
Translate Working Plane |
-304
|
Oval |
-205 |
Rotate Working Plane |
-305
|
Fillet |
-206 |
Set Working Plane |
-306
|
2D Polygon |
-207 |
Move Working Plane |
-307
|
Wall |
-208 |
3D Reshape |
-308
|
2D Symbol |
-209 |
3D Symbol |
-309
|
Constrained Dimension |
-210 |
Extrude |
-310
|
Unconstrained Dimension |
-211 |
Slab |
-311
|
Radial-Diam Dimension |
-212 |
Align Plane |
-312
|
Angular Dimension |
-213 |
3D Polygon |
-313
|
2D Reshape |
-214 |
3D Mirror |
-314
|
2D Rotate |
-215 |
3D Rotate |
-315
|
Double Line |
-216 |
3D Locus |
-316
|
Rounded Rectangle |
-217 |
Create Light |
-317
|
Double Line Polygon |
-218 |
Round Wall |
-318
|
Chamfer |
-219 |
Create Sphere |
-319
|
Freehand |
-220 |
Create Hemisphere |
-320
|
2D Locus |
-221 |
Create Cone |
-321
|
2D Mirror |
-222 |
Wall Join |
-322
|
Leader |
-223 |
Wall Heal |
-323
|
Fill Edit |
-341 |
Cavity Join |
-340
|
Rotated Rectangle |
-224 |
Render Bitmap |
-324
|
NURBS Curve |
-325 |
Chamfer Edge |
-342
|
NURBS Circle |
-328 |
Extract Surface |
-346
|
NURBS Arc |
-329 |
Fillet Edge |
-343
|
Curve Split |
-326 |
Loft |
-344
|
Connect/Combine |
-327 |
Project and Trim |
-345
|
Shell Solid |
-347 |
Create Contours |
-348
|
Analyze Curves and Surfaces |
-333 |
Protrusion/Cutout |
-332
|
Plug-in Object Parameter Record Field Types
Field Data Type |
Selector
|
Integer |
1
|
Boolean |
2
|
Real |
3
|
Text |
4
|
Real - Coordinate Displacement |
7
|
Text - Popup Menu Item |
8
|
Text - Radio Button |
9
|
Real - Coordinate Location X |
10
|
Real - Coordinate Location Y |
11
|
Static Text |
14
|
Record - Worksheet Field Types
Field Data Type |
Selector
|
Integer |
1
|
Boolean |
2
|
Number-general |
3
|
Text |
4
|
Number-decimal |
5
|
Number-decimal w/ commas |
6
|
Number-scientific |
7
|
Number-fractional |
8
|
Number-dimension |
9
|
Number-angle |
10
|
Number-date/time |
11
|
Number-dimension area |
14
|
Number-dimension volume |
15
|
Record - Worksheet Field Display Styles
Field Data Type |
Display Style |
Selector
|
Boolean |
TRUE |
1
|
|
FALSE |
2
|
Number-decimal |
no. decimal places |
0 to 9
|
Number-decimal w/ commas |
no. decimal places |
0 to 9
|
Number-scientific |
no. decimal places |
0 to 9
|
Number-fractional |
rounding value |
2,4,8,16,32, etc.
|
Number-angle |
degrees |
1
|
|
deg-minutes |
2
|
|
deg-min-seconds |
3
|
Number-date/time |
mdy |
1
|
|
mdy hmm |
2
|
|
dmy |
3
|
|
ymd |
4
|
|
ymd hmm |
5
|
|
d-mmm-y |
6
|
|
d-mmm |
7
|
|
mmm-y |
8
|
|
h mm |
9
|
|
h mm s |
10
|
|
h mm(AM/PM) |
11
|
|
h mm s(AM/PM) |
12
|
LinearDim
Description |
Selector
|
Constrained Horizontal |
0
|
Constrained Vertical |
1
|
Horizontal Ordinate |
2
|
Vertical Ordinate |
3
|
Unconstrained |
4
|
Description |
Selector
|
Used calculated position |
1
|
Dim line inside-outside |
2
|
Start witness ON-OFF |
256
|
End witness ON-OFF |
512
|
Description |
Selector
|
Used calculated position |
1
|
Text inside-outside |
2
|
Text above dim line |
256
|
Text aligned to dim line |
512
|
Force text horizontal |
1024
|
CircularDim
Description |
Selector
|
Diameter dimension |
0
|
Other circular dimensions |
1
|
Description |
Selector
|
Used calculated position |
1
|
Dim line inside-outside |
2
|
Start witness ON-OFF |
256
|
End witness ON-OFF |
512
|
Description |
Selector
|
Used calculated position |
1
|
Text inside-outside |
2
|
Text above dim line |
256
|
Text aligned to dim line |
512
|
Force text horizontal |
1024
|
AngularDim
Description |
Selector
|
Used calculated position |
1
|
Dim line inside-outside |
2
|
Start witness ON-OFF |
256
|
End witness ON-OFF |
512
|
Reference angle |
1024
|
2 reference lines |
2048
|
Description |
Selector
|
Used calculated position |
1
|
Text inside-outside |
2
|
Text above dim line |
256
|
Text aligned to dim line |
512
|
Force text horizontal |
1024
|
Appendix F - Preference Selectors
Application Preference Selectors
Preference |
Selector |
Preference Value |
Function
|
Click-Drag Mode |
0 |
TRUE or FALSE |
VS:GetPref
|
Offset Duplicates |
1 |
TRUE or FALSE |
VS:GetPref
|
Full Screen Cursor |
2 |
TRUE or FALSE |
VS:GetPref
|
Show Screen Hints |
3 |
TRUE or FALSE |
VS:GetPref
|
Floating Datum |
4 |
TRUE or FALSE |
VS:GetPref
|
Snap To Loci |
5 |
TRUE or FALSE |
VS:GetPref
|
Show Rulers |
6 |
TRUE or FALSE |
VS:GetPref
|
Show Scroll Bars |
7 |
TRUE or FALSE |
VS:GetPref
|
No Fill Behind Text |
8 |
TRUE or FALSE |
VS:GetPref
|
Zoom Line Thickness |
9 |
TRUE or FALSE |
VS:GetPref
|
Black and White Only |
10 |
TRUE or FALSE |
VS:GetPref
|
Use Layer Colors |
11 |
TRUE or FALSE |
VS:GetPref
|
Log Time in Program |
12 |
TRUE or FALSE |
VS:GetPref
|
Adjust Flipped Text |
13 |
TRUE or FALSE |
VS:GetPref
|
Show Other Objects While In Group |
14 |
TRUE or FALSE |
VS:GetPref
|
Show 3D Axis Labels |
15 |
TRUE or FALSE |
VS:GetPref
|
Use Black Background |
16 |
TRUE or FALSE |
VS:GetPref
|
Use Eight Selection Handles |
17 |
TRUE or FALSE |
VS:GetPref
|
Use Sound |
18 |
TRUE or FALSE |
VS:GetPref
|
Issue Undo Warnings |
19 |
TRUE or FALSE |
VS:GetPref
|
Opaque SmartCursor |
20 |
TRUE or FALSE |
VS:GetPref
|
Stop VectorScript on Warnings |
21 |
TRUE or FALSE |
VS:GetPref
|
Left Palette Margin |
22 |
TRUE or FALSE |
VS:GetPref
|
Right Palette Margin |
23 |
TRUE or FALSE |
VS:GetPref
|
Use Save Reminder |
24 |
TRUE or FALSE |
VS:GetPref
|
Show Parametric Constraints |
25 |
TRUE or FALSE |
VS:GetPref
|
Display Minor Alerts on Mode Bar |
27 |
TRUE or FALSE |
VS:GetPref
|
Associate Dimensions |
28 |
TRUE or FALSE |
VS:GetPref
|
Spell Check Capitalized Words |
29 |
TRUE or FALSE |
VS:GetPref
|
Spell Check Words in ALL CAPS |
30 |
TRUE or FALSE |
VS:GetPref
|
Spell Check Mixed Case Words |
31 |
TRUE or FALSE |
VS:GetPref
|
Spell Check Words With Numbers |
32 |
TRUE or FALSE |
VS:GetPref
|
Auto Join Walls |
33 |
TRUE or FALSE |
VS:GetPref
|
Show Page Breaks |
34 |
TRUE or FALSE |
VS:GetPref
|
Show Grid |
35 |
TRUE or FALSE |
VS:GetPref
|
Print Grid |
36 |
TRUE or FALSE |
VS:GetPref
|
Snap To Grid |
37 |
TRUE or FALSE |
VS:GetPref
|
Snap To Object |
38 |
TRUE or FALSE |
VS:GetPref
|
Save By Time |
39 |
TRUE or FALSE |
VS:GetPref
|
Save Confirm |
40 |
TRUE or FALSE |
VS:GetPref
|
Save To Backup |
41 |
TRUE or FALSE |
VS:GetPref
|
Palette Docking |
43 |
TRUE or FALSE |
VS:GetPref
|
Create Dimensions in Dimension Class |
44 |
TRUE or FALSE |
VS:GetPref
|
Accelerated 2D Navigation |
45 |
TRUE or FALSE |
VS:GetPref
|
Use Vector Caching |
46 |
TRUE or FALSE |
VS:GetPref
|
Sketch Hidden Line |
47 |
TRUE or FALSE |
VS:GetPref
|
Snap to Edge Points |
48 |
TRUE or FALSE |
VS:GetPref
|
Show Page Boundary |
49 |
TRUE or FALSE |
VS:GetPref
|
Display Default Content |
130 |
TRUE or FALSE |
VS:GetPref
|
Dimension Slash Thickness Unit |
50 |
3 = points, 2 = mils, 1 = mm |
VS:GetPrefInt
|
3D Rotation Responsiveness |
52 |
1(detailed)..5(responsive) |
VS:GetPrefInt
|
Custom Constraint Angle |
53 |
REAL (degrees) |
VS:GetPrefReal
|
Snap Radius |
54 |
INTEGER value |
VS:GetPrefInt
|
2D Conversion Resolution |
55 |
INTEGER value |
VS:GetPrefInt
|
3D Conversion Resolution |
56 |
INTEGER value |
VS:GetPrefInt
|
Current Document Text Size |
57 |
REAL |
VS:GetPrefReal
|
Current Document Text Style |
58 |
0 (Plain) |
VS:GetPrefInt
|
|
|
1 (Bold) |
"
|
|
|
2 (Italic) |
"
|
|
|
4 (Underline) |
"
|
|
|
8 (Outline [Mac only]) |
"
|
|
|
16 (Shadow [Mac only]) |
"
|
Current Document Text Justification |
82 |
1 (Left) |
VS:GetPrefInt
|
|
|
2 (Center) |
"
|
|
|
3 (Right) |
"
|
Current Document Text Vertical Alignment |
83 |
1 (TopBox) |
VS:GetPrefInt
|
|
|
2 (TopBaseline) |
"
|
|
|
3 (CenterBox) |
"
|
|
|
4 (BottomBaseline) |
"
|
|
|
5 (BottomBox) |
"
|
Current Document Text Vertical Spacing |
84 |
0 (Custom Leading) |
VS:GetPrefInt
|
|
|
2 (Single) |
"
|
|
|
3 (Three Halves) |
"
|
|
|
4 (Double) |
"
|
Current Document Text Vertical Spacing Custom Value |
85 |
REAL |
VS:GetPrefReal
|
Maximum Number of Undos |
59 |
INTEGER |
VS:GetPrefInt
|
Undo View Changes |
26 |
1 (never) |
VS:GetPrefInt
|
|
|
2 (combine all) |
"
|
|
|
3 (combine similar) |
"
|
|
|
4 (combine none) |
"
|
Save Interval |
60 |
no. of minutes |
VS:GetPrefInt
|
Display Light Objects |
61 |
0(always) |
VS:GetPrefInt
|
|
|
1(wireframe) |
"
|
|
|
2(never) |
"
|
Display 3D Loci Objects |
91 |
0(always) |
VS:GetPrefInt
|
|
|
1(wireframe) |
|
|
|
2(never) |
|
Retain QuickDraw 3D Model |
62 |
1(never)...5(always) |
VS:GetPrefInt
|
Rotated Text Display |
63 |
0(box) |
VS:GetPrefInt
|
|
|
1(normal) |
"
|
|
|
2(high) |
"
|
Bitmap Display |
64 |
0(box) |
VS:GetPrefInt
|
|
|
1(low res) |
"
|
|
|
2(hi res) |
"
|
Dimension Slash Thickness |
65 |
INTEGER value (mils) |
VS:GetPrefInt
|
Hidden Line Dash Style |
66 |
INTEGER selector |
VS:GetPrefInt
|
Hidden Line Shading |
67 |
1(dark)...4(light) |
VS:GetPrefInt
|
Grid X |
78 |
REAL |
VS:GetPrefReal
|
Grid Y |
79 |
REAL |
VS:GetPrefReal
|
Page Origin X |
80 |
REAL (current units) |
VS:GetPrefReal
|
Page Origin Y |
81 |
REAL (current units) |
VS:GetPrefReal
|
Page Scaling Factor |
70 |
REAL |
VS:GetPrefReal
|
Dimension Standard |
71 |
1 (Arch) |
VS:GetPrefInt
|
|
|
2 (ASME) |
"
|
|
|
3 (BSI) |
"
|
|
|
4 (DIN) |
"
|
|
|
5 (ISO) |
"
|
|
|
6 (JIS) |
"
|
|
|
7 (SIA) |
"
|
|
|
8 (ASME Dual Side-by-Side) |
"
|
|
|
9 (ASME Dual Stacked) |
"
|
Defacet Angle |
72 |
REAL (0-90) |
VS:GetPrefReal
|
Grid Angle |
73 |
REAL |
VS:GetPrefReal
|
Move Objects on Grid Keys |
74 |
1 (arrow) |
VS:GetPrefInt
|
|
|
2 (cmd+arrow) |
"
|
|
|
3 (shift+arrow) |
"
|
|
|
4 (shift+cmd+arrow) |
"
|
Nudge Objects Keys |
75 |
1-4 (see above) |
VS:GetPrefInt
|
Pan Drawing Keys |
76 |
1-4 (see above) |
VS:GetPrefInt
|
Switch Active Layer/Class Keys |
77 |
1-4 (see above) |
VS:GetPrefInt
|
Default Compression |
86 |
1 = JPEG, 2 = PNG |
VS:GetPrefInt
|
Line Weight Array Count |
87 |
INTEGER |
VS:GetPrefInt
|
Sound Volume |
88 |
INTEGER |
VS:GetPrefInt
|
Custom Move Distance |
89 |
REAL |
VS:GetPrefReal
|
Plan Rotation |
92 |
TRUE or FALSE |
VS:GetPref
|
Plan Rotation Angle |
93 |
REAL (read-only) |
VS:GetPrefReal
|
Stack Layers |
94 |
TRUE or FALSE |
VS:GetPref
|
Stack Layers Create 2D Objects |
95 |
TRUE or FALSE |
VS:GetPref
|
Stack Layers Ignore Other Scales |
96 |
TRUE or FALSE |
VS:GetPref
|
Stack Layers Restore Views |
97 |
TRUE or FALSE |
VS:GetPref
|
Use Open MP Multithreading |
98 |
0 (no) |
VS:GetPrefInt
|
|
|
1 (yes) |
"
|
|
|
2 (partial) |
"
|
Stack Layers Center View |
99 |
TRUE or FALSE |
VS:GetPref
|
Text Font Name |
100 |
STRING |
VS:GetPrefString
|
Stack Layers Show Page Boundary |
101 |
TRUE or FALSE |
VS:GetPref
|
Stack Layers Only Active Layer 2D Objects |
102 |
TRUE or FALSE |
VS:GetPref
|
Angular Precision |
120 |
INTEGER |
VS:GetPrefInt
|
Angular Unit |
121 |
0 (degrees) |
VS:GetPrefInt
|
|
|
1 (radians) |
“
|
|
|
2 (gradians) |
“
|
Resetting Plugin-ins During File Read |
129 |
TRUE or FALSE |
VS:GetPref
|
Display Default Content |
130 |
TRUE or FALSE |
VS:GetPref
|
Auto File Extensions On Mac |
131 |
TRUE or FALSE |
VS:GetPref
|
Use Advanced Imaging |
132 |
TRUE or FALSE |
VS:GetPref
|
Use Anti Aliasing |
133 |
TRUE or FALSE |
VS:GetPref
|
Auto Associate Dims |
134 |
TRUE or FALSE |
VS:GetPref
|
Mouse Wheel Zoom |
135 |
TRUE or FALSE |
VS:GetPref
|
Use Custom Move Distance |
136 |
TRUE or FALSE |
VS:GetPref
|
Print Switch Binary |
137 |
TRUE or FALSE |
VS:GetPref
|
Unit1 Dim Fraction Display Style |
190 |
0 (regular style) |
VS:GetPrefInt
|
|
|
1 (diagonal style) |
“
|
|
|
2 (horizontal style) |
“
|
DXF Add Prefix To DXF Layers |
328 |
TRUE or FALSE |
VS:GetPref
|
DXF Prefix To DXF Edit |
329 |
STRING value |
VS:GetPrefString
|
DXF External Refs Handling |
330 |
0 (Bind External Refs) |
VS:GetPrefInt
|
|
|
1 (Ignore External Refs) |
“
|
|
|
2 (Create VW Refs) |
“
|
|
|
3 (Use Layer Import) |
“
|
DXF ADT Objects 2D View |
331 |
TRUE or FALSE |
VS:GetPref
|
Use Framed Highlighting |
410 |
TRUE or FALSE |
VS:GetPref
|
Smart Cursor Show Interactive Segment |
411 |
TRUE or FALSE |
VS:GetPref
|
Snap To Tool Snap Geometry Only |
460 |
TRUE or FALSE |
VS:GetPref
|
whether to coordinate sheet and drawing numbers for various items |
544 |
TRUE or FALSE |
VS:GetPref
|
Auto Save To Custom Location |
552 |
TRUE or FALSE |
VS:GetPref
|
Autosave Custom Location |
554 |
STRING value |
VS:GetPrefString
|
Keep Backups By Number Value |
555 |
TRUE or FALSE |
VS:GetPref
|
Center View |
558 |
TRUE or FALSE |
VS:GetPref
|
Release Version Integer |
570 |
SHORT - The release version integer defaults to 0 |
VS:GetPrefInt
|
get/set the insertion mode of the symbol tool |
580 |
SHORT |
VS:GetPrefInt
|
get/set the wall insertion mode of the symbol tool |
581 |
SHORT |
VS:GetPrefInt
|
get/set the alignment mode of the symbol tool |
582 |
SHORT |
VS:GetPrefInt
|
Parametric Enable State Eventing |
590 |
0 (NoStateEvents) |
VS:GetPrefInt
|
|
|
1 (ResetStatesEvent) |
“
|
|
|
2 (InternalStatesEvent) |
“
|
Primary Units Selectors
Secondary Units Selectors
DXF Preference Selectors
Gradient and Image Fill Preference Selectors
Misc. Preference Selectors
- Notes
- Symbol Tool Insert Mode:
- 1 - Regular Insertion
- 2 - Offset Insertion
- 3 - Pick-up Mode
- Symbol Tool Alignement Mode:
- 1 - Left
- 2 - Center
- 3 - Right
- 4 - Natural
Appendix G - Object Selectors
Dimensions
Object Setting |
Selector |
Setting Value |
Function Type
|
Dimension Standard |
0 |
1 (Arch) |
VS:GetObjectVariableInt
|
|
|
2 (ASME) |
"
|
|
|
3 (BSI) |
"
|
|
|
4 (DIN) |
"
|
|
|
5 (ISO) |
"
|
|
|
6 (JIS) |
"
|
|
|
7 (SIA) |
"
|
|
|
8 (ASME Dual Side-by-Side) |
"
|
|
|
9 (ASME Dual Stacked) |
"
|
Arrows Inside |
3 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Use Text Box (Primary Value) |
5 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Show Primary Dimension Text |
6 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Display Starting Witness Line |
7 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Display Ending Witness Line |
8 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Leader Text (Primary) |
9 |
31 character STRING value |
VS:GetObjectVariableString
|
Trailer Text (Primary) |
10 |
31 character STRING value |
VS:GetObjectVariableString
|
Dimension Tolerancing |
11 |
0 (no tolerance) |
VS:GetObjectVariableInt
|
|
|
1 (single tolerance) |
"
|
|
|
2 (double tolerance) |
"
|
|
|
3 (limit tolerance) |
"
|
Dimension Text Offset |
15 |
REAL |
VS:GetObjectVariableReal
|
Dimension Text Font Size |
17 |
REAL |
VS:GetObjectVariableReal
|
Dimension Text Font Style |
19 |
0 (Plain) |
VS:GetObjectVariableInt
|
|
|
1 (Bold) |
"
|
|
|
2 (Italic) |
"
|
|
|
4 (Underline) |
"
|
|
|
8 (Outline [Mac only]) |
"
|
|
|
16 (Shadow [Mac only]) |
"
|
Dimension Precision (Primary) |
20 |
For decimal precision: value is digits after decimal point. |
VS:GetObjectVariableLongInt
|
|
|
For fractional precision: value is power of 2 for fractional denominator (1 for 1/2, 2 for 1/4, 3 for 1/8, 4 for 1/16, etc). |
"
|
|
|
For angular precision: 1 for whole number, 2 (degrees min), 3 (degrees min sec), 5 (x.x angular units), 6 (x.xx), 7 (x.xxx), 8 (x.xxxx), 9 (x.xxxxx), 10 (x.xxxxxx), 11 (x.xxxxxxx), 12 (x.xxxxxxxx) |
"
|
Dimension Precision (Secondary) |
21 |
For decimal precision: value is digits after decimal point. |
VS:GetObjectVariableLongInt
|
|
|
For fractional precision: value is power of 2 for fractional denominator (1 for 1/2, 2 for 1/4, 3 for 1/8, 4 for 1/16, etc). |
"
|
|
|
For angular precision: value is not used. |
"
|
Use Text Box (Secondary) |
22 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Show Secondary Dimension Text |
23 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Leader Text (Secondary) |
24 |
31 character STRING value |
VS:GetObjectVariableString
|
Trailer Text (Secondary) |
25 |
31 character STRING value |
VS:GetObjectVariableString
|
Dimension Type |
26 |
0 (Constrained) |
VS:GetObjectVariableInt
|
|
|
1 (Unconstrained) |
"
|
|
|
2 (Ordinate) |
"
|
|
|
3 (Radial) |
"
|
|
|
4 (Diameter) |
"
|
|
|
5 (Angular) |
"
|
Dimension Standard Name |
27 |
STRING value |
VS:GetObjectVariableString
|
Dimension Font ID |
28 |
Font ID |
VS:GetObjectVariableInt
|
Calculate Dim Text Position |
29 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Force Dim Text Inside |
30 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Angle is Reference |
31 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Show Only Primary |
32 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Show Only Secondary |
33 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Top Tolerance Value |
34 |
REAL value |
VS:GetObjectVariableReal
|
Bottom Tolerance Value |
35 |
REAL value |
VS:GetObjectVariableReal
|
Top Tolerance String |
36 |
STRING |
VS:GetObjectVariableString
|
Bottom Tolerance String |
37 |
STRING |
VS:GetObjectVariableString
|
Use Tolerance Strings |
38 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Flip Text |
39 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Dimension Text Font Size |
40 |
in points |
VS:GetObjectVariableReal
|
Dimension Text Rotation |
41 |
0 = Aligned, 1 = Horizontal, 2 = Horiz/Vertical |
VS:GetObjectVariableInt
|
Dim Text Offset Above Line |
43 |
REAL (current units) |
VS:GetObjectVariableReal
|
Dim Text Offset |
44 |
REAL value |
VS:GetObjectVariableReal
|
Dimension Offset |
45 |
REAL (current units) |
VS:GetObjectVariableReal
|
Show Elevation Dimension (SIA Only) |
46 |
TRUE or FALSE |
VS:GetObjectVariableBoolean
|
Elevation Dimension Value (SIA Only) |
47 |
REAL value |
VS:GetObjectVariableReal
|
Leader Text for Elevation Dimension (SIA Only) |
48 |
31 character STRING value |
VS:GetObjectVariableString
|
Trailer Text for Elevation Dimension (SIA Only) |
49 |
31 character STRING value |
VS:GetObjectVariableString
|
Lights
Symbols
Roofs,Floors,Columns
- Notes
- Height is the bottom of the slab for floors and columns, elevation of the roof axis for roofs.
- Roof only.
- A value between 0 and 1 indicating the percentage of the miter which is vertical.
Layer
Layer Link
Viewports
- Notes
- View Type values are different then SetView
viewUserDefined |
0
|
viewFront |
3
|
viewBack |
4
|
viewLeft |
5
|
viewRight |
6
|
viewTop |
7
|
viewBottom |
8
|
viewRightIso |
9
|
viewLeftIso |
10
|
viewRightRearIso= 11;
|
viewLeftRearIso |
12
|
viewBottomRightIso= 13;
|
viewBottomLeftIso= 14;
|
viewBottomRightRearIso |
15
|
viewBottomLeftRearIso |
16
|
Walls
- Notes
- Pass NIL to access default cavity values.
- To access different cavities within a wall, add the zero-based cavity index to the selector value. For example, to access the right offset of cavity 6, specify 346 (340 + 6).
Wall and Slab Styles
- Notes
- Wall Styles and read-only for Slab Styles
- Wall Styles only
- Slab Styles only
Plug-in Objects
2D - 3D Status
Worksheets
Textures
- Notes
- Sets whether multiple textures can be applied to object (two for roof, three for walls).
- Valid for sphere texture space only.
- Valid for extrudes and sweeps only.
- Index of multi-texturable object component.
Gradient, Image, Tile and Hatch Fills
Hatches
Misc.
Menu Commands
Menu Command |
Selector
|
Add Surface |
Add Surface
|
Align Objects |
Align Objects
|
Align to Grid |
Align to Grid
|
Vectorworks Preferences... |
Application Preferences
|
Arc Smoothing |
Arc Smoothing
|
Arrow Heads... |
Arrow Heads
|
Bezier Spline Smoothing |
Bezier Spline Smoothing
|
Classes... |
Classes
|
Clear |
Clear
|
Clip Surface |
Clip Surface
|
Close |
Close
|
Color Palette... |
Color Palette
|
Column... |
Column
|
Combine Into Surface |
Combine Into Surface
|
Compose |
Compose Curve
|
Convert Copy to Lines |
Convert Copy to Lines
|
Convert Copy to Polygons |
Convert Copy to Polygons
|
Convert to 3D Polys |
Convert to 3D Polys
|
Convert to Lines |
Convert to Lines
|
Convert to Mesh |
Convert to Mesh
|
Convert to NURBS |
Convert To NURBS
|
Convert to Polygons |
Convert to Polygons
|
Copy |
Copy
|
Create Layer Link... |
Create Layer Link
|
Create Plug-in... |
VectorScript Plug-in Editor
|
Create Report... |
Create Report
|
Create Symbol... |
Create Symbol
|
Cubic Spline Smoothing |
Cubic Spline Smoothing
|
Custom RenderWorks Options... |
Custom RW Options Chunk
|
Custom Selection... |
Custom Selection
|
Custom Tool/Attribute... |
Custom Tool/Attribute
|
Custom Visibility... |
Custom Visibility
|
Cut |
Cut
|
Cut 2D Section |
Cut 2D Section
|
Cut 3D Section |
Cut 3D Section
|
Dash Styles... |
Dash Styles
|
Decompose |
Decompose Curve
|
Deselect All |
Deselect All
|
Document Preferences |
Document Preferences
|
Duplicate |
Duplicate
|
Duplicate Array... |
Duplicate Array
|
Edit Constraints... |
Edit Constraints
|
Export Database... |
Export Database
|
Export DXF/DWG... |
Export DXFDWG
|
Export EPSF... |
Export EPSF
|
Export Image File... |
Export Image File
|
Export PICT... |
Export PICT
|
Export Simple VectorScript (3D Only)... |
Export Simple VectorScript (3D only)
|
Export VectorScript... |
Export Text Format
|
Export VRML... |
Export VRML Chunk
|
Export Worksheet... |
Export Worksheet
|
Extrude |
Extrude
|
Extrude... |
Extrude and Edit
|
Fit To Page Area |
Fit to Window
|
Flip Horizontal |
Flip Horizontal
|
Flip Vertical |
Flip Vertical
|
Floor... |
Floor
|
Format Text... |
Format Text
|
Hatch... |
Hatch
|
Import DXF/DWG... |
Import DXFDWG
|
Import EPSF... |
Import EPSF
|
Import Image File... |
Import Image File
|
Import PICT... |
Import PICT
|
Import PICT as Picture... |
Import PICT as Picture
|
Import 3DS (3D Only)... |
3DS Import
|
Import VectorScript... |
Import Text Format
|
Import Worksheet... |
Import Worksheet
|
Intersect Surface |
Intersect Surface
|
Layer Scale... |
Layer Scale
|
Layers... |
Layers
|
Line Thickness... |
Line Thickness
|
Link Text To Record |
Link Text to Record
|
Lock |
Lock
|
lower case |
lower case
|
Move... |
Move
|
Move 3D... |
Move 3D
|
Move Working Plane |
Move Working Plane
|
Multiple Extrude |
Multiple Extrude
|
Multiple Extrude... |
Multiple Extrude and Edit
|
New... |
New
|
Next View |
Next View
|
No Smoothing |
No Smoothing
|
Normal Scale |
Normal Scale
|
Open... |
Open
|
Printer Setup... |
Page Setup
|
Paste |
Paste
|
Paste As Picture |
Paste As Picture
|
Paste In Place |
Paste In Place
|
Patterns... |
Patterns
|
Previous Selection |
Previous Selection
|
Previous Views |
Previous View
|
Print... |
Print
|
Engineering Properties... |
Properties
|
Quit |
Quit
|
Redo |
Redo
|
Revert To Saved |
Revert To Saved
|
Roof Face... |
Roof Face
|
Rotate... |
Rotate
|
Rotate 3D... |
Rotate 3D
|
Rotate 3D VIew... |
Rotate 3D View
|
Rotate Left 90° |
Rotate Left 90
|
Rotate Right 90° |
Rotate Right 90
|
Rotate Working Plane... |
Rotate Working Plane
|
Save |
Save
|
Save As... |
Save As
|
Save As Template... |
Save As Template
|
Save View |
Save View
|
Scale Objects... |
Scale Objects
|
Select All |
Select All
|
Send Backward |
Send Backward
|
Send Forward |
Send Forward
|
Send to Back |
Send to Back
|
Send to Front |
Send to Front
|
Set 3D View... |
Set 3D View
|
Set Grid... |
Set Grid
|
Set Layer Lighting Option |
Set Layer Lighting Options
|
Set Origin... |
Set Origin
|
Page Setup... |
Set Print Area
|
Set Size... |
Set Size
|
Shallow Symbol to Group |
Shallow Symbol to Group
|
Sweep |
Sweep
|
Sweep... |
Sweep and Edit
|
Symbol to Group |
Symbol to Group
|
Title Caps |
Title Caps
|
Trace Bitmap |
Trace Bitmap
|
Undo |
Undo
|
Units... |
Units
|
Unlock |
Unlock
|
Unrotate 3D Objects |
Unrotate 3D Objects
|
UPPER CASE |
UPPER CASE
|
Wall Framer... |
Wall Framer...
|
Workgroup References... |
Workgroup References
|
Menu Chunk Commands
Menu Command |
Selector
|
Create Batch Render Job... |
Batch Render Chunk
|
Start Batch Render... |
|
Active Only |
Class Options
|
Gray Others |
|
Gray/Snap Others |
|
Show Others |
|
Show/Snap Others |
|
Show/Snap/Modify Others |
|
Convert to Group |
Convert to Group Chunk
|
Export As MiniCAD 6 File... |
Export Previous File Version
|
Export As MiniCAD 7 File... |
|
Export As Vectorworks 8 File... |
|
4 |
Font Siz
|
6 |
|
7 |
|
8 |
|
9 |
|
10 |
|
12 |
|
14 |
|
18 |
|
20 |
|
24 |
|
28 |
|
36 |
|
48 |
|
72 |
|
96 |
|
144 |
|
Plain |
Font Style
|
Bold |
|
Italic |
|
Underline |
|
Outline |
|
Shadow |
|
Group |
Group Chunk
|
Ungroup |
|
Edit Group |
Group Navigation Chunk
|
Exit Group |
|
Top Level |
|
Make Guides |
Guides
|
Select Guides |
|
Show Guides |
|
Hide Guides |
|
Delete All Guides |
|
Join |
Join Chunk
|
Active Only |
Layer Options
|
Gray Others |
|
Gray/Snap Others |
|
Show Others |
|
Show/Snap Others |
|
Show/Snap/Modify Others |
|
Hidden Line |
Line Render Chunk
|
Dashed Hidden Line |
|
Line Render Options... |
|
Sketch |
Sketch Chunk
|
Sketch Options... |
|
OpenGL Options... |
OpenGL Options Chunk
|
OpenGL |
OpenGL Render Chunk
|
Set Perspective... |
Perspective Chunk
|
Narrow Perspective |
|
Normal Perspective |
|
Wide Perspective |
|
Unshaded Polygon |
Polygon Render Chunk
|
Shaded Polygon |
|
Shaded Polygon No Lines |
|
Final Shaded Polygon |
|
2D Plan |
Projection
|
Orthogonal |
|
Perspective |
|
Oblique Cavalier 45 |
|
Oblique Cavalier 30 |
|
Oblique Cabinet 45 |
|
Oblique Cabinet 30 |
|
Fast RenderWorks |
RenderWorks Render Chunk
|
Fast RenderWorks with Shadows |
|
Final Quality RenderWorks |
|
Custom RenderWorks |
|
Custom RenderWorks Options... |
|
Artistic RenderWorks |
|
Artistic RenderWorks Options... |
|
Add Solids |
Solid Operations
|
Subtract Solids... |
|
Intersect Solids |
|
Constraints |
Standard Palettes Chunk
|
Attributes |
|
Object Info |
|
Working Planes |
|
Resources |
|
Object Browser |
|
Top/Plan |
Standard Views
|
Top |
|
Front |
|
Right |
|
Bottom |
|
Back |
|
Left |
|
Right Isometric |
|
Left Isometric |
|
Right Rear Iso |
|
Left Rear Iso |
|
Lower Right Iso |
|
Lower Left Iso |
|
Lower Right Rear |
|
Lower Left Rear |
|
Left |
Text Horizontal Alignment
|
Center |
|
Right |
|
Single Space |
Text Spacing
|
1-1/2 Space |
|
Double Space |
|
Other... |
|
Top |
Text Vertical Alignment
|
Top Baseline |
|
Center |
|
Bottom Baseline |
|
Bottom |
|
Use Full Screen |
Use Full Screen Chunk
|
Wireframe |
Wireframe Render Chunk
|
Appendix I - Markers
Marker Styles and Constants
A marker style constant can be created by combining some of the basic elements listed below (Root Type, Base, Fill, Half Tick and Tail).
Root Type |
Constant
|
Arrow Marker |
|
ConcavedCurvedArrowMarker |
1
|
CircleMarker |
|
DimSlashMarker |
|
DimCrossMarker |
|
LassoMarker |
|
HexagonMarker |
|
VShapedMarker |
|
ConeShapedMarker |
|
TaperedVShapedMarker |
|
SShapedMarker |
1
|
RectangleMarker |
1
|
Base (Only meaningful for ArrowMarker and ConcaveCurvedArrowMarke) |
Constant
|
FlatBaseMarker |
|
OpenBaseMarker |
102
|
AngleBaseMarker |
204
|
ArcBaseMarker |
307
|
Fill |
Constant
|
LineColorMarker |
|
WhiteFillMarker |
12
|
NoFillMarker |
25
|
Note
- NoFillMarker is the only valid setting for LassoMarker, DimSlashMarker, and DimCrossMarker
Tail (Meaningless for CircleMarker, DimCrossMarker, LassoMarker, HexagonMarker, ConeMarker, and RectangleMarker) |
Constant
|
TailMarker |
32768
|
Half Tick (Meaningless for LassoMarker and ConeMarker) |
Constant
|
LeftHalfTickMarker |
16384
|
RightHalfTickMarker |
24576
|
Useful Composite Constants (Use these instead of Simpe Constants) |
Constant
|
OpenBaseNoFillMarker |
128
|
NoFillLassoMarker |
26
|
NoFillDimSlashMarker |
25
|
NoFillDimSlashMarker |
25
|
NoFillConeMarker |
264
|
WhiteFillConeMarker |
136
|
Examples |
Constan
|
|
style = 2176 <=> 0 + 2048 + 128 (ArrowMarker + AngleBaseMarker + WhiteFillMarker)
|
|
style = 16390 <=> 6 + 0 + 16384 (HexagonMarker + LineColorFillMarker + LeftHalfTickMarker
|
Marker Thicknes Basis and Unit
The marker thickness basis constant specifies the type and unit of the marker thickness to be set.
A marker thickness basis constant is created by adding the thickness unit to the thickness basis. Note that the thickness value and unit are only meaningful for custom thickness.
Marker Thickness Basis |
Constant
|
Use Line Thickness |
0
|
Use Dim Thickness |
1
|
Custom Thickness |
2
|
Marker Thickness Unit |
Constant
|
Mils |
0
|
Points |
16
|
Millimeters |
32
|
- Examples
thicknessBasis = 34 <=> 2 + 32 (Custom thickness in Millimeters)
thicknessBasis = 18 <=> 2 + 16 (Custom thickness in Points)
Examples of
- Marker Styles
Marker Style |
Example
|
0 |
|
256 |
|
1280 |
|
2 |
|
130 |
|
259 |
|
260 |
|
2048 |
|
17664 |
|
261 |
|
3073 |
|
1281 |
|
264 |
|
34048 |
|
16512 |
|
16384 |
|
9 |
|
135 |
|
32903 |
|
266 |
|
6 |
|
128 |
|