scriptCtx is undoable, queryable, and editable.
This command allows a user to create their own tools based on
the selection tool. A number of selection lists can be collected,
the behaviour of the selection and the selection masks are fully
customizable, etc.
In query mode, return type is based on queried flag.
| Long name (short name) |
Argument types |
Properties |
|
allComponents(alc)
|
boolean
|
  
|
|
Set all component selection masks on/off
|
|
allObjects(alo)
|
boolean
|
|
|
Set all object selection masks on/off
|
|
animBreakdown(abd)
|
boolean
|
|
|
Set animation breakdown selection mask on/off.
|
|
animCurve(ac)
|
boolean
|
|
|
Set animation curve selection mask on/off.
|
|
animInTangent(ait)
|
boolean
|
|
|
Set animation in-tangent selection mask on/off.
|
|
animKeyframe(ak)
|
boolean
|
|
|
Set animation keyframe selection mask on/off.
|
|
animOutTangent(aot)
|
boolean
|
|
|
Set animation out-tangent selection mask on/off.
|
|
baseClassName(bcn)
|
string
|
|
|
This string will be used to produce MEL function names for
the property sheets for the tool. For example, if
"myScriptTool" was given, the functions "myScriptToolValues"
and "myScriptToolProperties" will be used for the
property sheets. The default is "scriptTool".
|
|
camera(ca)
|
boolean
|
|
|
Set camera selection mask on/off. (object flag)
|
|
cluster(cl)
|
boolean
|
|
|
Set cluster selection mask on/off. (object flag)
|
|
collisionModel(clm)
|
boolean
|
|
|
Set collision model selection mask on/off. (object flag)
|
|
controlVertex(cv)
|
boolean
|
|
|
Set control vertex selection mask on/off. (component flag)
|
|
cumulativeLists(cls)
|
boolean
|
|
|
If set, the selection lists will be cumulative. For example,
the second list will contain all the items from the first list,
the third all the items from the second list etc. Make sure
your script specified above takes that into account. Relevant
if there is more than one selection set.
|
|
curve(c)
|
boolean
|
|
|
Set curve selection mask on/off. (object flag)
|
|
curveKnot(ck)
|
boolean
|
|
|
Set curve knot selection mask on/off. (component flag)
|
|
curveOnSurface(cos)
|
boolean
|
|
|
Set curve-on-surface selection mask on/off. (object flag)
|
|
curveParameterPoint(cpp)
|
boolean
|
|
|
Set curve parameter point selection mask on/off. (component flag)
|
|
dimension(dim)
|
boolean
|
|
|
Set dimension shape selection mask on/off. (object flag)
|
|
dynamicConstraint(dc)
|
boolean
|
|
|
Set dynamicConstraint selection mask on/off. (object flag)
|
|
edge(eg)
|
boolean
|
|
|
Set mesh edge selection mask on/off. (component flag)
|
|
editPoint(ep)
|
boolean
|
|
|
Set edit-point selection mask on/off. (component flag)
|
|
emitter(em)
|
boolean
|
|
|
Set emitter selection mask on/off. (object flag)
|
|
enableRootSelection(ers)
|
boolean
|
|
|
If set, the items to be selected are at their root transform
level. Default is false.
|
|
escToQuit(esc)
|
boolean
|
|
|
If set to true, exit the tool when press "Esc". Default is false.
|
|
exists(ex)
|
boolean
|
|
|
Returns true or false depending upon whether the
specified object exists. Other flags are ignored.
|
|
exitUponCompletion(euc)
|
boolean
|
|
|
If set, completing the last selection set will exit the
tool. Default is true.
|
|
expandSelectionList(esl)
|
boolean
|
|
|
If set, the selection lists will expand to have a single
component in each item. You probably want this as a default, otherwise
two isoparms on the same surface will show up as 1 item.
To ensure that components on the same object are returned in the order in
which they are selected, use the selectPref -trackSelectionOrder on
command in your -toolStart script to enable ordered
selection, then restore it to its original value in your
-toolFinish script.
|
|
facet(fc)
|
boolean
|
|
|
Set mesh face selection mask on/off. (component flag)
|
|
field(fi)
|
boolean
|
|
|
Set field selection mask on/off. (object flag)
|
|
finalCommandScript(fcs)
|
script
|
|
|
Supply the script that will be run when the user presses the
enter key and the context is completed. Depending on the
number of selection sets you have, the script can make use
of variables string $Selection1[], $Selection2[], ...
|
|
fluid(fl)
|
boolean
|
|
|
Set fluid selection mask on/off. (object flag)
|
|
follicle(fo)
|
boolean
|
|
|
Set follicle selection mask on/off. (object flag)
|
|
forceAddSelect(fas)
|
boolean
|
|
|
If set to true, together with -setAutoToggleSelection (see
below) on the first selection set, causes the first selection after
the computation of the previous result to be "shift" selection,
unless a modifier key is pressed. Default is false.
Flags for each selection set. These flags are multi-use.
|
|
hairSystem(hs)
|
boolean
|
|
|
Set hairSystem selection mask on/off. (object flag)
|
|
handle(ha)
|
boolean
|
|
|
Set object handle selection mask on/off. (object flag)
|
|
history(ch)
|
boolean
|
|
|
If this is a tool command, turn the construction history on
for the tool in question.
|
|
hull(hl)
|
boolean
|
|
|
Set hull selection mask on/off. (component flag)
|
|
ignoreInvalidItems(iii)
|
boolean
|
|
|
If you have multiple selection sets, the state of the
selection set is recorded at the time you "complete it". You could
then delete some of the items in that list and end up with
invalid items in one or more of your selection sets. If this
flag is set, those items will be detected and ignored. You will
never know it happened. Its as if they were never selected in
the first place, except that your selection set now does not
have as many items as it may need. If this flag is not set,
you will get a warning and your final command callback script
will likely not execute because of an error condition.
|
|
ikEndEffector(iee)
|
boolean
|
|
|
Set ik end effector selection mask on/off. (object flag)
|
|
ikHandle(ikh)
|
boolean
|
|
|
Set ik handle selection mask on/off. (object flag)
|
|
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.
|
|
imagePlane(ip)
|
boolean
|
|
|
Set image plane selection mask on/off. (component flag)
|
|
implicitGeometry(ig)
|
boolean
|
|
|
Set implicit geometry selection mask on/off. (object flag)
|
|
isoparm(iso)
|
boolean
|
|
|
Set surface iso-parm selection mask on/off. (component flag)
|
|
joint(j)
|
boolean
|
|
|
Set ik handle selection mask on/off. (object flag)
|
|
jointPivot(jp)
|
boolean
|
|
|
Set joint pivot selection mask on/off. (component flag)
|
|
lastAutoComplete(lac)
|
boolean
|
|
|
True if auto complete is set for the last selection set,
false otherwise. Mostly used for query, but if present in conjuction
with -sac/setAutoComplete flag, -sac flag takes precedence.
|
|
lattice(la)
|
boolean
|
|
|
Set lattice selection mask on/off. (object flag)
|
|
latticePoint(lp)
|
boolean
|
|
|
Set lattice point selection mask on/off. (component flag)
|
|
light(lt)
|
boolean
|
|
|
Set light selection mask on/off. (object flag)
|
|
localRotationAxis(ra)
|
boolean
|
|
|
Set local rotation axis selection mask on/off. (component flag)
|
|
locator(lc)
|
boolean
|
|
|
Set locator (all types) selection mask on/off. (object flag)
|
|
locatorUV(luv)
|
boolean
|
|
|
Set uv locator selection mask on/off. (object flag)
|
|
locatorXYZ(xyz)
|
boolean
|
|
|
Set xyz locator selection mask on/off. (object flag)
|
|
nCloth(ncl)
|
boolean
|
|
|
Set nCloth selection mask on/off. (object flag)
|
|
nParticle(npr)
|
boolean
|
|
|
Set nParticle point selection mask on/off. (component flag)
|
|
nParticleShape(nps)
|
boolean
|
|
|
Set nParticle shape selection mask on/off. (object flag)
|
|
nRigid(nr)
|
boolean
|
|
|
Set nRigid selection mask on/off. (object flag)
|
|
name(n)
|
string
|
|
|
If this is a tool command, name the tool appropriately.
|
|
nonlinear(nl)
|
boolean
|
|
|
Set nonlinear selection mask on/off. (object flag)
|
|
nurbsCurve(nc)
|
boolean
|
|
|
Set nurbs-curve selection mask on/off. (object flag)
|
|
nurbsSurface(ns)
|
boolean
|
|
|
Set nurbs-surface selection mask on/off. (object flag)
|
|
objectComponent(ocm)
|
boolean
|
|
|
Component flags apply to object mode.
|
|
orientationLocator(ol)
|
boolean
|
|
|
Set orientation locator selection mask on/off. (object flag)
|
|
particle(pr)
|
boolean
|
|
|
Set particle point selection mask on/off. (component flag)
|
|
particleShape(ps)
|
boolean
|
|
|
Set particle shape selection mask on/off. (object flag)
|
|
plane(pl)
|
boolean
|
|
|
Set sketch plane selection mask on/off. (object flag)
|
|
polymesh(p)
|
boolean
|
|
|
Set poly-mesh selection mask on/off. (object flag)
|
|
polymeshEdge(pe)
|
boolean
|
|
|
Set poly-mesh edge selection mask on/off. (component flag)
|
|
polymeshFace(pf)
|
boolean
|
|
|
Set poly-mesh face selection mask on/off. (component flag)
|
|
polymeshFreeEdge(pfe)
|
boolean
|
|
|
Set poly-mesh free-edge selection mask on/off. (component flag)
|
|
polymeshUV(puv)
|
boolean
|
|
|
Set poly-mesh UV point selection mask on/off. (component flag)
|
|
polymeshVertex(pv)
|
boolean
|
|
|
Set poly-mesh vertex selection mask on/off. (component flag)
|
|
polymeshVtxFace(pvf)
|
boolean
|
|
|
Set poly-mesh vertexFace selection mask on/off. (component flag)
|
|
rigidBody(rb)
|
boolean
|
|
|
Set rigid body selection mask on/off. (object flag)
|
|
rigidConstraint(rc)
|
boolean
|
|
|
Set rigid constraint selection mask on/off. (object flag)
|
|
rotatePivot(rp)
|
boolean
|
|
|
Set rotate pivot selection mask on/off. (component flag)
|
|
scalePivot(sp)
|
boolean
|
|
|
Set scale pivot selection mask on/off. (component flag)
|
|
sculpt(sc)
|
boolean
|
|
|
Set sculpt selection mask on/off. (object flag)
|
|
selectHandle(sh)
|
boolean
|
|
|
Set select handle selection mask on/off. (component flag)
|
|
setAllowExcessCount(sae)
|
boolean
|
|
|
If set, the number if items is to be interpreted as the minimum.
|
|
setAutoComplete(sac)
|
boolean
|
|
|
If set to true, as soon as the specified number of items is
selected the tool will start the next selection set or run the command.
|
|
setAutoToggleSelection(sat)
|
boolean
|
|
|
If set to true, it is as if "shift" key is pressed when there
are no modifiers pressed. That means that you get the "toggle select"
behaviour by default. This only applies to the 3D view, and the
selection done in the hypergraph, outliner or elsewhere is still
a subject to the usual rules.
|
|
setDoneSelectionPrompt(dsp)
|
string
|
|
|
If setAutoComplete is not set (see below) this string will be
shown as soon as the tool has enough items for a particular selection
set. If this is not set, but is needed, the same string as set with
-setSelectionPrompt flag will be used.
|
|
setNoSelectionHeadsUp(snh)
|
string
|
|
|
Supply a string that will be shown as a heads up prompt when
there is nothing selected. This must be set separately for each
selection set.
|
|
setNoSelectionPrompt(snp)
|
string
|
|
|
Supply a string that will be shown as help when there is
nothing selected. This must be set separately for each
selection set.
|
|
setSelectionCount(ssc)
|
int
|
|
|
The number of items in this selection set. 0 means as many as
you need until completion.
|
|
setSelectionHeadsUp(ssh)
|
string
|
|
|
Supply a string that will be shown as a heads up prompt when
there is something selected. This must be set separately for each
selection set.
|
|
setSelectionPrompt(ssp)
|
string
|
|
|
Supply a string that will be shown as help when there is
something selected. This must be set separately for each
selection set.
|
|
showManipulators(sm)
|
boolean
|
|
|
If set, the manipulators will be shown for any active objects.
Basically, it is as if you are in the Show Manipulator tool.
|
|
spring(spr)
|
boolean
|
|
|
Set spring shape selection mask on/off. (object flag)
|
|
springComponent(spc)
|
boolean
|
|
|
Set individual spring selection mask on/off. (component flag)
|
|
stroke(str)
|
boolean
|
|
|
Set the Paint Effects stroke selection mask on/off. (object flag)
|
|
subdiv(sd)
|
boolean
|
|
|
Set subdivision surfaces selection mask on/off. (object flag)
|
|
subdivMeshEdge(sme)
|
boolean
|
|
|
Set subdivision surfaces mesh edge selection mask on/off. (component flag)
|
|
subdivMeshFace(smf)
|
boolean
|
|
|
Set subdivision surfaces mesh face selection mask on/off. (component flag)
|
|
subdivMeshPoint(smp)
|
boolean
|
|
|
Set subdivision surfaces mesh point selection mask on/off. (component flag)
|
|
subdivMeshUV(smu)
|
boolean
|
|
|
Set subdivision surfaces mesh UV map selection mask on/off. (component flag)
|
|
surfaceEdge(se)
|
boolean
|
|
|
Set surface edge selection mask on/off. (component flag)
|
|
surfaceFace(sf)
|
boolean
|
|
|
Set surface face selection mask on/off. (component flag)
|
|
surfaceKnot(sk)
|
boolean
|
|
|
Set surface knot selection mask on/off. (component flag)
|
|
surfaceParameterPoint(spp)
|
boolean
|
|
|
Set surface parameter point selection mask on/off. (component flag)
|
|
surfaceRange(sr)
|
boolean
|
|
|
Set surface range selection mask on/off. (component flag)
|
|
surfaceUV(suv)
|
boolean
|
|
|
Set surface uv selection mask on/off. (component flag)
|
|
texture(tx)
|
boolean
|
|
|
Set texture selection mask on/off. (object flag)
|
|
title(t)
|
string
|
|
|
Supply a string that will be used as a precursor to all the
messages; i.e., the "name" of the tool.
|
|
toolCursorType(tct)
|
string
|
|
|
Supply the string identifier to set the tool cursor type
when inside of tool. The following are the valid ids:
"create", "dolly", "edit", "pencil", "track", "trackHorizontal",
"trackVertical", "transformation", "tumble", "zoom", "zoomIn",
"zoomOut", "flyThrough", "dot", "fleur",
"leftArrow", "question", "doubleHorizArrow", "doubleVertArrow",
"sizing", "dollyIn", "dollyOut", "brush", "camera", "noAccess",
"input", "output", "leftCycle", "rightCycle", "rightExpand",
"knife".
|
|
toolFinish(tf)
|
script
|
|
|
Supply the script that will be run when the user exits
the script.
|
|
toolStart(ts)
|
script
|
|
|
Supply the script that will be run when the user first
enters the script
|
|
totalSelectionSets(tss)
|
int
|
|
|
Total number of selection sets.
|
|
vertex(v)
|
boolean
|
|
|
Set mesh vertex selection mask on/off. (component flag)
|
|