Go to: Synopsis. Return value. Flags. MEL examples.
snapTogetherCtx [-clearSelection boolean] [-exists] [-history boolean] [-image1 string] [-image2 string] [-image3 string] [-name string] [-setOrientation boolean] [-snapPolygonFace boolean]
[contextName]
snapTogetherCtx is undoable, queryable, and editable.
The snapTogetherCtx command creates a tool for snapping surfaces
together.
string | (name of the new context) |
In query mode, return type is based on queried flag.
clearSelection, exists, history, image1, image2, image3, name, setOrientation, snapPolygonFace
Long name (short name) |
Argument types |
Properties |
|
-clearSelection(-cs)
|
boolean
|
|
|
Sets whether the tool should clear the selection
on entry to the tool. Default true.
|
|
-exists(-ex)
|
|
|
|
Returns true or false depending upon whether the
specified object exists. Other flags are ignored.
|
|
-history(-ch)
|
boolean
|
|
|
If this is a tool command, turn the construction history on
for the tool in question.
|
|
-image1(-i1)
|
string
|
|
|
First of three possible icons representing the tool
associated with the context.
|
|
-image2(-i2)
|
string
|
|
|
Second of three possible icons representing the tool
associated with the context.
|
|
-image3(-i3)
|
string
|
|
|
Third of three possible icons representing the tool
associated with the context.
|
|
-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.
|
|
-snapPolygonFace(-spf)
|
boolean
|
|
|
Sets whether the tool should snap the cursor to
polygon face centers. Default false.
|
|
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 be used more than once in a command.
|
// Create two nurbs spheres, then move them apart
sphere -r 3 -n nurbsSphere1;
move 5 0 0;
sphere -r 3 -n nurbsSphere2;
move -5 0 0;
// Create a new snap together tool context, set it to move objects only, then switch to it
// You can use this tool to snap two spheres together
snapTogetherCtx -so 0 snapTogetherCtx1;
setToolTo snapTogetherCtx1;