Go to: Synopsis. Return value. Flags. Python examples.
toolCollection(
[string]
, [collectionItemArray=boolean], [defineTemplate=string], [exists=boolean], [gl=boolean], [numberOfCollectionItems=boolean], [parent=string], [select=string], [useTemplate=string])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
toolCollection is undoable, queryable, and editable.
This command creates a tool button collection. Collections are parented
to the current default layout if no parent is specified with
the -p/parent flag. As children of the layout they will be deleted when
the layout is deleted. Collections may also span more than one window
if the -gl/global flag is used. In this case the collection has no parent
and must be explicitly deleted with the 'deleteUI' command when it is no
longer wanted.
| string | The name of the toolCollection created. |
In query mode, return type is based on queried flag.
collectionItemArray, defineTemplate, exists, gl, numberOfCollectionItems, parent, select, useTemplate
| Long name (short name) |
Argument types |
Properties |
exists(ex)
|
boolean
|
|
|
Returns true|false depending upon whether the
specified object exists. Other flags are ignored.
|
|
defineTemplate(dt)
|
string
|
|
|
Puts a command in a mode where any other flags and args are
parsed and added to the command template specified in the argument.
They will be used as default arguments in any subsequent
invocations of the command when templateName is set as the
current template.
|
|
useTemplate(ut)
|
string
|
|
|
Force the command to use a command template other than
the current one.
|
|
gl(gl)
|
boolean
|
|
|
Set the collection to have no parent layout. This flag must be
specified when the collection is created and can not be queried
or edited. Consequently, global collections must be explicitly
deleted.
|
|
parent(p)
|
string
|
|
|
Specify the parent to associate the collection with. The collection
will be deleted along with the parent. This flag must be specified
when the collection is created and can not be edited.
|
|
select(sl)
|
string
|
|
|
Select the specified collection item. If queried will return
the name of the currently selected collection item.
|
|
numberOfCollectionItems(nci)
|
boolean
|
|
|
Returns the number of items that are in this collection.
|
|
collectionItemArray(cia)
|
boolean
|
|
|
Returns a string list giving the long names of all the items
in this collection.
|
|
|
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.
|
import maya.cmds as cmds
cmds.window()
cmds.columnLayout()
cmds.toolCollection()
cmds.toolButton( tool='selectSuperContext', toolImage1=('selectSuperContext', 'aselect.xpm') )
cmds.toolButton( tool='moveSuperContext', toolImage1=('moveSuperContext', 'move_M.png') )
cmds.toolButton( tool='scaleSuperContext', toolImage1=('scaleSuperContext', 'scale_M.png') )
cmds.showWindow()