snapTogetherCtx

Go to: Synopsis. Flags. Return value.

Synopsis

snapTogetherCtx( [contextName] , [clearSelection=boolean], [exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [name=string], [setOrientation=boolean], [snapPolygonFace=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

snapTogetherCtx is undoable, queryable, and editable.

Flags

Long name (short name)	[argument types]	Properties
exists(ex)	boolean
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
image1(i1)	string
In query mode, this flag needs a value.
image2(i2)	string
In query mode, this flag needs a value.
image3(i3)	string
Contexts support up to three icons that represent the tool associated with the context. In query mode, this flag needs a value.
history(ch)	boolean
If this is a tool command, turn the construction history on for the tool in question.
name(n)	string
If this is a tool command, name the tool appropriately.
setOrientation(so)	boolean
Sets whether the tool should orient as well as moving an item. Default true. In query mode, this flag needs a value.
clearSelection(cs)	boolean
Sets whether the tool should clear the selection on entry to the tool. Default true. In query mode, this flag needs a value.
snapPolygonFace(spf)	boolean
Sets whether the tool should snap the cursor to polygon face centers. Default false. In query mode, this flag needs a value.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Return value